Hilfe:Inhaltsverzeichnis

Aus Contao Community Documentation

Verfassen von Artikeln

Vor dem Verfassen eines neuen Artikels sollte kontrolliert werden, ob schon ein Artikel zum gleichen Thema existiert. Dies kann über die Suchfunktion oder über die Auflistung aller existierender Seiten geprüft werden. Vor dem Abspeichern eines Artikels sollte man den Artikel mit der Vorschau-Funktion auf event. Rechtschreibfehler o.ä. prüfen.

Artikel sollten neutral und allgemein verfasst werden (als Beispiel nicht "Ich betrachte die Seite" oder "Du betrachtest die Seite", sondern "Man betrachtet die Seite"), um eine Vereinheitlichung der Artikel zu gewährleisten.

Wichtig: Angabe der Contao-Version

Da sich Contao ständig weiter entwickelt, ändert sich auch laufend der Quellcode. Daher ist es beim Verfassen von Artikeln wichtig, immer mit anzugeben, auf welche Contao-Version sich der Artikel oder das Codebeispiel bezieht. Ein Besucher kann ansonsten in einem Jahr nicht mehr nachvollziehen, auf welche Contao-Version(en) sich ein HowTo für z.B. ein modifiziertes Template bezieht. Durch die Angabe der Version ist er jedoch in der Lage, Änderungen an dem entsprechenden Template nachzuvollziehen und es bei Bedarf dementsprechend anzupassen. Eine Versionsangabe erfolgt durch ff. Code zu Beginn der Seite:

{{AppliesTo
|Version=Alle Versionen
|Ext1=SuperExtension
|Ext2=HyperExtension}}

Hierbei können folgende Parameter verwendet werden:

  • Version - Die Contao Version auf die sich der Artikel bezieht.
  • Ext1 ... ExtN - Die Extensions die der Artikel betrifft. Die Zahl beginnt jeweils bei 1 und wird für jede weitere Extension um eins hochgezählt.
  • TLVersion - Da einige Artikel neben Contao auch noch TYPOlight (pre Contao 2.9) betreffen, kann man so auch noch angeben, dass ein Artikel ggf. noch TYPOlight betrifft. Diese Angaben werden jedoch mit der Zeit verschwinden.

Dieser Code wird dann am Anfang der Seite wie auf folgender Beispielseite dargestellt.

Kategorisierung

Ein Artikel kann in einer oder mehreren Kategorien abgelegt werden. Für jede Kategorie muss eine neue Zeile zu Beginn der Seite gemacht werden.

[[Category:Admin HOWTOS]]
[[Category:Module]]

Um einen in Arbeit oder unvollständigen Artikel also solchen zu kennzeichnen, wird der Eintrag

{{stub}}

an oberster Stelle, noch vor den Kategorien, eingefügt. Einem unvollständigen Artikel erkennnt man beim Betrachten am Hinweis:

Unvollständiger Artikel

Des weiteren ist der Artikel in der Liste der unvollständigen Artikel aufgeführt.

Hinweise und Warnungen

In einem Artikel kann man Hinweise und Warnungen hinterlegen. Diese fügt man durch die Verwendung der jeweiligen Vorlage hinzu.

Hinweise

 {{Anmerkung|Text der Anmerkung}}

Was folgendes Ergebnis erzeugt.

Anmerkung.png Anmerkung: Text der Anmerkung


Warnungen

 {{Achtung|Text der Warnung}}

Was folgendes Ergebnis erzeugt.

Achtung.png Achtung: Text der Warnung


Formatierung

Textformatierung

Die wichtigsten Textformatierungen lauten:

Fettschrift

'''Fettschrift'''

Schrägschrift

''Schrägschrift''

Fett- und Schrägschrift

'''''Fett- und Schrägschrift'''''

Auflistung

Standardauflistung

* foo
* bar

ergibt

  • foo
  • bar

Nummerierte Auflistung

# foo
# bar

ergibt

  1. foo
  2. bar

Gruppierung

Es ist möglich, einen Artikel in verschiedenen Gruppen und Untergruppen zu gliedern, um bei langen Artikeln die Übersicht zu behalten.

=Hauptgruppe 1=
Text
==Untergruppe 1.1==
Text
==Untergruppe 1.2==
Text
=Hauptgruppe 2=
Text
==Untergruppe 2.1==
Text
==Untergruppe 2.2==
usw

Bei mehr als 4 Gruppen wird automatisch ein Inhaltsverzeichnis am Anfang des Artikels angelegt.

Verlinkung

Textlinks

Bei Textlinks unterscheidet man zwischen internen und externen Link.

Interne Links (innerhalb des TYPOlight Info Portals) werden wie folgt verlinkt:

[[Seitenname|Beschreibung]]

Für externe Links verwendet man:

[http://www.example.com Beschreibung]

Eine Ausnahme hiervon bilden beispielsweise Links auf die Wikipedia. Solche legt man, um auf die englischsprachige Seite in der Wikipedia zu verlinken, folgendermaßen an:

[[w:Seitenname|Beschreibung]]

Eine Seite in anderer Sprache, innerhalb der Wikipedia, erreicht man durch das zusätzliche anhängen des Sprachcodes. Am Beispiel Deutsch sieht dies dann so aus:

[[w:de:Seitenname|Beschreibung]]

Diese Notation nennt sich Interwiki links, von denen einige bereits eingerichtet sind. Sollten welche fehlen, bitte einem Administrator Bescheid geben, damit er baldmöglichst eingebaut wird.

Bilderlinks

Bevor man auf ein Bild verlinkt, muss man das Bild hochladen. Um das Bild in einen Artikel einzubinden, verwendet man folgende Codes:

Die einfachste Variante ist ein Bild mit Beschreibung.

[[Datei:foo.jpg|Bechreibung]]

Des weiteren kann man Bilder auch auf andere Seiten verlinken.

Interne Links:

[[Datei:foo.jpg|link=Hauptseite|Beschreibung]]

Externe Links:

[[Datei:foo.jpg|link=http://www.example.com|Beschreibung]]

Bei Code- und Templatebeispielen TL-Version mit angeben!

Eine ausführliche Zusammenfassung aller Formatierungsmöglichkeiten findet man auf der MediaWiki Homepage

Ansichten
Meine Werkzeuge

Contao Community Documentation

Ich habe eine Anpassungsgeschichte angepasst.

Leo Feyer
Navigation
Verstehen
Verwenden
Entwickeln
Verschiedenes
Werkzeuge