[TYPO3] Documentation nightmare

[Andreas Becker]

Hi all just came into my mind!

The Bible is well known since it has been translated into many languages and
also since the printingpress has been invented.
TYPO3 could improve and spread its usability as THE CMS as soon as we will
use a tool which will allow us to translate docs and to puiblish them in
different Levels and Languages.

Best of all : We already HAVE THIS TOOL!!!

USE TYPO3
it provides workspaces
it provides versioning
it provides multiple language
it provides one of the best user managements
it can read/import OO/Word/PDF
it has a realtext Editor with lots of features
It provides a much better way then google docs or another tool to insert
CODE examples
can create PDF
it can be printed as a complete BOOK (EXT:pipeline)
an online Version and a printed Version could be combined in One Tree.
Parts of "Translations" could be reused for several Levels

Let's take an Example Page Tree

THE TYPO3 BOOK
--- Introduction
--- Requirements
--- ...
--- Extension xyz
------- Chapter 1
----------- Subchapter 1.1
------------------ Page 1.1.1
------------------ Page 1.1.2
----------- Subchapter 1.2
------- Chapter 2

We create FIXED SIZE Pages which means a page can't be bigger then A4. i.e.
use CSS-overflow.
What doesn't fit on a page needs to be put on a subpage

Instead of using only translations english/german/russian/chinese/arabic/...
we add additional special LEVELS to each Language

English-Newbie
English-Advanced
English-Expert
English-Editor
Deutsch-Einsteiger
Deutsch-Fortgeschritter
Deutsch-Experte
Deutsch-Editor
...
...

Using the abilities of TYPO3 we can now create an ENGLISH All Inclusive
Version (default-Translation) -
Out of this All Inclusive Version those Parts get extracted which are only
ment for i.e editors or experts.
i.e. check a box and this element will be shown also in the Editor and
Expert "Translation"

Using the pagewizard (typoheads) we could create a DEMO structure (i.e. the
one from Peter) and each Extension Developer (Who only would be allowed to
edit his extension Branch) could easily copy and paste, then fill out this
given structure.
CSS would determine the general Look and Feel of our ONLINE and PUBLISHED
TYPO3 Book

Many many people could collaborate here without any problems.
We could use workspaces and a Chief Editor would be allowed to publish.
Each PAGE could be translated very easily using the TYPO3 abilities.

i.e. I need some editor related stuff translated from tt_news - so I
translate it into German (using Workspace) - And/Or I mail my translation to
the responsible German Language Manager of the Tutorial after I translated
it. He will check and add it into the right page (workspace draft mode) The
Chief-Editor will counter check if format is OK and if "yes" publish the
document.

Even better:
i.e.
Wouldn't it be nice if we could give our customers a Handbook and don't need
to rewrite and extract this Book everytime from several resources? They in
General would only need the EDITOR (Translation in their Language =
LANGUAGE-EDITOR).

I choose i.e. DEUTSCH-EDITOR (Translation) and now all available Pages will
show up which have already been translated. i.e. I will see that some parts
are missing therefore I need to translate a bit. This translation will be
send to the German Coordinator which will ad it after checking to the right
Page.

The Translations Part will grow bigger and bigger if many people would
collaborate here.

Next step would be to Check the DEUTSCH-EDITOR (Translation) and those
Branches/Pages we want to have in our Manual for the Customer and we Exclude
perhaps several other pages we don't want to have them in. i.e. Like the
Drodown Sitemap we create also a sitemap which we will use as and INDEX.
Using pipeline I would now printout an individual Manual for this specific
customer which contains only the related stuff for Editors. Perhaps (for
sure) we would find even a way to put company and developer details inside
this book and also the Licence (must be)

Beside a nice TYPO3 Page the customer would now receive also a nice manual
and a HowTo to work with his Site.
In this document he would have also all links to LIVE Material in the Live
Tutorial. Especially when using TemplaVoila we could create here nice
settings and Layout Sets - Like in a Newspaper/Magazine/Technical Book Style

----------------------

IMHO TYPO3 itself would be perhaps the best TOOL of all those we mentioned
already above as TYPO3 is really GOOD and provides things we can't do in its
complexity with NONE of the above mentioned online Tools - nor with a wiki.

Perhaps we are sitting in a similar trap like the people from redmine. They
have also a discussion going on why redmine is not using redmine to manage
redmine stuff as it would be really the best way.

It is perhaps the same with us at TYPO3. We are so much TYPO3 TYPO3 that we
can't see even TYPO3 and it's abilities and potentials. No editor would need
to learn anything as we all work already with TYPO3. ;-) "Man sieht den Wald
vor lauter Baeumen nicht" "Das Glueck steht direkt vor unserer Haustuere"
sorry don't know an English one.

-----------------------

Andi