remark

remark — A remark (or comment) intended for presentation in a draft manuscript.

Synopsis

remark ::= [-]

Description

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.

Processing expectations

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.

Parents

These elements contain remark: abbrev, abstract, acknowledgements, acronym, address, answer, appendix, article, artpagenums, attribution, authorinitials, bibliocoverage, bibliodiv, bibliography, biblioid, bibliolist, bibliomisc, bibliomixed, bibliomset, bibliorelation, bibliosource, blockquote, bridgehead, callout, calloutlist, caption, caution, chapter, citation, citebiblioid, citetitle, city, colophon, confdates, confnum, confsponsor, conftitle, contractnum, contractsponsor, contrib, country, cover, danger, db:inlinestagedir, dedication, dialogue, drama, edition, email, emphasis (db._emphasis), emphasis (db.emphasis), entry, example, fax, figure, firstname, firstterm (db._firstterm), firstterm (db.firstterm), footnote, foreignphrase (db._foreignphrase), givenname, glossary, glossdef, glossdiv, glosslist, glosssee, glossseealso, glossterm (db._glossterm), glossterm (db.glossterm), holder, honorific, important, index, informalexample, informalfigure, issuenum, itemizedlist, jobtitle, label, legalnotice, line, lineage, linegroup, link, listitem, literal, literallayout, mathphrase, member, note, olink, optional, orderedlist, orgdiv, orgname, otheraddr, othername, pagenums, para, partintro, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, poetry, postcode, preface, primary, procedure, productname, productnumber, publishername, qandadiv, qandaset, question, quote (db._quote), quote (db.quote), releaseinfo, remark, result, revdescription, revnumber, revremark, secondary, section, see, seealso, seriesvolnums, setindex, shortaffil, sidebar, simpara, simplesect, state, step, street, subscript, subtitle, superscript, surname, taskprerequisites, taskrelated, tasksummary, term, termdef, tertiary, textobject, tip, title, titleabbrev, toc, trademark, uri, variablelist, volumenum, warning, wordasword, year.

Children

The following elements occur in remark: text, abbrev, acronym, alt, anchor, author, biblioref, citation, citebiblioid, citetitle, coref, date, db:inlinestagedir, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), glossterm (db._glossterm), glossterm (db.glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlineequation, inlinemediaobject, jobtitle, link, literal, olink, optional, org, orgname, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, quote (db._quote), quote (db.quote), remark, subscript, superscript, termdef, trademark, uri, wordasword, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example remark</title>

<example xml:id="gut-qed">
<title>The Grand Unified Theory</title>

<para><remark>Some details are still a bit shaky</remark>
…
Q.E.D.
</para>
</example>

</article>
Example 6. The Grand Unified Theory

Some details are still a bit shaky
… Q.E.D.

Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)