To annotate document with reviewer notes (essentially, arbitrary blocks of text), Metanorma uses AsciiDoc sidebar notation.
Sidebars can be separated at a distance from the text they are annotating; the text they are annotating is indicated through anchors.
Reviewer notes are only rendered
The following attributes on reviewer notes are mandatory:
reviewerattribute (naming the reviewer)
the starting target anchor of the note (
The following attributes are optional:
dateattribute, optionally including the time (as xs:date or xs:datetime)
the ending target anchor of the note (
The span of text covered by the reviewer note is from the start of the
text encompassed by the
from element, to the end of the text encompassed
to element. If only the
from element supplied, the reviewer note
from element. The
to elements can be bookmarks,
which cover no space.
[[clause_address_profile_definition]] === Address Profile Definition (AddressProfileDescription) [[para1]] This is a clause address [[A]]profile[[B]] definition [reviewer="Nick Nicholas",date=20180125T0121,from=clause_address_profile_definition,to=para1] **** I do not agree with this statement. **** [reviewer="Nick Nicholas",date=20180125T0121,from=A,to=B] **** Profile?! ****
A commonplace convention in software source code, as well as lightly marked up text,
is to prefix comments indicating pending actions with
TODO as an admonition label, and converts it into a reviewer note.
date attributes are all treated as optional.
TODO: This is treated as a Reviewer note: [TODO] ==== This is also treated as a Reviewer note ====