← Prev in month ← Prev in thread
Next in thread → Next in month →

RE: [dita] FW: [dita-comment] Misleading example in anchorref attributedescription of DITA 1.1 langspec

From
Michael Priestley <>
Date
2009-07-30T19:11:15+00:00
ID
Thread
RE: [dita] FW: [dita-comment] Misleading example in anchorref attributedescription of DITA 1.1 langspec
I think it's just pointing out a typo
in the current addressing example, and suggesting that providing an example
that shows what would result in the case of Eclipse output (which is as
far as I know the only output that uses this feature) would be useful.

Because she's coming from the Eclipse
user perspective, she's giving us the benefit of the doubt and assuming
that maybe the syntax works for other outputs. But in fact the syntax is
just wrong as currently given.

map1.ditamap/a is not correct syntax.
She's right that it should be ma1.ditamap#a

Not sure if we need to include an Eclipse
example once we fix the syntax. The coding won't be different for other
formats, we just t7poed the syntax.

Michael Priestley, Senior Technical
Staff Member (STSM)

Lead IBM DITA Architect 



http://dita.xml.org/blog/25

"Grosso, Paul"
<> 

07/30/2009 03:03 PM

To

"DITA TC" <>

cc

Subject

RE: [dita] FW: [dita-comment] Misleading
example in anchorref attribute description of DITA 1.1 langspec

I don't quite follow this,
but it sounds like Lee is suggesting that anchorref values need to be authored
differently for Eclipse output than for other outputs.  If I am reading
that correctly, that cannot be the case.  There should be no need
for authors to author things differently for different outputs, and the
DITA spec should certainly not change how URI references work for different
outputs.

 

I look forward to having
this explained more clearly to me.

 

paul

 

 

From: Gershon Joseph (gerjosep) [mailto:]

Sent: Thursday, 2009 July 30 13:59

To: Robert D Anderson

Cc: DITA TC

Subject: [dita] FW: [dita-comment] Misleading example in anchorref
attribute description of DITA 1.1 langspec

 

Hi Robert,

 

Can we address this as part
of the current DITA 1.2 spec draft 2 preps?

 

Hope you're feeling better.

 

Regards,

Gershon

 

From: Lee Anne Kowalski [mailto:]

Sent: Wednesday, July 29, 2009 6:59 PM

To: 

Subject: [dita-comment] Misleading example in anchorref attribute description
of DITA 1.1 langspec

Hello,

I am assuming that the dita-comment list is the appropriate way to raise
this type of item. If it is not, please let me know.

On the following page of the DITA 1.1 language spec posted at OASIS:

http://docs.oasis-open.org/dita/v1.1/CD01/langspec/langref/map.html

The anchorref example in the sentence starting "For example,"
is misleading for Eclipse navigation integration. The example code shown
as anchorref="map1.ditamap/a1" does not work in the Eclipse help
navigation at Eclipse runtime.

If I change the anchorref code to be:

anchorref="../map1_id/map1.ditamap#a1"

Then the example will work for a map1.ditamap that has a map element with
id attribute, id="map1_id".

At the very least, the slash shown in front of the a1 should be changed
to a hash (#) for that coding to work in the Eclipse help navigation.

A simple fix might be to add a sentence that states clearly an anchorref
example for Eclipse help, in contrast to an example for other runtime formats.

This item has caused confusion for at least two teams that I am aware of,
and has affected their productivity. Updating the example in the page on
the web site would be a huge help to us.

Sincerely,

Lee Anne Kowalski
← Prev in month ← Prev in thread
Next in thread → Next in month →