[TYPO3-doc] DocBook: XML IDs // Linking between documents

Sebastian Kurfürst sebastian at typo3.org
Fri Apr 29 08:14:27 CEST 2011


Hey François,
> There's yet another possibility (raised by Tom a good while earlier):
> the current issue with linking to a particular point in the
> documentation is that the parts are number with a scheme that changes
> more or less all the time. With the documentation coming from DocBook
> this would not happen as long as the IDs don't change. This means that
> manual writers could safely use simple links to the HTML documentation.
That'd definitely be a possibility. However, it's not that easy:
- all links would point to documentation.typo3.org -- not being relative
links. If we had a global document hierarchy, we could use relative
links automatically.
- You should not need to point to a specific version or language;
instead the language of the current document should be used; and the
most up-to-date version.
- As we use chunking (multiple HTML documents for 1 docbook document),
depending on the chunking settings, the URLs can change.

Example: If we had:
<book xml:id="b1"><title>Booktitle</title>
  <section xml:id="s1"><title>Section 1</title>
     <section xml:id="s2"> <title>Section 1.1</title></section>
  </section>
</book>
If we chunk after a 1st level section, and we'd like to reference "s2",
this would look like:
b1/s1.html#s2

Now, if we change the chunking settings for this document (f.e. because
we say the reading experience is difficult), so chunking should happen
on level 2, we'd have the following URL now:
b1/s2.html

To me this sounds like pretty awkward and unstable.

As always -- curious what you think :)

Greets,
Sebastian


More information about the TYPO3-project-documentation mailing list