FW: [dita] proposal for DITA 1.3: same document/same topic DITA reference syntax

From: Erik Hennum
[mailto:]

Sent: Wednesday, September 10,
2008 11:58 AM

To: Ogden, Jeff

Subject: RE: [dita] proposal for
DITA 1.3: same document/same topic DITA reference syntax



 

Hi, Jeff:


That makes sense -- thanks for clarifying.



Erik Hennum





"Ogden,
Jeff" ---09/10/2008 08:36:14 AM---When Paul and I first talked about this
I suggested using “#/elementid”, but we came to the conclusion that having
something


 
  
  

  From:
  
  
  

  "Ogden,
  Jeff" <>
  
 
 
  
  

  To:
  
  
  

  Erik
  Hennum/Oakland/IBM@IBMUS
  
 
 
  
  

  Date:
  
  
  

  09/10/2008 08:36 AM
  
 
 
  
  

  Subject:
  
  
  

  RE: [dita] proposal
  for DITA 1.3: same document/same topic DITA reference syntax
  
 












When Paul and I first talked about this I suggested using “#/elementid”, but we came to the conclusion that
having something explicit like a dot as part of the syntax would be better. It
gives people something to see and it gives us something to talk about in
documentation. Talking about something that isn’t there is sometimes awkward.


-Jeff







From: Erik Hennum [mailto:]


Sent: Wednesday, September 10, 2008 10:33 AM

To: Ogden, Jeff

Subject: Re: [dita] proposal for DITA 1.3: same document/same topic
DITA reference syntax

Hi, Jeff:


Do you need the . ? As in


<link href="#"/>

<xref href="#/sectionID"/>



Cheers,



Erik Hennum





"Ogden,
Jeff" ---09/09/2008 07:10:14 PM---Here is a proposal for DITA 1.3 or
whatever comes after DITA 1.2. Not sure if this would be proposed feature
#13001 or not. 


 
  
  

  From:
  
  
  

  "Ogden, Jeff" <>
  
 
 
  
  

  To:
  
  
  

  <>
  
 
 
  
  

  Date:
  
  
  

  09/09/2008 07:10 PM
  
 
 
  
  

  Subject:
  
  
  

  [dita] proposal for DITA 1.3: same document/same topic DITA reference syntax
  
 















Here is a proposal for DITA 1.3 or whatever comes after DITA 1.2. Not sure if
this would be proposed feature #13001 or not.



Paul Grosso and I would like the DITA TC to consider defining a syntax for same
document/same topic references in DITA 1.3.



The DITA Specification currently defines a syntax that provides for same
document references in topics and maps:



#mapelementid

#topicid

#topicid/elementid



A suggested syntax for same document/same topic references is:



#. (pound-sign dot
forward-slash)

#./elementid (pound-sign
dot forward-slash elementid)



Where . (dot)
represents the id of the current topic.



This syntax is only used for same document topic references. It is an error to
use this syntax when a path or filename is given or for a same document map
reference.



The uses for a same document/same topic reference syntax are similar to the
uses for the existing same document reference syntax. The syntax allows
sections of DITA markup that include URI references to be written in a
self-contained location independent fashion. The markup could be moved from or
included from one topic document to another using copy and past, content
references, xincludes, entities, or other means without the need to adjust the
URI reference to include the id of the topic at the target location.