If you want to provide a trust-based collaboration framework for internal users, specify a shared network location to store comments. Users can read and add comments if they have read/write access to that network location. Comments from each user are stored in a separate XML file at the location.
For information about how to specify a shared network location, see Configurecollaboration.
If you want to allow commenting by users outside a corporate network, store comments on a RoboHelp server. The server authenticates users before allowing them to read or add comments.
note: RoboHelp Server provides user authentication through both database and LDAP.
1)(Author) In RoboHelp HTML, generate AIR Help with the following layout settings:
•Enable Topic Rating
•Enable Commenting
•Enable Comment Moderation
•In Set Location For Comments And Topic Ratings, select RoboHelp Server and specify the server URL.
For more detailed steps, see Configure collaboration.
2)(Administrator) In RoboHelp Server Web Administrator, sign in as an administrator and click Settings > Moderation. Specify the following settings:
•Select Allow Post Anonymous if you want to let users comment anonymously on Help content.
note: RoboHelp Server authenticates all users. When anonymous posting is enabled, users have the option to post a comment without their usernames being displayed.
•Select Mark New Comments As Pending if you want to display user comments only after a moderator approves them.
For more detailed steps, see Using RoboHelp Server 10.
3)(User) Launch the AIR Help application. Click Show/Hide Comments Pod and add comments. See Add comments and Moderate comments.
Users can configure the following preferences for comments in AIR Help (output):
Always Use Log-In Name For Reviewer Name
If comments are stored in a shared network folder, users can specify the name they want to display with their comments. By default, RoboHelp displays the user name as defined in the user area.
note: If comments are stored on a RoboHelp server, RoboHelp uses the login name.
Use Default Location To Sync Comments
Users can select this option to specify a new location for storing comments. The default location is the location specified at the time of generating AIR Help.
Receive Comments From Shared Folder
Users can select this option to receive all comments automatically when the Comments pod is displayed after launching AIR Help.
Show Moderation Pod
Users can select this option to enable the moderation mode if they have moderator privileges. In trust-based commenting (shared network location), moderators only need access to the password specified by the author at the time of generating AIR Help. In server-based commenting, moderators need admin privileges.
note: Users can enable the moderation mode only if the author has enabled moderation at the time of generating AIR Help.
Delete All Comments
Select to delete all comments from your local database. When you click Send And Receive after selecting this option, all your comments are deleted from the shared location or the RoboHelp server.
Users can add comments if commenting is enabled when generating the Adobe AIR output. Comments are stored locally until you click Send To Server or Send and Receive option.
1)Click Show/Hide Comments Pod to display the Comments pod.
2)To add a comment, click Show/Hide Add Comment. Enter the comment and click Save.
3)Click Send And Receive to publish saved comments.
Regardless of whether you store comments in a shared network location or on a RoboHelp server, RoboHelp supports comment moderation. If moderation is enabled, the status of an unmoderated comment is Pending or Accepted as set in the SSL. A rejected comment can be seen only by the user who added the comment.
|
|
Shared location |
RoboHelp server |
|---|---|---|
|
Enabling moderation |
Disabled by default |
Enabled by default Admins can modify the settings using the Admin UI on RoboHelp Server |
|
Authentication |
Not required to read or add comments Required to moderate comments Moderator password is provided by authors and can’t be changed |
Required to read or add comments if anonymous commenting is not allowed Admin privileges required to moderate comments |
|
Status of new comments |
Moderators can modify the settings.xml file in the location where comments are centrally located. If the moderation state attribute is set to ‘on’, new comments remain in the Pending state until they are moderated. If it is set to ‘off’, all new comments are marked Accepted by default and are not queued for moderation. A moderator can still reject or delete the comments later. |
The Mark New Comments As Pending option set on the server determines the status of new comments. |
In the AIR Help output, do the following:
1)Click Preferences.
2)Click Comment.
3)Specify the password.
4)Select Show Moderation Pod. Click OK.
5)Use the following options to filter comments:
View All list
Select Pending, Rejected, or Accepted to filter comments by status.
Comments By list
Select an author name to filter comments by an author.
Comments For Current Topic
Click to view comments on the current topic only.
Comments For All Topics
Click to view comments on all topics.
6)Click Accept, Reject, or Delete to moderate a comment.
7)Click Send And Receive to synchronize the comments with the shared location or the server.