TYPO3 Blog -> Blog -> TYPO3 Extension Programmierung -> Handbuch für eigene Extension schreiben.

Werbung finanziert TYPO3 Blog

Wenn man eine eigene TYPO3 Extension zur Veröffentlichung bringen möchte, sollte ein Handbuch auf keinen fall fehlen und dieses Handbuch muss natürlich in der TYPO3 Standartsprache englisch verfasst sein.

Eine Vorlage zur Erzeugung eines TYPO3 Extension Benutzerhandbuchs kann man hier herunterladen: Handbuchschablone.

Das TYPO3 Benutzerhandbuch muss mit Open Office bearbeitet werden. Hier kann man kostenlos Open Office herunterladen.

TYPO3 Extension Handbuch Metadaten eingeben

Datei->Eigenschaften Manual Eigenschaften anpassen

Zunächst sollte man über Datei->Eigenschaften die Eigenschaften des Manuals anpassen. Hier können der Key der Extesnion, dessen Namen und Extensions vergeben werden. Zusätzlich können dem Manual Keywords zu geordnet und Angaben zum Autor der Extension gemacht werden. 

Texte Anpassen

Zur Organisation seiner Extension kann man meist sehr gut den vorbereiteten Kapiteln folgen. Nicht benötigte Kapitel sollten gelöscht werden, es ist auch möglich, weitere Kapitel hinzuzufügen.

Die Kapitel werden jeweils durch H2-Überschriften definiert. Um einen Text zur Überschift zu machen einfach den Text markieren und oben in der Symbolleiste "Überschrift 2" auswählen.

 

Bild nur über "Inhalte einfügen" einfügen

Bilder einfügen

Um ein Bild einzufügen sollte man das entsprechendes Bild zum Beispiel in Photoshop (kostenpflichtig) oder GIMP (kostenlos) in die Zwischenablage kopieren. Wichtig: Das Bild nicht einfach einfügen! Stattdessen über bearbeiten -> Inhalte einfügen gehen und dann "Bitmap" auswählen.

 

Blog,

Eine Antwort zu “Handbuch für eigene Extension schreiben.”

Danke

Gravatar: Michael Fritz
Kann ich grad gut gebrauchen, Kollegin :-)

Mein Kommentar

Notify me when someone adds another comment to this post