OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: RE: [dita] Question: Definition of "undefined key"

Hi everyone,

I think we're going to need a FAQ item about what the definition of
"undefined key" is. 

Eliot, after re-reading your response I am not sure if you are saying
that case 3 would be considered an undefined key. In case 3, obviously
the keyref can't be resolved, but are you saying that this should be
treated as it can't be resolved in spite of there being a defined key,
or are you saying that it should be treated as an undefined key?

The fourth paragraph in this topic:
ess_dita_elements.html implies that "undefined key name" and "key
reference cannot be resolved to a resource" are distinct cases. I am not
sure if the spec intends "undefined key" and "undefined key name" to
mean the same thing.

I don't have time to take the lead in sorting out this issue. Can anyone
else volunteer to draft an FAQ item?


-----Original Message-----
From: Su-Laine Yeo 
Sent: Thursday, April 28, 2011 10:53 AM
To: dita
Subject: RE: [dita] Question: Definition of "undefined key"

Thanks Eliot. What if you have:

 <keydef keys="topic1" href="topic1.dita">

Then in case 2 and 3, are the keys still considered undefined? This part
of the spec:
tml#overview_of_keys seems to say that the key would be considered
defined because it is bound to topicmeta. Is that the intention?


-----Original Message-----
From: Eliot Kimber [mailto:ekimber@reallysi.com] 
Sent: Wednesday, April 27, 2011 6:13 AM
To: Su-Laine Yeo; dita
Subject: Re: [dita] Question: Definition of "undefined key"

An "undefined" key is a key name for which no binding is effective.

In the case of the key "topic1", the key is defined but it's resource
not and there is no other content in the topicref, so there is no
bound to the key.

In that case, the fallback rules for unresolvable keys applies.

That is, there are three ways that key references can fail to resolve to

1. There is no effective binding for the key at all.

2. There is a binding for the key but the resource to which it is bound
cannot be accessed.

3. Where the key reference includes an element ID component, if the key
reference can be resolved (that is, the key component of a
pair) but the specified element isn't there, then the key reference is

If this isn't clear from the spec as written then we definitely need to
it clearer because it's fundamental to the key mechanism.



On 4/26/11 3:05 PM, "Su-Laine Yeo" <su-laine.yeo@justsystems.com> wrote:

> Hi everyone,
> One more question on the "Processing key references" topic here:
> s.html 
> es.html> 
> It says, "If a referencing element contains a key reference with an
> key, it is processed as if there were no key reference".  What does
> key" mean? For example, say you have:
> <map>
> <keydef keys="topic1" href="topic1.dita"/>
> </map>
> <topic>
> S
> <xref keyref="topic1/para1" href="topic2.dita#topic2/para2"></xref>
> S
> </topic1>
> Case 1) If the topic1.dita file cannot be found, does the xref have an
> undefined key?
> Case 2) If the topic1.dita file does not contain an element with
> does the xref have an undefined key?
> If an xref is considered to have an undefined key, the href will be
used. If
> it is not considered to have an undefined key, the processor should
> treat it as an error condition.
> Su-Laine
> Su-Laine Yeo
> Solutions Consultant
> JustSystems Canada, Inc.
> Office: 1 (778) 327-6356
> syeo@justsystems.com <mailto:syeo@justsystems.com>
> XMetaL Community Forums: http://forums.xmetal.com
> For partners only: http://www.justpartnercenter.com

Eliot Kimber
Senior Solutions Architect
"Bringing Strategy, Content, and Technology Together"
Main: 512.554.9368

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]