Articles in this section

See more

How to Add Comments to a Document

  • Updated
Follow

Adding comments to your document is useful when collaborating with others, or to just leave notes for yourself.

Displayr's comment feature allows anyone with edit access for a given document to add comments to anything in the Report or Data Sources trees, including pages, outputs on the page such as tables, visualizations or text, boxes, data sources, or variables and variable sets. 

 

Requirements

Please note this requires the Data Stories module or a Displayr license.

Edit access to the Displayr document where you want to add comments.

 

Method

  1. To enable comments, first click on the Comments button near the top right of the page.
    Comment button.png

    This will expand the Comments pane on the right side of the page.
    Comment pane.png
  2. With the Comments enabled, add a comment to whatever you currently have selected on the page by clicking the + button. If you don't have anything selected, the comment will be added to the page itself.
  3. Type in the text of your comment and type in the triangular Submit button or hit the Enter key on your keyboard.
    Submit comment.png
  4. To add another comment, click the + button again. To add a comment to a new item, select that item, then click +
  5. To reply to a comment, click Reply below the text of the comment
  6. To edit a comment, mark it as resolved or delete it, select a comment, then click the three-dot button on the right side, then select your desired action.
    edit_delete.png

Technical Details

  • Any user with access to edit a document add or edit comments in that document. 
  • With the Comment pane collapsed, the comment icon will only appear in the Report tree.
    commenticon.png
  • When the Comment pane is open, the comment icon will appear next to any item with a comment. The icon won't appear if the Comment pane is closed.
    tableicon.png

  • Comments are only visible in Edit mode; they will not appear in View mode.

  • Any new comments added since you last visited the document will appear as new comments next to the Comment button near the top right of the page.
    new_comment.png

  • To view any newly added comments while working on the document, click the refresh button.
    Comment refresh.png

  • There is a 5000-character limit per comment.

  • Users will not receive any notifications about new comments outside of Displayr.

Next

Tips for Working Efficiently in Displayr

 

 

Related articles