xrefs outside the map topics

["Jim Tivy" <jimt@bluestream.com>]

Hi Folks

 

I am unsure on what the Dita 1.3 spec is recommending on this use case.

 

UseCase:

In the context of a CMS there are often multiple books within a product version and multiple product versions within multiple products.  In this sea of content there has to be some checks and constraints to help authors find appropriate content.  As well, authors may in one case publish a set of books as one large book of HTML topics and in other situations just publish each of the books in a single PDF publish. 

What does DITA recommend with respect to xrefs that can potentially reference topics outside the topics explicitly listed in a given map.  For example:

- I insert an xref element into TopicA.dita with scope=”local” and the href references TopicB.dita.

- I have a simple root map MyDoc.ditamap with only one topicref that references TopicA.dita”.

Now I wish to publish HTML for MyDoc.ditamap.

Should the reference from TopicA to TopicB be considered an error, warning or fully allowed by a processor.  Is there special consideration for TopicB because it is not in MyDoc.ditamap?

 

I realize the best practice is not to use an xref but rather use a relationship table or a key.  But if someone uses an xref for the TopicA--->TopicB reference what does the spec recommend?

- Should or Must a processor produce a warning or error?

- Is there a particular part of the 1.3 spec that deals with a recommended treatment of this use case above.  I see references in the scope attribute that refer to the setting of “local” or “peer” according to the “current set” and “current information set” – but is there something else that addresses this situation or defines what  current information set means.

- As a side note there seems to be a few different terms used in the spec: information set, current set, current information set, information unit – perhaps a definition of “information set” would help us in the future.

 

cheers

Jim Tivy - Bluestream