Comments

All standard modules are designed to collect end user comments related to the individual data documents. The comments are collected by adding the comments CpScript generated by the Comments > Configuration module to the Site Architecture > Module Designer > Details View (#3) layout of the module. The comments script is outlined in the module designer help file and can only be used on a details view because each comment must be related to a specific data document. Recent comments collected using this script can be viewed at the bottom of the data document’s details page in the client console. If you have access to the Comments > All Modules module, you can view all comments related to a document and edit specific comments using links on the details page.

Comments > All Modules is a custom module used to collect comments related to data in all standard modules. The links on the details page of any standard module can be used to filter this list by a single data document. This module can be used to search and review comments on the site. An administrator can also manage the Approved and Display Status attributes from this module, effectively placing comments on the site or removing them from the site. When an administrator approves a comment, the Approve Date is automatically recorded as well as the Approver. The Origin attribute records the fully qualified URL used to post the comment, and is not guaranteed to be valid when the site structure changes.

The Comments > Configuration module is used to configure the script used to collect and display comments on the front end of the site. Every site contains a locked record which is used by default in most modules. You can either update this record to affect all module defaults, or create a new record and copy the generated CpScript to the desired Site Architecture > Module Designer > Details View (#3) record. To avoid errors, be sure to remove all CpScript references from the module designer manually before attempting to delete a record from this module. The Form tab configures the user interface used to collect comments and what happens when the form is submitted. In addition to the settings in the module the form submit button text can be managed using Aliases. Member Comments allows you to enable and disable authenticated user commenting. When enabled it also allows you to select which roles are permitted to comment. Anonymous Comments controls comments from users that are not logged in, including what information you wish to require when anonymous comments are posted. When “Enabled” is selected for the Review attribute, comments will not be added to a site until they have been approved by an administrator. This administrator must have console access to Comments > All Modules. You can configure the email that is sent to the administrator using the attributes made available when review is enabled. The Thread tab allows you to configure the layout of the existing comments on the site.

All comments are also available via an RSS feed which can be added to the site using the Design > Dynamic Feeds module. This feed is accessible in any site using the following URL: http://www.yoururlhere.com/Modules/Comments/Rss.aspx. By default, this feed returns the 10 newest comments from all modules. The title of the item is the title of the related document and the contents contain the comment itself. The link is generated using the Origin attribute and is only valid if the site structure has not changed. If you add the “top=N” query string parameter to the feed you can control the number of comments that are returned. You can also add a “did=DataId” query string parameter to filter the feed by a specific data document. When this feed is filtered by a specific data document a truncated version of the comment is used as the item title.