[Prev] [Next]

Comment

Name

Synopsis

  ((#PCDATA | FootnoteRef | XRef | Abbrev | Acronym | Citation
  | CiteRefEntry | CiteTitle | Emphasis | FirstTerm
  | ForeignPhrase | GlossTerm | Footnote | Phrase | Quote
  | Trademark | WordAsWord | Link | OLink | ULink | Action
  | Application | ClassName | Command | ComputerOutput
  | Database | Email | EnVar | ErrorCode | ErrorName
  | ErrorType | Filename | Function | GUIButton | GUIIcon
  | GUILabel | GUIMenu | GUIMenuItem | GUISubmenu | Hardware
  | Interface | InterfaceDefinition | KeyCap | KeyCode
  | KeyCombo | KeySym | Literal | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type | UserInput | Anchor | Author | AuthorInitials
  | CorpAuthor | ModeSpec | OtherCredit | ProductName
  | ProductNumber | RevHistory | Comment | Subscript
  | Superscript | InlineGraphic | InlineEquation | Synopsis
  | CmdSynopsis
  | FuncSynopsis)+)
  -(IndexTerm | BeginPage)

Exclusions

Comment excludes these elements at every level:

  IndexTerm | BeginPage

Attributes

This element has common and Role attributes.

Tag Minimization

Both the start- and end-tags are required for this element.

Description

A remark made within the document file that is intended for use during interim stages of production. A Comment should not be displayed to the reader of the finished, published work. It may appear almost anywhere, and may contain almost anything below the Section level.

Usage

Note that, unlike an SGML Comment, unless you take steps to suppress it, the Comment element will be output by an SGML parser or application. You may wish to do this to display Comments along with text during the editorial process. Comment has common attributes.

Parents

These elements contain Comment: Abbrev, Ackno, Acronym, Action, Appendix, Application, ArtPageNums, Article, Attribution, AuthorInitials, BiblioDiv, BiblioMisc, Bibliography, 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, Fax, Filename, FirstName, FirstTerm, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossDef, GlossDiv, GlossSee, GlossSeeAlso, GlossTerm, Glossary, Hardware, Holder, Honorific, ISBN, ISSN, Important, Index, IndexDiv, Interface, InterfaceDefinition, InvPartNumber, IssueNum, JobTitle, KeyCap, LineAnnotation, Lineage, Link, ListItem, Literal, LiteralLayout, LoTentry, ManVolNum, Member, ModeSpec, MsgAud, MsgExplan, MsgText, Note, OLink, Option, Optional, OrgDiv, OrgName, OtherAddr, OtherName, POB, PageNums, Para, Parameter, PartIntro, Phone, Phrase, Postcode, Preface, Primary, PrimaryIE, Procedure, ProductName, ProductNumber, ProgramListing, Property, PubDate, PublisherName, PubsNumber, Quote, RefEntry, RefEntryTitle, RefMiscInfo, RefNameDiv, RefPurpose, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, ReleaseInfo, Replaceable, RevNumber, RevRemark, Screen, ScreenInfo, Secondary, SecondaryIE, Sect1, Sect2, Sect3, Sect4, Sect5, 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, and entry.

Children

Comment contains these elements: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, GlossTerm, Hardware, InlineEquation, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, #PCDATA, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, WordAsWord, and XRef.

In some contexts, additional elements may be allowed by inclusions in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Examples

<PARA>
This fine set of examples has been tested by parsing them
<COMMENT>ta:  say which tool you used.</COMMENT>
against the version of the DTD to which they pertain.
<COMMENT>ed:  don't say that until you do the testing.</COMMENT>  
<COMMENT>ta:  right, and after I've done so I'll change the
style sheet to hide these comments.</COMMENT>
</PARA>

[Prev] Command
[Next] component.mix
[Reference Home] [Davenport Group Home]