Redaktionelle Richtlinien
Aus TYPO3 Extensions Index (T3X)
Inhaltsverzeichnis |
Allgemeines
Das T3X-Wiki orientiert sich im weitesten Sinn an den Richtlinien der Wikipedia: Inhalte sollen neutral, relevant und kompakt sein. Bewertungen und Kritik sind erlaubt, müssen aber begründet und belegt werden und sollen so objektiv und fair wie möglich sein.
Aufbau
Jede Extension wird nach folgendem Muster beschrieben:
Seitentitel
Der Seitentitel entspricht dem offizieller Extension Key (Kleinschreibung, inkl. Underscores - z.B. tt_news).
Beschreibung
Kurze Beschreibung der Extension (Funktionalität, Bedeutung, Besonderheiten - keine erschöpfenden Feature-Listen). Idealerweise ein selbst erstellter Text, im Sinne einer Übergangslösung sind aber auch Zitate aus anderen Quellen zulässig (immer mit Quellenangabe).
Folgende Zitate werden dabei mit einem Untertitel gekennzeichnet:
- TER Description = Kurztext aus dem TER
- What does it do? = Text aus dem entsprechenden Abschnitt des Manuals (ggf. gekürzt)
- README.txt = Text aus der gleichnamigen Datei (im Lieferumfang der Extension)
Das erste Vorkommen des offiziellen Extension-Namens in der Beschreibung wird fett ausgezeichnet.
Screenshots
Screenshots von Frontend und Backend, die möglichst gut die Funktionalität zeigen. Die Screenhots werden nicht 1:1, sondern als Gallery eingefügt:
<gallery> Bild:dateiname1.gif|Bildlegende 1 Bild:dateiname2.gif|Bildlegende 2 </gallery>
Literatur
Hinweise auf Erwähnungen in Fachbüchern, Zeitschriften u.ä.
Verweise auf Fachbücher: Standardwerke werden als eigene Wiki-Seiten angelegt, damit man einfach darauf verweisen kann. Die Seitentitel haben die Form <1. Autor> <Erscheinungsjahr>, also beispielsweise Bielitza 2007.
Links
Der erste Link ist - sofern vorhanden - der Direkt-Link auf die aktuelle Version der Extension im TYPO3 Extension Repository (TER). Hierfür muss lediglich die folgende Vorlage eingefügt werden:
{{TER}}
Der zweite Link ist - sofern vorhanden - der Direkt-Link auf die zugehörige Seite der TYPO3 Forge. Hierfür muss lediglich die folgende Vorlage eingefügt werden:
{{Forge}}
Der dritte Link ist - sofern vorhanden - die offizielle Homepage einer Extension.
Die weiteren Links werden unten angefügt und mit einem kurzen, vorangestellten Stichwort beschrieben, z.B.:
* Demo: http://www.mydemoworld.com/this_extension_demo.html
Siehe auch
Wiki-interne Links auf andere Extensions, welche ähnliche Zwecke erfüllen oder sonst in einem Zusammenhang stehen. Soweit sinnvoll soll dieser Zusammenhang in Stichworten angegeben werden. Typischerweise werden diese Querverweise in die Abschnitte "Erweiterungen" und "Alternativen" unterteilt.
Kategorien
Kategorisierung gemäss T3X-Klassifikationssystem
Jede Wiki-Seite, die eine Extension beschreibt, wird zudem mit der Kategorie "Alle Extensions" gekennzeichnet:
[[Kategorie:Alle Extensions]]
Zu vermeiden
Der TYPO3 Extension Index soll ein knappes Verzeichnis von möglichst vielen Extensions sein, das der raschen Information dient. Nicht in dieses Wiki gehören:
- Installationsanleitungen
- Tutorials
- Kopien der offiziellen Dokumentationen
Stati
Das TYPO3 Extension Repository (TER) kennt fünf verschiedene Stati für Extensions. Im TYPO3 Extensions Index werden die folgenden beiden Stati ebenfalls erfasst:
Die folgenden Stati werden hingegen im TYPO3 Extensions Index nicht angezeigt, sie rasch ändern können und von den Entwicklern oft unterschiedlich gehandhabt werden:
Vorlagen
Für die effiziente und konsistente Erfassung der Extensions stehen folgende Vorlage zur Verfügung:
