[TYPO3-doc] DocBook: Miscellaneous

Sebastian Kurfürst sebastian at typo3.org
Wed Apr 27 06:56:47 CEST 2011


Hey Thomas,

> Maybe I've misunderstood something, but I'm not sure if this is useful. To 
> make it fly you need some important prerequisites:
>
> - No XML source can be shared between other books
Hm; I'd use an approach as outlined in
http://www.sagehill.net/docbookxsl/ModularDoc.html#XIncludesCatalogs
we have a custom catalog in our build process anyway, and all "common"
texts (like introductionary texts, a description of TYPO3, ...) could be
included using this technique.

I don't see yet that other texts like Images, chapters, ... should be
shared in between books. Rather, a crosslink should be done in this case.

> - Linking between books become difficult, even impossible
Using olinks, that would not be a problem. Would it? :-)

I imagine the following: All documents (books, guides, ...) *need to be
aware of their place in the output hierarchy*, i.e. they need to know
where in the output they will be located. For this output hierarchy, we
can automatically generate a Sitemap file (used for olinks), and by
that, you can link to other books.

> I'm not a Git expert so maybe there is some Git magic which makes it possible 
> to mix and match different repositories. However, I'm not aware of any.
That's also possible, using "Git Submodules" -- however it has some
smaller drawbacks, as you can only point to specific revisions inside a
submodule. But I think we would only need this as convenience for
editors (so they would not have to check out 100 separate git
repositories); and the rendering pipeline would not need this.

I'm eager to hear your feedback!

Greets,
Sebastian


More information about the TYPO3-project-documentation mailing list