remark
remark — A remark (or comment) intended for presentation in a draft manuscript.
Synopsis
- Zero or more of:
- text
- Bibliography inlines
- Error inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Math inlines
- Object-oriented programming inlines
- Operating system inlines
- Product inlines
- Programming inlines
- Publishing inlines
abbrev
acronym
coref
date
emphasis
(db.emphasis)firstterm
(db._firstterm)firstterm
(db.firstterm)footnote
footnoteref
foreignphrase
(db.foreignphrase)glossterm
(db._glossterm)glossterm
(db.glossterm)phrase
(db.phrase)quote
(db.quote)subscript
superscript
wordasword
- Technical inlines
- Ubiquitous inlines
abbrev
acronym
alt
anchor
annotation
biblioref
coref
date
emphasis
(db._emphasis)firstterm
(db._firstterm)footnote
footnoteref
foreignphrase
(db._foreignphrase)glossterm
(db._glossterm)indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
phrase
(db._phrase)quote
(db._quote)remark
subscript
superscript
trademark
wordasword
xref
Attributes
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
, accel
, acknowledgements
, acronym
, address
, annotation
, answer
, appendix
, application
, arg
, article
, artpagenums
, attribution
, authorinitials
, bibliocoverage
, bibliodiv
, bibliography
, biblioid
, bibliolist
, bibliomisc
, bibliomixed
, bibliomset
, bibliorelation
, bibliosource
, blockquote
, bridgehead
, callout
, calloutlist
, caption
(db.caption), caption
(db.html.caption), caution
, chapter
, citation
, citebiblioid
, citetitle
, city
, classname
, classsynopsisinfo
, code
, colophon
, command
, computeroutput
, confdates
, confnum
, confsponsor
, conftitle
, constant
, constraintdef
, contractnum
, contractsponsor
, contrib
, country
, cover
, database
, dedication
, description
, edition
, email
, emphasis
(db._emphasis), emphasis
(db.emphasis), entry
, envar
, errorcode
, errorname
, errortext
, errortype
, example
, exceptionname
, fax
, figure
, filename
, firstname
, firstterm
(db._firstterm), firstterm
(db.firstterm), footnote
, foreignphrase
(db._foreignphrase), funcdef
, funcparams
, funcsynopsisinfo
, function
, givenname
, glossary
, glossdef
, glossdiv
, glosslist
, glosssee
, glossseealso
, glossterm
(db._glossterm), glossterm
(db.glossterm), guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, holder
, honorific
, important
, index
, indexdiv
, informalexample
, informalfigure
, initializer
, interfacename
, issuenum
, itemizedlist
, jobtitle
, keycap
, keycode
, keysym
, label
, legalnotice
, lineage
, lineannotation
, link
, listitem
, literal
, literallayout
, manvolnum
, markup
, mathphrase
, member
, methodname
, modifier
, mousebutton
, msgaud
, msgexplan
, msglevel
, msgorig
, msgtext
, note
, olink
, option
, optional
, orderedlist
, orgdiv
, orgname
, otheraddr
, othername
, package
, pagenums
, para
, paramdef
, parameter
, partintro
, personname
, phone
, phrase
(db._phrase), phrase
(db.phrase), pob
, postcode
, preface
, primary
, primaryie
, procedure
, productname
, productnumber
, programlisting
, prompt
, property
, publishername
, qandadiv
, qandaset
, question
, quote
(db._quote), quote
(db.quote), refdescriptor
, refentrytitle
, refmiscinfo
, refname
, refpurpose
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, releaseinfo
, remark
, replaceable
, result
, returnvalue
, revdescription
, revnumber
, revremark
, screen
, secondary
, secondaryie
, sect1
, sect2
, sect3
, sect4
, sect5
, section
, see
, seealso
, seealsoie
, seeie
, seg
, segtitle
, seriesvolnums
, setindex
, shortaffil
, sidebar
, simpara
, simplesect
, state
, step
, street
, subscript
, subtitle
, superscript
, surname
, symbol
, synopsis
, systemitem
, tag
, taskprerequisites
, taskrelated
, tasksummary
, td
, term
, termdef
, tertiary
, tertiaryie
, textobject
, th
, tip
, title
, titleabbrev
, toc
, tocdiv
, tocentry
, token
, topic
, trademark
, type
, uri
, userinput
, variablelist
, varname
, volumenum
, warning
, wordasword
, year
.
Children
The following elements occur in remark: text, abbrev
, accel
, acronym
, alt
, anchor
, annotation
, application
, author
, biblioref
, citation
, citebiblioid
, citerefentry
, citetitle
, classname
, code
, command
, computeroutput
, constant
, coref
, database
, date
, editor
, email
, emphasis
(db._emphasis), emphasis
(db.emphasis), envar
, errorcode
, errorname
, errortext
, errortype
, exceptionname
, filename
, firstterm
(db._firstterm), firstterm
(db.firstterm), footnote
, footnoteref
, foreignphrase
(db._foreignphrase), foreignphrase
(db.foreignphrase), function
, glossterm
(db._glossterm), glossterm
(db.glossterm), guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), initializer
, inlineequation
, inlinemediaobject
, interfacename
, jobtitle
, keycap
, keycode
, keycombo
, keysym
, link
, literal
, markup
, menuchoice
, methodname
, modifier
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, org
, orgname
, package
, parameter
, person
, personname
, phrase
(db._phrase), phrase
(db.phrase), productname
, productnumber
, prompt
, property
, quote
(db._quote), quote
(db.quote), remark
, replaceable
, returnvalue
, shortcut
, subscript
, superscript
, symbol
, systemitem
, tag
, termdef
, token
, trademark
, type
, uri
, userinput
, varname
, 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>