remark
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# remark

## Name

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

##

# Synopsis

### Mixed Content Model

    remark ::=
    (#PCDATA|footnoteref|xref|abbrev|acronym|citation|citerefentry|
     citetitle|emphasis|firstterm|foreignphrase|glossterm|footnote|
     phrase|quote|trademark|wordasword|link|olink|ulink|action|
     application|classname|methodname|interfacename|exceptionname|
     ooclass|oointerface|ooexception|command|computeroutput|database|
     email|envar|errorcode|errorname|errortype|filename|function|
     guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|
     hardware|interface|keycap|keycode|keycombo|keysym|literal|
     constant|markup|medialabel|menuchoice|mousebutton|option|
     optional|parameter|prompt|property|replaceable|returnvalue|
     sgmltag|structfield|structname|symbol|systemitem|token|type|
     userinput|varname|nonterminal|anchor|author|authorinitials|
     corpauthor|modespec|othercredit|productname|productnumber|
     revhistory|remark|subscript|superscript|inlinegraphic|
     inlinemediaobject|inlineequation|synopsis|cmdsynopsis|
     funcsynopsis|classsynopsis|fieldsynopsis|constructorsynopsis|
     destructorsynopsis|methodsynopsis|indexterm|beginpage)*

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain remark:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%cptr.char.mix;` | `%divcomponent.mix;` | `%docinfo.char.mix;`
`%genobj.class;` | `%glossdef.mix;` | `%indexdivcomponent.mix;`
`%ndxterm.char.mix;` | `%other.char.class;` | `%para.char.mix;`
`%qandaset.mix;` | `%refcomponent.mix;` | `%refinline.char.mix;`
`%revdescription.mix;` | `%sidebar.mix;` | `%tbl.entry.mdl;`
`%title.char.mix;` | `%word.char.mix;` |

## 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 (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.

### Parents

These elements contain remark: `abbrev`, `ackno`, `acronym`, `answer`, `appendix`, `application`, `article`, `artpagenums`, `attribution`, `authorinitials`, `bibliodiv`, `bibliography`, `bibliomisc`, `blockquote`, `bridgehead`, `callout`, `caution`, `chapter`, `citation`, `citetitle`, `city`, `classsynopsisinfo`, `collabname`, `command`, `computeroutput`, `confdates`, `confnum`, `confsponsor`, `conftitle`, `constraintdef`, `contractnum`, `contractsponsor`, `contrib`, `corpauthor`, `corpname`, `country`, `date`, `edition`, `email`, `emphasis`, `entry`, `fax`, `firstname`, `firstterm`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glossary`, `glossdef`, `glossdiv`, `glosssee`, `glossseealso`, `glossterm`, `holder`, `honorific`, `important`, `index`, `indexdiv`, `invpartnumber`, `isbn`, `issn`, `issuenum`, `jobtitle`, `label`, `lineage`, `lineannotation`, `link`, `listitem`, `literal`, `literallayout`, `lotentry`, `manvolnum`, `member`, `modespec`, `msgaud`, `msgexplan`, `msgtext`, `note`, `olink`, `optional`, `orgdiv`, `orgname`, `otheraddr`, `othername`, `pagenums`, `para`, `partintro`, `phone`, `phrase`, `pob`, `postcode`, `preface`, `primary`, `primaryie`, `procedure`, `productname`, `productnumber`, `programlisting`, `pubdate`, `publishername`, `pubsnumber`, `qandadiv`, `qandaset`, `question`, `quote`, `refentry`, `refentrytitle`, `refmiscinfo`, `refnamediv`, `refpurpose`, `refsect1`, `refsect2`, `refsect3`, `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`, `term`, `tertiary`, `tertiaryie`, `tip`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `trademark`, `ulink`, `userinput`, `volumenum`, `warning`, `wordasword`, `year`.

### Children

The following elements occur in remark: `abbrev`, `acronym`, `action`, `anchor`, `application`, `author`, `authorinitials`, `beginpage`, `citation`, `citerefentry`, `citetitle`, `classname`, `classsynopsis`, `cmdsynopsis`, `command`, `computeroutput`, `constant`, `constructorsynopsis`, `corpauthor`, `database`, `destructorsynopsis`, `email`, `emphasis`, `envar`, `errorcode`, `errorname`, `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`, `othercredit`, `parameter`, `phrase`, `productname`, `productnumber`, `prompt`, `property`, `quote`, `remark`, `replaceable`, `returnvalue`, `revhistory`, `sgmltag`, `structfield`, `structname`, `subscript`, `superscript`, `symbol`, `synopsis`, `systemitem`, `token`, `trademark`, `type`, `ulink`, `userinput`, `varname`, `wordasword`, `xref`.

## Examples

    <!DOCTYPE example PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <example><title>The Grand Unified Theory</title>
    <para>
    <remark>Some details are still a bit shaky</remark>
    &hellip;
    Q.E.D.
    </para>
    </example>

Example 32. The Grand Unified Theory

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

Prev | Home | Next
releaseinfo | Up | replaceable

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.