RE: [dita] Example of how keys are resolved

["Kristen Eberlein" <keberlein@sdl.com>]

I think we need a plan on how to push this clarification out. Here are my
suggestions:

1) Check that we are agreed on this technical point.
2) Is the content in the "Example of how keys are resolved" e-mail
sufficiently clear? If yes, let's get the information out.
3) Determine how to make the content available. Possible mechanisms include
the following:
	* PDF file in document repository
      * Wiki page -- either OASIS DITA Wiki or dita.xml.org
4) Publicize clarification on TC list and dita-users

Longer-term work includes rewriting the relevant topics in the DITA 1.2 spec.
Does someone want to volunteer to draft a revision?


Best regards,

Kris
Kristen James Eberlein l DITA Architect and Technical Specialist l SDL
Structured Content Technologies Division l (t) + 1 (919) 682-2290 l
keberlein@sdl.com

www.sdl.com/innovate
Please consider the environment before printing this e-mail

-----Original Message-----
From: Eliot Kimber [mailto:ekimber@reallysi.com] 
Sent: Friday, January 28, 2011 9:20 AM
To: Kristen Eberlein; dita
Subject: Re: [dita] Example of how keys are resolved

Yes, that is correct.

Cheers,

E.

On 1/28/11 8:08 AM, "Kristen Eberlein" <keberlein@sdl.com> wrote:

> I want to wrap up the various e-mails on this thread. Is the following an
> accurate example of how keys are resolved?
>  
> Example 
> Assume that each map contains a different definition for the  key named
> product.
>  
> Contents of root map
> <?xml version="1.0" encoding="UTF-8"?>
> <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
> <map title="Example of how keys resolve">
>     <mapref href="map-one.ditamap"/>
>     <mapref href="map-two.ditamap"/>
>     <topicref href=²stuff.dita²>
>           <topicref href="widget-A.dita" keys="product"/>
>     </topicref>
>     <topicref href=²widget-C.dita² keys=²product² />
> </map>
>  
> Content of map-one.ditamap
> <?xml version="1.0" encoding="UTF-8"?>
> <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
> <map title="Submap one">
>     <mapref href="map-three.ditamap"/>
>     <keydef keys=²product² href=²widget-B.dita²/>
> </map>
> Order in which keys take precedence
> 1.     First key definition in the root map in document order. In this
> example, the key product is bound to widget-A.dita.
> 
> 2.     First key definition in map-one.ditamap.
> 
> 3.     First key definition in map-two.ditamap
> 
> 4.     First key definition in map-three.ditamap
> 
> Basic principles
> ·         Within an individual DITA map, keys are resolved in document
order.
> 
> ·         When a root map contains sub maps, the maps are handled in
> breadth-first order.
> 
> Best regards,
> Kris
> Kristen James Eberlein l DITA Architect and Technical Specialist l SDL
> Structured Content Technologies Division l (t) + 1 (919) 682-2290 l
> keberlein@sdl.com <mailto:keberlein@sdl.com>
>   <http://www.sdl.com/>
> Please consider the environment before printing this e-mail
>  

-- 
Eliot Kimber
Senior Solutions Architect
"Bringing Strategy, Content, and Technology Together"
Main: 512.554.9368
www.reallysi.com
www.rsuitecms.com