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

Sect1 -- A top-level section of document

Synopsis

Content Model

Sect1 ::= (Sect1Info?,  (Title,Subtitle?,TitleAbbrev?),  (ToC|LoT|Index|Glossary|Bibliography)*,  (((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|     SimpleList|VariableList|Caution|Important|Note|Tip|Warning|     LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|     ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|     SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|     MediaObjectCO|InformalEquation|InformalExample|InformalFigure|     InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|     Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|     Abstract|AuthorBlurb|Epigraph|IndexTerm)+,    ((RefEntry)*|     Sect2*|SimpleSect*))|   (RefEntry)+|   Sect2+|SimpleSect+),  (ToC|LoT|Index|Glossary|Bibliography)*)

Attributes

Common attributes

Name

Type

Default

LabelCDATANone
StatusCDATANone
Renderas

Enumeration:

Sect2
Sect3
Sect4
Sect5

None

Tag Minimization

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

Parameter Entities

%bookcomponent.content;

Description

Sect1 is one of the top-level sectioning elements in a component. There are three types of sectioning elements in DocBook:

None of the sectioning elements is allowed to "float" in a component. You can place paragraphs and other block elements before a section, but you cannot place anything after it.

This means that you cannot have content in the Sect1 after the end of a Sect2. This is consistent with the DocBook book model, because in a printed book it is usually impossible for a reader to detect the end of the enclosed second level section and, therefore, all content after a second level section appears in that section.

Processing Expectations

Formatted as a displayed block. Sometimes sections are numbered.

(4.0) Future Changes

In DocBook V4.0, the ToC element in the content model will be replaced by TocChap.

Parents

These elements contain Sect1: Appendix, Article, Chapter, PartIntro, Preface.

Children

The following elements occur in Sect1: Abstract, Address, Anchor, AuthorBlurb, Bibliography, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, Glossary, GlossList, Graphic, GraphicCO, Highlights, Important, Index, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, LoT, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, RefEntry, Screen, ScreenCO, ScreenShot, Sect1Info, Sect2, SegmentedList, Sidebar, SimPara, SimpleList, SimpleSect, Subtitle, Synopsis, Table, Tip, Title, TitleAbbrev, ToC, VariableList, Warning.

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

Attributes

Label

Label specifies an identifying string for presentation purposes.

Generally, an explicit Label attribute is used only if the processing system is incapable of generating the label automatically. If present, the Label is normative; it will used even if the processing system is capable of automatic labelling.

Renderas

The RenderAs attribute identifies how the section should be rendered. In this way, a section at one level of the structural hierarchy can be made to appear to be at another level.

Status

Status identifies the editorial or publication status of the Sect1.

Publication status might be used to control formatting (for example, printing a "draft" watermark on drafts) or processing (perhaps a document with a status of "final" should not include any components that are not final).

See Also

BridgeHead, Sect2, Sect3, Sect4, Sect5, Section, SimpleSect

Examples

For examples, see Chapter, IndexTerm, OLink.


PrevHomeNext
SecondaryIEUpSect1Info

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