Articles in this section

See more

Author Remarks

Avatar
Anders
  • Updated
Follow

The remark element is a regular DocBook Element  and works like an internal comment (author notes) inside the topic. For example it can be used as a tip, an internal instruction or a reminder for other authors. It will only be visible to authors working in the Editor View and not displayed to the end users.

The remark element is not handled via the Element Attributes Panel since it has no profiling values. It is visualized in the enclosing "box" highlighted in yellow with a lock and a green speech bubble.

Remark_element_in_topic_small.png

Add Author Remarks

By default, the remark element comments are not shown in published output. But there is a way to include them in the PDF output, see The Basics of Topic Editing. However it cannot be made to appear in an HTML output.

Remark_element_in_topic_small.png

Note

A remark element has no relation to the Review or Contribution assignments and will not be a part of those.

  1. Place the cursor where the remark element is to be inserted.

  2. Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.

    Element context menu shows a search field and a list of elements that are valid at the current position.

  3. Enter Remark and select it from the Element Context Menu.

  4. Enter the internal comment.

    Enter_the_remark_small.png

  5. Select Save. Save icon.

Note

If you click on an area outside the remark element, the editor will highlight the enclosing "box" in yellow.

Remark_small.png

Remove Author Remarks

This section describes how to remove a remark.

  1. Select the Remark element in the topic.

  2. Place the cursor in the Element Structure Menu below the tool bar.

    Element_Structure_Menu_small.png

  3. Select the element and choose Delete.

    Remove_Remark_Element_small.png

  4. Select Save. Save icon.

Enable or Disable Author Remarks (PDF)

Author remarks are comments in code, where the comment is part of the topic, but not displayed to your end users. Author remarks have no relation to the feedback comments in reviews and are not part of the review "conversation".

Via the Layout Editor you can choose to include Author remarks in your PDF output.

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select General and choose Draft and Watermark in the sidebar.

  4. Scroll down to Show Comments.

  5. Select:

    • Enabled to include author remarks in PDF output.

    • Disabled to exclude author remarks in PDF output. Default

    draft-show-remarks.jpg

    Note

    You can show remarks (comments) with Draft mode set to Yes, Default, or No. The Draft mode setting has no effect on whether remarks are visible in the output.

  6. Select Save.

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk