Description
The Comment 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.
 | The Comment element is unrelated to the
|
Comments 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 Comment content model.
Processing expectations
May be formatted inline or as a displayed block, depending on context. Comments 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.
Comments must not be nested within other Comments. Because DocBook is harmonizing towards XML, this restriction cannot be enforced by the DTD. The processing of nested comments is undefined.
Future Changes
Comment will be renamed to Remark in DocBook V4.0.
The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.
Parents
These elements contain Comment: Abbrev, Ackno, Acronym, Action, Answer, Appendix, Application, Article, ArtPageNums, Attribution, AuthorInitials, BiblioDiv, Bibliography, BiblioMisc, BlockQuote, BridgeHead, Callout, Caution, Chapter, Citation, CiteTitle, City, CollabName, Command, Comment, ComputerOutput, ConfDates, ConfNum, ConfSponsor, ConfTitle, ContractNum, ContractSponsor, Contrib, CorpAuthor, 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, Interface, InterfaceDefinition, InvPartNumber, ISBN, ISSN, IssueNum, JobTitle, KeyCap, Label, Lineage, LineAnnotation, Link, ListItem, Literal, LiteralLayout, LoTentry, ManVolNum, Member, ModeSpec, MsgAud, MsgExplan, MsgText, Note, OLink, Option, Optional, 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, RefSynopsisDiv, ReleaseInfo, Replaceable, 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, Term, Tertiary, TertiaryIE, Tip, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput, VolumeNum, Warning, WordAsWord, Year.
Children
The following elements occur in Comment: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineEquation, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.
In some contexts, the following elements are excluded: Acronym, Footnote, IndexTerm.