Whole document tree
Synopsis
Content Model
(LineAnnotation | #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 | Graphic)+
Description
Syntax of a command or function. It appears within RefSynopsisDiv, and may occur elsewhere in a document, too. Synopsis has an optional Title, followed by one or more in-line elements and Graphics; within it, line breaks and white space are significant. It has common attributes. CmdSynopsis and FuncSynopsis are alternates to Synopsis, but they may not contain Graphics and within them line breaks and white space are not significant.
Parents
These elements contain Synopsis: Appendix, Application, Article, Attribution, BiblioDiv, BiblioMisc, Bibliography, BlockQuote, Callout, Caution, Chapter, Citation, CiteTitle, Comment, Emphasis, Example, Figure, Footnote, ForeignPhrase, GlossDef, GlossDiv, GlossSee, GlossSeeAlso, GlossTerm, Glossary, Important, Index, IndexDiv, InformalExample, LineAnnotation, Link, ListItem, LiteralLayout, LoTentry, Member, MsgAud, MsgExplan, MsgText, Note, OLink, Para, PartIntro, Phrase, Preface, Procedure, ProductName, ProgramListing, Quote, RefEntryTitle, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Screen, ScreenInfo, Sect1, Sect2, Sect3, Sect4, Sect5, Seg, SetIndex, Sidebar, SimPara, SimpleSect, Step, Synopsis, Term, Tip, ToCback, ToCentry, ToCfront, ULink, Warning, entry.
Children
Synopsis 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, Graphic, Hardware, InlineEquation, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, LineAnnotation, 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, 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.
Attributes
- Label
Label holds an identifying number or string to be output in some manner when the element it is applied to is rendered.
- Format
Line ends and leading white space must be preserved in output.