DocBook: The Definitive Guide

Table of content


	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

Name

Phrase -- A span of text

Synopsis

Mixed Content Model

Phrase ::= ((#PCDATA|FootnoteRef|XRef|Abbrev|Acronym|Citation|CiteRefEntry|   CiteTitle|Emphasis|FirstTerm|ForeignPhrase|GlossTerm|Footnote|   Phrase|Quote|Trademark|WordAsWord|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|Author|AuthorInitials|   CorpAuthor|ModeSpec|OtherCredit|ProductName|ProductNumber|   RevHistory|Comment|Subscript|Superscript|InlineGraphic|   InlineMediaObject|InlineEquation|Synopsis|CmdSynopsis|   FuncSynopsis|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

`%gen.char.class;`	`%ndxterm.char.mix;`	`%para.char.mix;`
`%programlisting.content;`	`%refinline.char.mix;`	`%screen.content;`
`%tbl.entry.mdl;`	`%title.char.mix;`

Description

The Phrase element in DocBook has no specific semantic. It is provided as a wrapper around a selection of words smaller than a paragraph so that it is possible to provide an ID or other attributes for them.

For example, if you are making note of changes to a document using one of the effectivity attributes, you might use Phrase to mark up specific sentences with revisions.

Processing expectations

Formatted inline.

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 Phrase: Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Comment, Emphasis, entry, ForeignPhrase, GlossSee, GlossSeeAlso, GlossTerm, LineAnnotation, Link, LiteralLayout, LoTentry, Member, MsgAud, OLink, Para, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Quote, RefEntryTitle, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, Term, Tertiary, TertiaryIE, TextObject, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, ULink.

Children

The following elements occur in Phrase: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, 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, Synopsis, 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.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> Effectivity attributes can be used to keep track of modifications to a document <phrase revisionflag="deleted">at the word or sentence level</phrase><phrase revisionflag="added"> as long as the number and complexity of changes is not too high</phrase>. </para>

Effectivity attributes can be used to keep track of modifications to a document at the word or sentence level as long as the number and complexity of changes is not too high.

For additional examples, see also AudioObject, ImageObject, InformalFigure, InlineMediaObject.