dita message
[Date Prev]
| [Thread Prev]
| [Thread Next]
| [Date Next]
--
[Date Index]
| [Thread Index]
| [List Home]
Subject: Question from keys review: processing keyref for text or link text
- From: "Robert D Anderson" <robander@us.ibm.com>
- To: DITA TC <dita@lists.oasis-open.org>
- Date: Thu, 7 May 2015 11:18:32 -0500
DITAWeb URL:
http://ditaweb.com/oasis-dita/#/Collaborate/00160583-FA_1/DB00073845/Processing%20key%20references%20to%20generate%20text%20or%20link%20text
Topic: "Processing key references to generate text or link text"
Issue: DITA 1.2 text was unclear in many cases about how to use keys to get effective content for an element (for example, pulling text into an empty link or keyword during processing). I've collected all the rules from 1.2 and put them into a single list, including the order in which each condition should be checked. Summarizing the list here:
1. If keyref is on abbreviated-form, use special rules
2. Otherwise, if keyref element doesn't allow @href, look for <keyword> inside <keywords> inside topicmeta
3. Otherwise, if keyref element allows @href, elements legal inside the keyref element are pulled from topicmeta
4. Otherwise, if key definition has <linktext>, use that
5. Otherwise, resolve as you would other links, such as pulling a title from the target
I've added the following draft comment, which appeared in Review 2 last fall, and is still unresolved:I think from close review that we should have a rule in here that is specific to elements allowed inside of <topicmeta> -- that is, author, source, data, and data-about. If those exist as a child of <topicmeta> in the key definition, then they are used to provide the content for the same elements with @keyref. For example, I think that in the following code sample of a keyref and a keydef, resolving keyref should pull in "My Name Here, JR".
<author keyref="justME"/>
...
<keydef keys="justME" href="">
<topicmeta>
<author>My Name Here, JR</author>
</topicmeta>
</keydef>
I think (but am not sure) that this is the correct interpretation of the following line in the DITA 1.2 spec: "When a key definition has a <topicmeta> subelement, elements that refer to that key and that are empty may get their effective content from the first matching subelement of the <topicmeta> subelement of the key-defining topicref." I've left it out until others confirm. Also need to verify where in the priority list this comes.
In the micro review, both Eliot and Chris agreed with my interpretation, but we need to determine where in the priority list the rule goes.
Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit (http://www.dita-ot.org/)
[Date Prev]
| [Thread Prev]
| [Thread Next]
| [Date Next]
--
[Date Index]
| [Thread Index]
| [List Home]