{builder-comments} Macro

Description

This macro defines where the page/news comments, if enabled, will be shown within the theme layout.

Users can toggle the display of this macro using the link output by the menulink macro with a destination of comments.

Usage

{builder-comments}

Note:
This macro can only be used inside panels within the theme configuration screen. You cannot use it in pages or news articles, etc.

Parameters

This macro has no parameters.

Examples

Basic Use

Add the macro to any panel in theme configuration to display the comments in that panel:

{builder-comments}

CSS Customisation

To follow.

Hints and Tips

None at present.

Frequently Asked Questions

Why are my comments not shown?

If you have hidden comments, then they will not be shown on any pages. There are a few ways you can display comments again...

The best way is to use the menulink macro to display a link or menuitem that allows users to show/hide comments

Unknown macro: {footnote}

This link is included as default on the View menu for pages that have comments.

:

{menuitem:flat=true}{menulink:comments}Show comments (%count%){menulink}{menuitem}

Unknown macro: {display-footnotes}

Which displays:

Unknown macro: {menuitem}

Unknown macro: {menulink}

Show comments (%count%)

We've wrapped the link in the menuitem macro so that pages which do not have comments will not display an inactive link.

Another alternative is to allow the user to post new comments

Unknown macro: {footnote}

If the user has sufficient privileges, they'll see this link on the Edit > New menu

:

{menuitem:flat=true}{menulink:newcomment}Post a comment{menulink}{menuitem}

Which displays:

Unknown macro: {menuitem}

Unknown macro: {menulink}

Post a comment

The disadvantage of this second approach is that it doesn't let the user know if there are any existing comments until they click the link.

A third approach is to include the showComments=true setting on the page URL. For example, the URL to this page is:

http://www.adaptavist.com/display/USERGUIDE/builder-comments+macro

You would change that to:

http://www.adaptavist.com/display/USERGUIDE/builder-comments+macro?showComments=true

Anyone accessing this link would automatically get the display of comments switched on, regardless of what previous settings they had used.