Adding Comments to a Display

About this task

Comments provide a place to add any text to a result. This is often extra information, clarifications, opinions, details, or reviews. Comments are searched with every query automatically, so they can help find relevant information. However, because of their free-form nature, comments are not suited for navigation using refinements and similar situations. No structure or meaning is imposed by default on comments. You can change the labels or establish conventions within your organization about how comment annotations should be used.

To add comments to the search results in your application, open the display that is associated with your project. This tutorial uses a project named collab-tutorial and a display named collab-tutorial-display.

Procedure

On the Settings tab, select Collaboration from the left-hand menu. This will automatically open the Annotations subsection. A screen like the one shown in Figure 1 displays.
Scroll down, if necessary, and click add new to the right of the Groups: Comments header. A screen like the one shown in Figure 1 displays.
Figure 1. Adding Comments to a Display
The only mandatory field is the Name of the Comments annotation that you want to add. For the purposes of this tutorial, specify comments as the name of the Comment annotation that you want to add.
Tip:
For information about the other items on this editing screen, click the tool tip icon () to the right of each entry.
When you are done, click OK to save your changes.

Results

A screen like the one shown in Figure 2 displays. Do a search in your application and check to see that the comment annotations now appear with the results. See the section on Using a Collaborative Search Application for more information about how the end-user display works.

Figure 2. A Comment Annotation Defined in a Display

Proceed to the Adding Rating or Voting to a Display.