[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: [dita] Keywords in DITA
For the time being, perhaps we could
rephrase the first sentence in the "keywords" entry in the language reference.
Then we could separate the senses in a
future release of DITA. Something like <keyword> versus
<searchTerm>.
New text >>> The <keywords>
element contains a list of identifying terms that are marked with
<indexterm> or <keyword>. In this context, <keyword> surrounds
a word or phrase that would make a good target for a search
engine.
Bruce
Esrig
Information Developer / Information
Architect
Lucent
Technologies
===========
Here is an extended explanation
of the nuances of the senses of
keyword.
Common
part of the definition: A keyword is a distinguished identifier or phrase within
the content.
So far, the definition seems abstract. Any concrete
example would have one of the two following senses.
1. If
a keyword is located in content that is structured by a formal language, than
the keyword typically has a pre-defined meaning in that language. It informs the
reader how to interpret the other content.
Simple
examples include the keywords "end" and "integer" in a
programming language. A field name in a user interface can be viewed as an
identifier, and can play the role of a keyword. In this sense, keyword is
contrasted with user input or user-specified content.
In the
case of extensible languages such as object-oriented languages, an
identifier is not a keyword in the context where it is defined (example:
definition of a method), but is a keyword in the context where it is used
(example: use of a method).
The example of stdio.h fits this
definition in an unexpected way. You have to dereference it before you get the
information about how to interpret the other content. In this example, you might
expect to distinguish the entire expression, as in <keyword>include
"stdio.h"</keyword>, from the other
content.
2. If
a keyword is distinguished from other content to make the content easier to
find, then it will not have a meaning that is predetermined by the
framework in which it is set. In this case, the keyword is distinguished because
it is a significant identifier or phrase that helps to identify the content.
This is what makes this kind of keyword useful as a search target. A match
against the keyword is an indication that the content may be of
interest.
|
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]