DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

WordAsWord

Name

WordAsWord -- A word meant specifically as a word and not representing anything else

Synopsis

Mixed Content Model

WordAsWord ::=
((#PCDATA|Acronym|Emphasis|Trademark|Link|OLink|ULink|Anchor|
  Comment|Subscript|Superscript|InlineGraphic|InlineMediaObject|
  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

A lot of technical documentation contains words that have overloaded meanings. Sometimes it is useful to be able to use a word without invoking its technical meaning. The WordAsWord element identifies a word or phrase that might otherwise be interpreted in some specific way, and asserts that it should be interpreted simply as a word.

It is unlikely that the presentation of this element will be able to help readers understand the variation in meaning; good writing will have to achieve that goal. The real value of WordAsWord lies in the fact that full-text searching and indexing tools can use it to avoid false-positives.

Processing expectations

Formatted inline.

Parents

These elements contain WordAsWord: 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, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, ULink.

Children

The following elements occur in WordAsWord: Acronym, Anchor, Comment, Emphasis, IndexTerm, InlineGraphic, InlineMediaObject, Link, OLink, Subscript, Superscript, Trademark, ULink.

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

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

See Also

Abbrev, Acronym, Emphasis, ForeignPhrase, Phrase, Quote

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
A <wordasword>Term</wordasword> in Algebra has a very different meaning
than a <sgmltag>Term</sgmltag> in DocBook.
</para>

A Term in Algebra has a very different meaning than a Term in DocBook.

PrevHomeNext
WarningUpXRef

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.