[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [dita] Keywords in DITA
Hi, Dana, JoAnn, and Rob:
<keywords> <chemicalterm>molecule</chemicalterm> <programword>element</programword> </keywords> </metadata> ... <p>You list each <chemicalterm>atom</chemicalterm> in the <programword>array</programword>....</p> If anything, I'd suggest that the culprit in creating confusing expectations might be the <keywords> element. A metadata <topicwords> element that can contain <keyword>, <term>, or <indexterm> might be better, but I wouldn't expect serious consideration of that thought until after DITA 1.0 The need for enhancement never ends, and if we try to squeeze in this one, I'm sure lots of others will come out of the woodwork (such as the deferred <data> element). Hoping that's useful, Erik Hennum ehennum@us.ibm.com Dana Spradley <dana.spradley@oracle.com>
erratum: "otherwise you're sending mixed messages..." In fact, it seems to me this whole discussion was provoked by a bad definition for <keyword> in the language spec, which defined it as a keyword in the technical programming sense, while from the <keywords> definition you would have expected it to be defined as in DocBook. We could solve the entire issue by just revising that <keyword> definition to be what <keywords> expects. If people feel there is a need for keywords in the technical sense to migrate beyond the confines of syntax diagrams, then that's a separate issue for the folks working on the Programming Domain vis-a-vis the <kwd> element - which *is* defined as a keyword in the technical programming sense. --Dana Dana Spradley wrote:
The <kwd> element exists for that. <keyword> outside <keywords> should have the same meaning it does within - outwise you're sending mixed messages to authors, and mixing up the use. JoAnn Hackos wrote:
JoAnn JoAnn T. Hackos, PhD From: Rob Frankland [mailto:robf@rascalsoftware.com] Sent: Monday, March 14, 2005 9:29 AM To: 'Paul Prescod'; JoAnn Hackos; 'Don Day' Cc: dita@lists.oasis-open.org Subject: RE: [dita] Keywords in DITA I agree, having followed this thread. Your suggested solution covers both use cases. I believe the largest number of users will want the HTML/Docbook usage and this enables the programmer writers to meet their needs as well. Rob Sent: Tuesday, March 08, 2005 5:46 PM To: JoAnn Hackos; Don Day Cc: dita@lists.oasis-open.org Subject: RE: [dita] Keywords in DITA Okay, an emerging consensus seems to be that <keyword> in <keywords> means <keyword> in the HTML/Docbook sense. http://www.docbook.org/tdg/en/html/keyword.html . It is typically hidden from the user as metadata and embedded in the HTML meta tag. <keyword> in other contexts is more like a word from an API or language. Should we just document it that way? If so, I can suggest some wordings. Paul Prescod |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]