Reviewing documents

You can annotate a Metanorma AsciiDoc document with comments and `TODO`s to indicate a pending action.

Reviewer comments

To create a comment:

1. Define the start of the comment by creating an anchor [[start]].

2. Define where the comment should end by creating an anchor [[end]] (optional).

3. Add the comments metadata: [reviewer="Your Name",date=YYYYMMDDT0000,from=start,to=end]
   The date and to attributes are optional. The timestamp in the date attribute is optional, too. The from and to elements can be bookmarks which cover no space.

4. Begin the comment block using four asterisks ****.

5. Enter your comment.

6. Close the comment block with four asterisks ****.

Example of a comment

=== Address Profile Definition (AddressProfileDescription)

This is a clause address [[A]]proflie[[B]] definition

[reviewer="Nick Nicholas",date=20180125T0121,from=A,to=B]
****
proflie?!
****

which renders

Figure 1. Illustration of a reviewer comment covering a span of text.

By default, Metanorma will render annotations in output only if the document is unpublished, using SDO-specific criteria to determine document status (the document stage). This can be overridden by setting :presentation-metadata-render-document-annotations: to true or false.

TODO expressions

Metanorma treats TODO as an admonition label, and converts it into a reviewer note. The from, to reviewer and date attributes are all treated as optional.

Example of a TODO

TODO: This is treated as a reviewer note.

[TODO]
====
This is also treated as a reviewer note
====