[TYPO3-doc] DocBook: XML IDs

[François Suter]

Hi all,

Sorry for the long silence, the DocBook project is not dead ;-)

I'm picking up this topic of IDs again, as they are several things to solve.

First of all we have to make a decision about whether we use olinks or 
not. Tom, our visiting DocBook specialist, has strongly advised against 
them so I would tend to follow his advice, but I must say that the whole 
topic is not entirely clear in my head. The advantage of olinks would be 
shorter IDs - as highlighted by Sebastian in previous thread - moving from:

ID of Book: typo3v4.core.tsref
typo3v4.core.tsref.function.stdWrap.setContentToCurrent

to:

ID of Book: typo3v4.core.tsref
function.stdWrap.setContentToCurrent

but it is apparently harder to create links, which could be bad for 
contributors.

What are the opinions on the topic?

Second issue with IDs: for each manual we will have several versions and 
several translations (hopefully ;-) ). Since IDs should not change 
across versions nor languages, it means that - depending on the file 
structure we have - the same ID could appear several times within the 
same file structure. I'm not sure what impact this can have for a) 
editors, b) the rendering process. Of course the structure an editor 
works on needs not be the same as the structure the rendering scripts 
will run on, but I think it's something we need to take into serious 
consideration to avoid wrong links.

What do you think?

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch