remark — A remark (or comment) intended for presentation in a draft manuscript
remark ::=
(text | phrase
db._phrase | replaceable
| Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
The remark
element is designed to hold
remarks—for example, editorial comments—that are useful while the
document is in the draft stage, but are not intended for final publication.
Remarks are available almost anywhere and have a particularly
broad content model. Your processing system may or may not support
either the use of comments everywhere they are allowed or the full
generality of the remark
content model.
Prior to version 4.0 of DocBook, this element was named comment
.
May be formatted inline or as a displayed block, depending on
context. Remarks are often printed only in draft versions of a
document and suppressed otherwise. This may be controlled by the
status
attribute of an ancestor
element (e.g., chapter
), or by external processes,
such as selecting an alternate stylesheet when publishing.