Flylib.com

Books Software

 
 
 

DocBook: The Definitive Guide

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
Prev Next

SubjectTerm

Name

SubjectTerm -- A term in a group of terms describing the subject matter of a document

Synopsis

Mixed Content Model

SubjectTerm ::= (#PCDATA)

Attributes

Common attributes

Tag Minimization

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

Description

A SubjectTerm is an individual subject word or phrase that describes the subject matter of a document or the portion of a document in which it occurs.

Subject terms are not expected to contain any markup. They are external descriptions from a controlled vocabulary.

Processing expectations

May be formatted inline or as a displayed block, depending on context. Subject terms are rarely displayed to a reader. Usually, they are reserved for searching and retrieval purposes.

Parents

These elements contain SubjectTerm: Subject .

Children

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

See Also

Keyword , KeywordSet , Subject , SubjectSet

Examples

For examples, see SubjectSet .


Prev Home Next
SubjectSet Up Subscript

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.

<one> SubSteps </one>
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
Prev Next

SubSteps

Name

SubSteps -- A wrapper for steps that occur within steps in a procedure

Synopsis

Content Model

SubSteps ::= (Step+)

Attributes

Common attributes

Name

Type

Default

Performance

Enumeration:

Optional
Required

"Required"

Tag Minimization

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

Description

A Procedure describes a sequence of Step s that a reader is expected to perform. If a finer level of granularity is required for some steps, you can use SubSteps to embed substeps within a Step .

SubSteps contain Step s, so substeps can be nested to any depth.

Processing expectations

Formatted as a displayed block. SubStep s are almost always numbered.

Parents

These elements contain SubSteps: Step .

Children

The following elements occur in SubSteps: Step .

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

Attributes

Performance

Performance specifies whether particular set of Substep in a Procedure must be performed or is optional.

Examples

For examples, see Procedure .


Prev Home Next
Subscript Up Subtitle

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.

<one> Subtitle </one>
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
Prev Next

Subtitle

Name

Subtitle -- The subtitle of a document

Synopsis

Mixed Content Model

Subtitle ::= ((#PCDATAFootnoteRefXRefAbbrevAcronymCitationCiteRefEntry CiteTitleEmphasisFirstTermForeignPhraseGlossTermFootnote PhraseQuoteTrademarkWordAsWordLinkOLinkULinkAction ApplicationClassNameCommandComputerOutputDatabaseEmail EnVarErrorCodeErrorNameErrorTypeFilenameFunctionGUIButton GUIIconGUILabelGUIMenuGUIMenuItemGUISubmenuHardware InterfaceInterfaceDefinitionKeyCapKeyCodeKeyComboKeySym LiteralConstantMarkupMediaLabelMenuChoiceMouseButton MsgTextOptionOptionalParameterPromptPropertyReplaceable ReturnValueSGMLTagStructFieldStructNameSymbolSystemItem TokenTypeUserInputVarNameAnchorAuthorAuthorInitials CorpAuthorModeSpecOtherCreditProductNameProductNumber RevHistoryCommentSubscriptSuperscriptInlineGraphic InlineMediaObjectInlineEquationIndexTerm)+)

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

%bibliocomponent.mix; %bookcomponent.title.content; %div.title.content;
%refsect.title.content; %sect.title.content;

Description

A Subtitle identifies the subtitle of a document, or portion of a document.

Processing expectations

Formatted as a displayed block.

Parents

These elements contain Subtitle: Appendix , ArtHeader , Article , BiblioDiv , BiblioEntry , Bibliography , BiblioMixed , BiblioMSet , BiblioSet , Book , BookBiblio , BookInfo , Chapter , Colophon , Dedication , DocInfo , Glossary , GlossDiv , Index , IndexDiv , LoT , ObjectInfo , Part , PartIntro , Preface , Reference , RefSect1 , RefSect1Info , RefSect2 , RefSect2Info , RefSect3 , RefSect3Info , RefSynopsisDiv , RefSynopsisDivInfo , Sect1 , Sect1Info , Sect2 , Sect2Info , Sect3 , Sect3Info , Sect4 , Sect4Info , Sect5 , Sect5Info , Section , SectionInfo , SeriesInfo , Set , SetIndex , SetInfo , SimpleSect , ToC .

Children

The following elements occur in Subtitle: Abbrev , Acronym , Action , Anchor , Application , Author , AuthorInitials , Citation , CiteRefEntry , CiteTitle , ClassName , Command , Comment , ComputerOutput , Constant , CorpAuthor , Database , Email , Emphasis , EnVar , ErrorCode , ErrorName , ErrorType , Filename , FirstTerm , Footnote , FootnoteRef , ForeignPhrase , Function , GlossTerm , GUIButton , GUIIcon , GUILabel , GUIMenu , GUIMenuItem , GUISubmenu , Hardware , IndexTerm , InlineEquation , InlineGraphic , InlineMediaObject , Interface , InterfaceDefinition , KeyCap , KeyCode , KeyCombo , KeySym , Link , Literal , Markup , MediaLabel , MenuChoice , ModeSpec , MouseButton , MsgText , OLink , Option , Optional , OtherCredit , Parameter , Phrase , ProductName , ProductNumber , Prompt , Property , Quote , Replaceable , ReturnValue , RevHistory , SGMLTag , StructField , StructName , Subscript , Superscript , Symbol , SystemItem , Token , Trademark , Type , ULink , UserInput , VarName , WordAsWord , XRef .

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

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

See Also

Title , TitleAbbrev

Examples

For examples, see Bibliography , Sect1Info , Section .


Prev Home Next
SubSteps Up Superscript

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.