WordPress.org
Get WordPress

Plugin Directory

Changeset 1856623


Ignore:
Timestamp:
04/11/2018 04:51:43 PM (8 years ago)
Author:
petermantos
Message:

Updated format, and a spelling error.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • read-and-understood/trunk/readme.txt

    r1856514 r1856623  
    11=== Read and Understood ===
    2 
    32Contributors: petermantos
    4 
    53Requires at least: 3.0
    6 
    74Stable tag: 2.4
    8 
    95Tested up to: 4.9.5
    10 
    116License: GPLv2 or later
    12 
    137License URI: http://www.gnu.org/licenses/gpl-2.0.html
    14 
    158Tags: Acknowledgment, Acknowledgement, Acknowlegement, Accountability, Mantos, Acknowledge, Acknowlege, Read, Understood, Understand, Memo
    16 
    179== Upgrade Notice ==
    1810V2.4  No functional changes or security improvements.  Changed to conform to undocumented coding-style preferences.
    … …  
    4638Read-and-Understood is a solution to the "I didn't get the memo" problem.
    4739
    48 The Read and Understood (RnU) WordPress plugin offers readers the opportunity to record
    49 an acknowledgment that they have read a specific posting.
     40The Read and Understood (RnU) WordPress plugin offers readers the opportunity to record an acknowledgment that they have read a specific posting.
    5041
    5142You can visit us at: <https://mantos.com>
    5243
    53 One common use of RnU is by employers to record that employees have read postings in a
    54 specific, private category such as 'internal' which may only be seen by authorized,
    55 logged-in users. By doing so, the employee may assume responsibility for understanding
    56 the content and following any instructions, procedures, or policies contained in it.
    57 
    58 These acknowledgments may then be accessed by administrators via a CSV file containing
    59 records created in a given date range.  The records are exported using an Export button
    60 on the plugin's setting page.  In addition to exportation, the records are accessible
    61 through any technique used to access a typical MySql database such as PHPadmin, linked
    62 tables, or custom programming.
    63 
    64 The acknowledgments may also be purged (deleted) using the PURGE button also found
    65 on the plugin's setting page.
    66 
    67 Optionally, the plugin may be configured to accept acknowledgments from users who are not
    68 logged-in.  In that case, the user may enter any username desired provided that it meets an
    69 administrator specified format as defined by a regular expression.  The default format for
    70 such usernames, if allowed, is 1-10 capital letters. 
    71 
    72 An Export file is a comma-separated value (CSV) text file which is generated from the
    73 administrative Settings Page.
    74 
    75 There is header column that contains the post_title of any acknowledgments found within the
    76 specified date range.
     44One common use of RnU is by employers to record that employees have read postings in a specific, private category such as 'internal' which may only be seen by authorized, logged-in users. By doing so, the employee may assume responsibility for understanding the content and following any instructions, procedures, or policies contained in it.
     45
     46These acknowledgments may then be accessed by administrators via a CSV file containing records created in a given date range.  The records are exported using an Export button on the plugin's setting page.  In addition to exportation, the records are accessible through any technique used to access a typical MySql database such as PHPadmin, linked ables, or custom programming.
     47
     48The acknowledgments may also be purged (deleted) using the PURGE button also found on the plugin's setting page.
     49
     50Optionally, the plugin may be configured to accept acknowledgments from users who are not logged-in.  In that case, the user may enter any username desired provided that it meets an administrator specified format as defined by a regular expression.  The default format for such usernames, if allowed, is 1-10 capital letters. 
     51
     52An Export file is a comma-separated value (CSV) text file which is generated from the administrative Settings Page.
     53
     54There is header column that contains the post_title of any acknowledgments found within the specified date range.
    7755
    7856Each row contains the RNU_USERNAME which may represent:
    … …  
    8866       3) The user_id of person who acknowledged NO postings (and t.he ALL USERS option was selected)
    8967       
    90 Each row may contain an email address which corresponds to the non-zero RNU_USER_ID, regardless
    91 of wether any acknowledgments were made.
    92 
    93 Also in each row, there may be a date/time in a cell in a column headed by a post_title.
    94 That date/time corresponds to when the user (row) acknowledged that post (column).
    95 
    96 Note that username may NOT necessarily correspond to a unique user and may be repeated. 
    97 In fact, if so configured, a person who is not logged in may enter the username of any person.
    98 For this reason, the User_id is also given in each row; which, if zero, means that the
    99 acknowledgment was made by a person not logged in who entered that username.
     68Each row may contain an email address which corresponds to the non-zero RNU_USER_ID, regardless of whether any acknowledgments were made.
     69
     70Also in each row, there may be a date/time in a cell in a column headed by a post_title. That date/time corresponds to when the user (row) acknowledged that post (column).
     71
     72Note that username may NOT necessarily correspond to a unique user and may be repeated.  In fact, if so configured, a person who is not logged in may enter the username of any person.
     73For this reason, the User_id is also given in each row; which, if zero, means that the acknowledgment was made by a person not logged in who entered that username.
    10074
    10175== Installation ==
Note: See TracChangeset for help on using the changeset viewer.