[TYPO3-german] Typo3.org: Dokumentation nur auf Englisch
Daniela Waranie
typo3-community at gmx.de
Mon May 4 11:39:08 CEST 2009
Hallo Georg,
> Wenns von mir stammt, macht das ja auch keinen Sinn, schreiben muss ichs
> sowieso, da hab ich lieber nur 1 Stelle, die zum Pflegen ist als ich
> teil das in 2.
Genau dieses Pflegen der Dokumentation an 2 oder mehr Stellen macht es
für die Authoren und die Leser schwieriger und sollte daher vermieden
werden (meine Meinung).
> Wenns von wem anderen kommt - und man von einer aktiven Extension mal
> ausgeht - dann macht das wiederum auch wenig Sinn, das nicht in die
> nächste Version aufzunehmen (bzw dafür eine neue Version zu releasen).
Für die eigene Extension ein neues Release zu machen nur weil sich in
der Doku 3 Worte geändert haben ist wirklich schlecht, da die
Release-Version sich zwar auf das "Gesamtkunstwerk" (die Extension)
bezieht, die Release-Nummer jedoch von der Allgemeinheit jedoch stehts
auf den Code bezogen wird.
Dieses zu trennen in 'Extensionkey für Code' und 'Extensionkey für
Dokumentation' ist der Weg, der von einigen praktiziert wird, vor allem,
wenn es um eine Extension geht, wo man nicht der Author ist und man
nicht mit der Veröffentlichung auf den Extension-Author warten möchte
(weil der z.B. schon 'gestorben' oder einfach nur inaktiv ist). Diesen
Weg finde ich absolut schlecht (!), mit jedem neuen Author (der inaktiv
wird) käme ein neuer Extensionkey 'ins Spiel'.
Aus diesem Grund bin ich der Meinung:
Alle Dokumentation in die Wiki. Die Dokumentation aus der Wiki
exportieren (als PDF, meinet Wegen auch als SXW) und als Datei-Download
im TER anbieten. Im TER sollte natürlich auch ein Link auf die
Online-Version der Dokumentation (Wiki) verlinkt sein.
Der 'Text Editor' der bei der Wikipedia Software verwendet werden kann
ist zwar kein WYSIWYG-Editor, aber im dem WIKI-Tags braucht man sicht
jedoch nicht beschäftigen, da durch markieren des Textes und drücken der
'Text Editor'-Buttons über der Textarea leicht Formatierungen
vorgenommen werden können. Du kannst natürlich auch einen externen
Editor für die Textareas benutzen oder direkt in deinem Browser ein
plugin installieren. Siehe auch folgende Seite, Punkt 1.1 und 1.2:
http://en.wikipedia.org/wiki/Wikipedia:Syntax_highlighting
Lieben Gruß
Daniela Waranie
More information about the TYPO3-german
mailing list