Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

Optional
Guide to the DocBook DTD
PrevNext

Optional

Name

Optional -- Optional information contained in a Synopsis

Content Model

  (#PCDATA | 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 | Comment | Subscript
  | Superscript
  | InlineGraphic)+

Attributes

This element has common and Role attributes.

Tag Minimization

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

Description

Optional information contained in a Synopsis, as in a RefEntry, where optional parameters conventionally are shown in square brackets; may also appear in-line. Optional should replace those brackets. It may contain elements from cptr.char.mix, and has common attributes.

Parents

These elements contain Optional: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Replaceable, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput, entry.

Children

Optional contains these elements: Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, #PCDATA, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, UserInput.

In some contexts, some of these elements may be invalid due to exclusions in parent elements.

Examples

<REFSYNOPSISDIV ID="RS-061-66">
<SYNOPSIS>
<COMMAND>ls</COMMAND>
<OPTIONAL><PARAMETER>options</PARAMETER></OPTIONAL>
<REPLACEABLE CLASS="PARAMETER">directory name
</REPLACEABLE>
</SYNOPSIS>
</REFSYNOPSISDIV>
PrevHomeNext
OptionUpOrderedList