[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: [dita] Last call for top DITA issues
Hi, Jen:
I have some unstated assumption that would become more obvious with a map context.
If each definition is in a separate topic, then assembling a glossary for a deliverable is just part of the usual map approach of selecting the appropriate content from a pool of available content:
<bookmap>
...
<glossarylist>
...
<glossentryref href=""ac-air.dita"/>
...
<glossentryref href=""ac-electric.dita"/>
...
</glossarylist>
...
</bookmap>
Different deliverables will have different maps, so it's easy for a deliverable to include either or both of the definitions for AC.
If both definitions are in the topic, then I need a separate topic for each permutation of the definitions for the term and need to share the definitions across topics by conref. In this case, that's three permutations (ac-air.dita, ac-electric.dita, and as-airelectric.dita).
<glossentry id="ac-airelectric.dita">
<glossterm id="term">AC</glossterm>
<glossdef id="air-def">Air conditioning</glossdef>
<glossdef id="electric-def">Air conditioning</glossdef>
</glossentry>
<glossentry id="ac-air.dita">
<glossterm conref="ac-airelectric.dita#ac-airelectric/term"/>
<glossdef id="ac-airelectric.dita#ac-airelectric/air-def"/>
</glossentry>
<glossentry id="ac-electric.dita">
<glossterm conref="ac-airelectric.dita#ac-airelectric/term"/>
<glossdef id="ac-airelectric.dita#ac-airelectric/electric-def"/>
</glossentry>
Of course, the number of permutations goes up with the number of definitions per term.
In other words, it's an example of the familiar tradeoffs between managing reuse with a map on topics as opposed to conref within topics.
Either way, I think people will want the ability to select the definitions that are pertinent to their deliverable.
Hoping that clarifies,
Erik Hennum
ehennum@us.ibm.com
"Jennifer Linton" <jennifer.linton@comtech-serv.com>
02/20/2006 09:20 AM |
|
Jen Linton
Comtech Services, Inc.
Senior Consultant and Web Manager
710 Kipling St. Suite 400
Denver, CO 80215
P: 303-232-7586
F: 303-232-0659
skype: jenlinton
Hi, Jen:
I think it's a reuse issue. Some information deliverables might use both ac-air and ac-electric. Others might use one or the other alone. So, we're better off letting the process collate and format the selected definitions rather than having writers manually assemble each glossary entry.
Down the road, one could imagine a process that
1. Builds a list of terms based on occurrences of <term> within the content
2. Pulls the definitions for those terms from a pool of available glossary definitions
3. Collates the definitions by term
4. Formats the definitions for publication
Thanks,
Erik Hennum
ehennum@us.ibm.com
"Jennifer Linton" <jennifer.linton@comtech-serv.com>
02/20/2006 08:54 AM |
|
Jen Linton
Comtech Services, Inc.
Senior Consultant and Web Manager
710 Kipling St. Suite 400
Denver, CO 80215
P: 303-232-7586
F: 303-232-0659
skype: jenlinton
Hi, Bruce:
My apologies for neglecting to clarify the term concerns -- I think the existing glossary proposal already handles both the case where the same term has multiple senses:
<glossentry id="ac-air">
<glossterm>AC</glossterm>
<glossdef>Air conditioning</glossdef>
</glossentry>
...
<glossentry id="ac-electric">
<glossterm>AC</glossterm>
<glossdef>Alternating current</glossdef>
</glossentry>
It would be up to the processing to collate by term and format definitions on output.
The proposal also includes a <glsynonym> element to specify synonym terms with the same meaning.
If one of the themes of DITA 1.1 / DITA 1.0.5 is enabling books, I'm wondering whether the shortdesc enhancements would be important for the narrative glue.
Hoping that's interesting,
Erik Hennum
ehennum@us.ibm.com
"Esrig, Bruce (Bruce)" <esrig@lucent.com>
02/20/2006 03:49 AM |
|
Which index-related issues would you prioritize?
- #44 Keep indextermref (or redefine its function)
- #45 Add See, See Also indexing elements
- #45a Add sort order indexing elements
- #45b Add page range indexing elements
I wouldn't leave the others out if we can manage it.
Hi, Paul:
As Don was pointing out to me today, the <data> element presumably rides in on the coat tails of bookmap because the book metadata depends on it, but that should be okay because <data> is good to go (unless anyone has thought of ways to improve it while it has been sitting on ice).
Does glossary also ride in with bookmap as a requirement for having a complete book story?
Any other hangers on?
Thanks,
Erik Hennum
ehennum@us.ibm.com
"Paul Prescod" <paul.prescod@blastradius.com>
02/17/2006 03:22 PM |
|
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]