[TYPO3-doc] DocBook: creating an example

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


Hey everybody,

I'd propose that I will create an example in the following weeks,
including the following:

- (at least) two documents, referencing each other
- each document should be available in (at least) 2 languages (so we can
test the translation)
- each document should be available in (at least) 2 versions (so we can
test the crosslinking).

For now, I would like to do it in the following way:
- 1 git repository per manual, using branches, tags, ...
- Translation using pootle
- olinks for crosslinking

Reason: I feel that I need a "reality check" of the ideas I proposed in
the last days -- I just need to see how it feels "in real life". It
seems at some points we all agree on some common ideas, at other points
we disagree (one git repo vs multiple ones, olinks vs xlinks for
official docs). And in my opinion it is really difficult to decide for
one or another solution without seeing it in real life, and testing.

The reason why I want to make the above design decisions for building a
prototype:
- it's clearly the most complex setup, but also the most flexible one
-> to decide if the above setup has drawbacks, we need to build it and
play with it.
- one repository per FLOW3 Package is something we've made really good
experiences with in the FLOW3 team; I'd like to see how this feels with
documentation.

Do you think that's a good idea? When we have this prototype we can have
a more solid discussion on our solution.

Greets,
Sebastian
PS: I hope I can start working on this next week, or the week after. So
expect something from me in the next two weeks :-)


More information about the TYPO3-project-documentation mailing list