DocBook: The Definitive Guide

docbook: the definitive guide
By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
PrevNext

Name

FuncSynopsisInfo -- Information supplementing the FuncDefs of a FuncSynopsis

Synopsis

Mixed Content Model

FuncSynopsisInfo ::= ((LineAnnotation|#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|   Constant|Markup|MediaLabel|MenuChoice|MouseButton|MsgText|   Option|Optional|Parameter|Prompt|Property|Replaceable|   ReturnValue|SGMLTag|StructField|StructName|Symbol|SystemItem|   Token|Type|UserInput|VarName|Anchor|Comment|Subscript|   Superscript|InlineGraphic|InlineMediaObject|IndexTerm)*)

Attributes

Common attributes

Name

Type

Default

Format

Enumerated notation:

linespecific

"linespecific"

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

Supplementary information in a FuncSynopsis. See FuncSynopsis.

Unlike the otherinfo elements, FuncSynopsisInfo is not a container for meta-information. Instead FuncSynopsisInfo is a verbatim environment for adding additional information to a function synopsis.

Processing expectations

This element is displayed "verbatim"; whitespace and linebreaks within this element are significant.

(4.0) Future Changes

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 FuncSynopsisInfo: FuncSynopsis.

Children

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

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

Attributes

Format

The Format attribute applies the linespecific notation to all FuncSynopsisInfos. All white space and line breaks must be preserved.

See Also

FuncDef, FuncParams, FuncPrototype, Function, ParamDef, Parameter, ReturnValue, VarArgs, Void

Examples

For examples, see FuncSynopsis, VarArgs.


PrevHomeNext
FuncSynopsisUpFunction

Back to: DocBook: The Definitive Guide


O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.



DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton
BUY ON AMAZON

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition)

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net