Document comments

Document comments

DOCX The <comment> element stores a document comment. Document comments are used to round-trip comments between DOCX and CXML formats.

New in CXML 3.4

<comment> is a new element in CXML 3.4.

<comment> has five attributes:

Attribute	Value	Description
id	string	The unique ID of the comment.
initials	string	The initials of the comment author.
status	added changed deleted	Indicates the modification status of the comment.
author	string	The author of the comment.
dateTime	ISO 8601 datetime string	The date and time of the comment (2024-01-09T14:37:00Z).

<comment> must contain at least one child element. It can contain any content that can appear inside a <section>, including paragraphs, lists, and tables.

A simple document comment:

<p>
  We are the knights who say
  <comment>
    <p>Should this be "Ni" or "Nee"?</p>
  </comment>
  Ni!
</p>

A document comment with tracked changes:

<p>
  It's just a flesh wound.
  <comment id="C123" initials="JC" author="John Cleese" dateTime="1975-04-05T09:00:00Z" status="added">
    <p type="Comment Title">Continuity error</p>
    <p type="Comment Body">The Black Knight has lost both arms at this point. See <c type="Scene_Ref">Holy Grail, Act 2</c></p>
  </comment>
</p>