[Typo3-doc] Glossary status 9 Nov 2004

Rainer Suthoelder t3 at 1zu6-design.de
Tue Nov 9 23:40:26 CET 2004


> ....and Peter answered your question. Have a look again.

jupp, found peter's remark.

and i totally disagree with it =:o)

the whole glossary thing currently in the wiki resulted from an email from
me to kasper, stating that - whilst doing the translation of the german
SH  - i would have really loved to have a glossary to add terms and
definitions. kasper replied that he thought of such an extension and posted
his glossary database draft to the wiki owner to be presented on the wiki.
the completed database then would go back to kasper to have a base for the
llxmllang translation tool (to get localized glossary entries) and for a
future glossary extension (which still needs to be written by kasper).

during the email discussion we both agreed that by nature there will be a
lot of redundant keywords even though not all keywords will be explained but
referenced by only one term - a good example is "CSS" and "Cascading Style
Sheet". take any good computer book (especially those from Addison Wesley)
and you would find this "redundant" entry, linking/referring "CSS" to the
"Cascding Style Sheet" entry.

and this is how i would think t3-users to use the glossary: what the heck is
CSS? => look in the glossary extension => click on letter C => scroll down
to CSS => linked reference to the full text entry => click, voila:
explanation of the term...
this way, the glossary would be suited for crossmedia publishing (especially
printing the whole thing!!!)

within this thread there is a post of JoH who states that the glossary
should be controlled (i agree!) and that you should use professional
software for documentation (and not the wiki) to achieve this.
well, at least for the glossary, even typo3 is not a good tool. from my
previous documentation work, a really good and professional solution is
TeX/LaTeX in combination with its bibliography and glossary enhancements
(packages)... but that is a bit of topic for the wiki and perhaps only
interesting for the guys writing the typo3 book.

so in general, i repeat myself from my previous postings: all documentation
work should be ____focused on the target group, that is the user____ - and
if that includes redundancy, so may it be.

m2c

rainer





More information about the TYPO3-project-documentation mailing list