$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
remark — A remark (or comment) intended for presentation in a draft manuscript
remark ::= (#PCDATA|footnoteref
|xref
|biblioref
|abbrev
|acronym
|citation
|citerefentry
|citetitle
|citebiblioid
|emphasis
|firstterm
|foreignphrase
|glossterm
|termdef
|footnote
|phrase
|orgname
|quote
|trademark
|wordasword
|personname
|link
|olink
|ulink
|action
|application
|classname
|methodname
|interfacename
|exceptionname
|ooclass
|oointerface
|ooexception
|package
|command
|computeroutput
|database
|envar
|errorcode
|errorname
|errortype
|errortext
|filename
|function
|guibutton
|guiicon
|guilabel
|guimenu
|guimenuitem
|guisubmenu
|hardware
|interface
|keycap
|keycode
|keycombo
|keysym
|literal
|code
|constant
|markup
|medialabel
|menuchoice
|mousebutton
|option
|optional
|parameter
|prompt
|property
|replaceable
|returnvalue
|sgmltag
|structfield
|structname
|symbol
|systemitem
|uri
|token
|type
|userinput
|varname
|nonterminal
|anchor
|author
|authorinitials
|corpauthor
|corpcredit
|modespec
|othercredit
|productname
|productnumber
|revhistory
|remark
|subscript
|superscript
|inlinegraphic
|inlinemediaobject
|inlineequation
|synopsis
|cmdsynopsis
|funcsynopsis
|classsynopsis
|fieldsynopsis
|constructorsynopsis
|destructorsynopsis
|methodsynopsis
|indexterm
|beginpage
)*
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 (for example, Chapter
), or by
external processes, such as selecting an alternate stylesheet
when publishing.
Remark
s must not be nested within other Remark
s.
Because DocBook is harmonizing towards XML, this restriction cannot be
enforced by the DTD. The processing of nested comments is undefined.
These elements contain remark:
abbrev
, ackno
, acronym
, action
, answer
, appendix
, application
, article
, artpagenums
, attribution
, authorinitials
, bibliocoverage
, bibliodiv
, bibliography
, biblioid
, bibliomisc
, bibliorelation
, bibliosource
, blockquote
, bridgehead
, callout
, caution
, chapter
, citation
, citebiblioid
, citetitle
, city
, classsynopsisinfo
, code
, collabname
, command
, computeroutput
, confdates
, confnum
, confsponsor
, conftitle
, constraintdef
, contractnum
, contractsponsor
, contrib
, corpauthor
, corpcredit
, corpname
, country
, database
, date
, edition
, email
, emphasis
, entry
, fax
, filename
, firstname
, firstterm
, foreignphrase
, funcparams
, funcsynopsisinfo
, function
, glossary
, glossdef
, glossdiv
, glosssee
, glossseealso
, glossterm
, hardware
, holder
, honorific
, important
, index
, indexdiv
, interfacename
, invpartnumber
, isbn
, issn
, issuenum
, itemizedlist
, jobtitle
, keycap
, label
, lineage
, lineannotation
, link
, listitem
, literal
, literallayout
, lotentry
, manvolnum
, member
, modespec
, msgaud
, msgexplan
, msgtext
, note
, olink
, option
, optional
, orderedlist
, orgdiv
, orgname
, otheraddr
, othername
, pagenums
, para
, parameter
, partintro
, phone
, phrase
, pob
, postcode
, preface
, primary
, primaryie
, procedure
, productname
, productnumber
, programlisting
, property
, pubdate
, publishername
, pubsnumber
, qandadiv
, qandaset
, question
, quote
, refentry
, refentrytitle
, refmiscinfo
, refnamediv
, refpurpose
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, releaseinfo
, remark
, replaceable
, revdescription
, revnumber
, revremark
, screen
, screeninfo
, 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
, synopsis
, systemitem
, taskprerequisites
, taskrelated
, tasksummary
, td
, term
, termdef
, tertiary
, tertiaryie
, th
, tip
, title
, titleabbrev
, tocback
, tocentry
, tocfront
, trademark
, ulink
, userinput
, variablelist
, volumenum
, warning
, wordasword
, year
.
The following elements occur in remark:
abbrev
, acronym
, action
, anchor
, application
, author
, authorinitials
, beginpage
, biblioref
, citation
, citebiblioid
, citerefentry
, citetitle
, classname
, classsynopsis
, cmdsynopsis
, code
, command
, computeroutput
, constant
, constructorsynopsis
, corpauthor
, corpcredit
, database
, destructorsynopsis
, email
, emphasis
, envar
, errorcode
, errorname
, errortext
, errortype
, exceptionname
, fieldsynopsis
, filename
, firstterm
, footnote
, footnoteref
, foreignphrase
, funcsynopsis
, function
, glossterm
, guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, hardware
, indexterm
, inlineequation
, inlinegraphic
, inlinemediaobject
, interface
, interfacename
, keycap
, keycode
, keycombo
, keysym
, link
, literal
, markup
, medialabel
, menuchoice
, methodname
, methodsynopsis
, modespec
, mousebutton
, nonterminal
, olink
, ooclass
, ooexception
, oointerface
, option
, optional
, orgname
, othercredit
, package
, parameter
, personname
, phrase
, productname
, productnumber
, prompt
, property
, quote
, remark
, replaceable
, returnvalue
, revhistory
, sgmltag
, structfield
, structname
, subscript
, superscript
, symbol
, synopsis
, systemitem
, termdef
, token
, trademark
, type
, ulink
, uri
, userinput
, varname
, wordasword
, xref
.