<comment>

Description

A developer comment.

Developer comments are used to capture temporary or permanent conversations in BDML documents such as design documentation. Comments may be removed once the design is complete, or, more often, they can be left as is but not displayed via the CSS.

The state attribute can be used in conjunction with some Javascript in HTML translations and direct browser loading, in order to allow comments to be visually opened or closed. The Javascript and default CSS supplied with the Bora document processor displays only the the title of the comment when it is closed. Hovering over the comment title displays the full comment. Clicking on the comment arrow opens the comment for permanent display until the arrow is clicked again.

Attributes

In addition to the following attributes, standard attributes may be defined on <comment> elements.

Element name Description
creator The name/initials of the creator of the comment.
state The initial state of the comment (open or closed).
title The title text of the comment.

Immediate descendants

Element name Description
<question> A question entry in the comment.
<remark> A remark/response entry in the comment.

Immediate ancestors

Element name Relation
<chapter> The enclosing chapter of the comment.

Example

<document xmlns="http://boradoc.org/1.0">
  <chapter>
    <comment creator="Bob" state="open" title="The meeting">
      <question creator="Bob">What should be the approach be?</question>
      <remark creator="Mike">Set up a meeting to discuss.</remark>
    </comment>
  </chapter>
</document>

The above BDML renders to the following:

Bob The meeting

BobWhat should be the approach be?
MikeSet up a meeting to discuss.