Re: [dita] Proposal: Allow <xref> within <shortdesc>

[Kristen James Eberlein <kris@eberleinconsulting.com>]

Although I support making <cite> available in <shortdesc>, I'm not in support of allowing <xref> in <shortdesc>.

The minutes for last week's meeting indicate the following rationales for this change:

Eliot: DITA should have the fewest constraints as possible.
Michael P.: Since DITA 1.2, processors have had to deal with keyrefs, so the "no links" position is already compromised.

These two positions consider the needs of the following communities:

• Architects and practitioners who create specializations for their users
• Vendors who build processors

I think we also need to think of the needs of the end users who author using the OOB DITA DTDs and XSDs. DITA's design means that we already have lots of elements and attributes available in places where they simply don't make sense. Why add another one?

Given the role of the <shortdesc> for hover text and auto-generated link text, I think adding <xref> is inappropriate.

-- 
Best,
 
Kris
 
Kristen James Eberlein
Principal consultant, Eberlein Consulting
Co-chair, OASIS DITA Technical Committee
Charter member, OASIS DITA Adoption Committee
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

On 9/4/2012 11:25 AM, Eliot Kimber wrote:

Given the decision to allow <cite> within <shortdesc> and the fact that you
can already have <keyword>, <term>, and <ph> that act as xrefs within
shortdesc, it is reasonable to also allow <xref> within <shortdesc>.

Processors that use <shortdesc> as the source for constrained display text
such as hover help for links must already, as of 1.2, handle the case where
the shortdesc text may have hyperlinks in it. Adding <xref> does not
significantly change the inherent processing requirements.

The specific content model change would be to add %xref; to the content
model for <shortdesc>.

I did not identify the need for any changes to the specification text for
<shortdesc>.

Cheers,

Eliot 

-- 
Best,
 
Kris
 
Kristen James Eberlein
Principal consultant, Eberlein Consulting
Co-chair, OASIS DITA Technical Committee
Charter member, OASIS DITA Adoption Committee
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)