MHonArc v2.5.0b2 -->
dita message
[Date Prev]
| [Thread Prev]
| [Thread Next]
| [Date Next]
--
[Date Index]
| [Thread Index]
| [List Home]
Subject: RE: [dita] Proposed revision for the keyword definition (was Keyw ords inDITA)
From: Michael Priestley <>
To: "Esrig, Bruce (Bruce)" <>
Date: Tue, 15 Mar 2005 11:02:21 -0500
For comparison/voting, here's what's
in the draft of the spec I'm about to upload:
<keyword> represents a word or phrase with special
significance in a particular domain. In the general case, <keyword>
elements typically do not have any special semantics and processing associated
with them, but can still be useful for organizing content for reuse or
special processing. <keyword> specializations are more meaningful
and are therefore preferable. <keyword> in the <keywords> element
distinguishes a word or phrase that describes the content of a topic (a
topic description keyword). Topic description keywords are typically used
for searching, retrieval and classification purposes.
Specialized elements derived from <keyword> may also
have extended processing, such as different formatting or automatic indexing.
If the keyref attribute is used, or some other method of key-based lookup
based on the value of the element itself, then the keyword can be turned
into a hyperlink on output (not currently supported).
When DITA topics are output to XHTML, any <keyword>
elements in the <keywords> element are placed in the Web page metadata.
Michael Priestley
"Esrig, Bruce (Bruce)"
<>
03/15/2005 10:57 AM
To
cc
Subject
RE: [dita] Proposed revision
for the keyword definition (was Keyw ords
in DITA)
Here is some updated text for
consideration.
Bruce
========
The <keyword> element and
its specializations are used to mark a word or compound word with special
meaning in a particular domain. For special treatment of phrases, see <ph>.
In the prolog of a topic, the <keyword> element may appear within
the <keywords> element. In this context, the contents of the <keyword>
element indicate the
subject of the topic. This
information is intended to help an author classify and identify a topic,
which can be used for
search and retrieval applications and
other applications such as flagging.
In the body of a topic, the <keyword> element delimits words and
compound words that also appear within the text of the topic.
In either context, the preferred approach
is to use a specialization of <keyword>. The specializations have
special semantics associated with them. In the body of a topic, the specializations
can be processed with special formatting in the output.
If no appropriate specialization has been created,
the author can use the outputclass attribute to indicate the semantic scope.
