DocBook: The Definitive GuideBy Norman Walsh & Leonard Muellner1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
InformalExample
Synopsis
Content Model
InformalExample ::= ((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList| SimpleList|VariableList|LiteralLayout|ProgramListing| ProgramListingCO|Screen|ScreenCO|ScreenShot|Synopsis| CmdSynopsis|FuncSynopsis|FormalPara|Para|SimPara|Address| BlockQuote|Graphic|GraphicCO|MediaObject|MediaObjectCO| InformalEquation|InformalExample|InformalFigure|InformalTable| IndexTerm)+)Attributes
Name
Type
Default
Width NUMBER None Tag Minimization
Both the start- and end-tags are required for this element.
Parameter Entities
Description
InformalExample is a wrapper for an example without a title. Examples often contain ProgramListings or other large block elements.
Parents
These elements contain InformalExample: Answer, Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caution, Chapter, Example, Figure, Footnote, Glossary, GlossDef, GlossDiv, Important, Index, IndexDiv, InformalExample, InformalFigure, ListItem, MsgExplan, MsgText, Note, Para, PartIntro, Preface, Procedure, QandADiv, QandASet, Question, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, Section, SetIndex, Sidebar, SimpleSect, Step, Tip, Warning.
Children
The following elements occur in InformalExample: Address, BlockQuote, CalloutList, CmdSynopsis, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, OrderedList, Para, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, SimPara, SimpleList, Synopsis, VariableList.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
In some contexts, the following elements are excluded: IndexTerm, InformalTable.
Attributes
- Width
Width specifies the width (in characters) of the longest line in this InformalExample (formatters may use this value to determine scaling or rotation).
Examples
<!DOCTYPE informalexample PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <informalexample> <programlisting> sub print_content_model { my($self) = shift; local($_) = shift; local(*FILE) = shift; my(@cm) = $self->format_content_model2($_); foreach $_ (@cm) { print FILE $self->make_links($_, 1, 1), "\n"; } } </programlisting> </informalexample>sub print_content_model { my($self) = shift; local($_) = shift; local(*FILE) = shift; my(@cm) = $self->format_content_model2($_); foreach $_ (@cm) { print FILE $self->make_links($_, 1, 1), "\n"; } }For additional examples, see also ScreenCO.
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.