Hilfe:Inhaltsverzeichnis
Aus Contao Community Documentation
Inhaltsverzeichnis
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.
Einen neuen Artikel anlegen
Sollte die Suche zu keinem Ergebnis führen, legt man die Seite neu an. Hierzu gibt man beispielsweise den gewünschten Titel links in der Sidebar in das Suchfeld ein und klickt anschließend auf den Button "Seite". Die Wiki-Software meldet nun, dass die Seite nicht existiert und man möge sie doch bitte verfassen.
Nach einem Klick auf den Link die Seite verfassen gelangt man in die Eingabemaske.
Ungeduldige können auch direkt die URL: http://de.contaowiki.org/Wunschtitel in ihrem Browser eingeben, wodurch man direkt in die Eingabemaske gelangt.
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 als 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:
Des weiteren ist der Artikel in der Liste der unvollständigen Artikel aufgeführt.
Hinweise, Anmerkungen und Warnungen
In einem Artikel kann man Hinweise und Warnungen hinterlegen. Diese fügt man durch die Verwendung der jeweiligen Vorlage hinzu.
Hinweise
{{Hinweis|Text des Hinweises}}
Was folgendes Ergebnis erzeugt.
 |
Hinweis: Text des Hinweises |
Anmerkungen
{{Anmerkung|Text der Anmerkung}}
Was folgendes Ergebnis erzeugt.
 |
Anmerkung: Text der Anmerkung |
Warnungen
{{Achtung|Text der Warnung}}
Was folgendes Ergebnis erzeugt.
 |
Achtung: Text der Warnung |
Meldungen mit Bild links oben und farbigem Text
Ich habe mir erlaubt, einige eingefärbte Meldungsboxen hinzuzufügen, bei denen die Bilder links oben sitzen (was ich bei längeren Texten ganz angenehm finde). Die Icons sind aus dem frei verfügbaren Oxygen Theme von David Vignoni. --Hschottm 16:11, 11. Sep. 2010 (CEST)
| Befehl | Ausgabe |
|---|---|
{{msgInfo|Text der Meldung}}
|
|
{{msgSuccess|Text der Meldung}}
|
|
{{msgError|Text der Meldung}}
|
|
{{msgWarning|Text der Meldung}}
|
|
{{msgImportant|Text der Meldung}}
|
|
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
- foo
- 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.
Auszeichung von Quellcode
Um Text als Quellcode darzustellen, verwendet man das <source>-Tag (favorisierte Methode seit 27.08.2010).
Weiter Möglichkeiten sind:
- man fügt eine Leerzeile ein und beginnt jede Zeile des zu formatierenden Textes mit einem Leerzeichen (space/blank).
- man umgibt den zu formatierenden Text mit <pre>.... text ...</pre>
Bei der Formatierung von Quellcode mittels <source>-Tag kann man optional ein Sprachattribut mit angeben.
Beispiel:
<source lang="css">
div .classname {
color: white;
}
</source>
Das Ergebnis sieht dann so aus:
div .classname { color: white; }
Die folgenden Sprachen sind per lang-Parameter verfügbar:
|
|
|
|
Umlaute/Sonderzeichen
Will man Umlaute im Wiki als HTML-Entity (Ersatzdarstellung) darstellen (z.b. ä = ä), sieht die Schreibweise beispielsweise so aus:
ä = &auml;
Verlinkung
Textlinks
Bei Textlinks unterscheidet man zwischen internen und externen Link.
Interne Links (innerhalb des Contao Info Portals) werden wie folgt verlinkt:
[[Seitenname|Beschreibung]]
Bsp: Hauptseite des Wikis
Für externe Links verwendet man:
[http://www.example.com Beschreibung]
Bsp: Contao-Homepage
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
Übersetzungen des Contaowiki
Das Contaowiki-Projekt umfasst derzeit drei Sprachen. Deutsch (http://de.contaowiki.org), Englisch (http://en.contaowiki.org) und Französisch (http://fr.contaowiki.org). In einem Artikel sieht man links unten im Menü unter "Sprachen" in welche anderen Sprachen der Artikel bereits übersetzt wurde. Sollte eine Sprache fehlen und man sich selbst der jeweiligen Sprache ausreichend mächtig fühlen, sollte man nun daran gehen den Artikel in die fehlende Sprache zu übersetzen. Zur genauen Vorgehensweise hier eine kleine Anleitung:
Titelfindung
Vorab sollte überlegt werden, wie der Artikel in der anderen Sprache heißen könnte. Nimmt man als Beispiel hier den fiktiven Artikel "Beispiel" (das Wort "Beispiel" heißt übersetzt in englischen "Example"), so sollte der auf en.contaowiki.org erstellende Artikel somit heißen: http://en.contaowiki.org/Example.
Text übersetzen
Nun geht es daran, den Text zu übersetzen. Man sollte daran denken, dass die im Ursprungsartikel verlinkten weiteren Artikel in der neuen Sprache vermutlich einen anderen Namen haben werden. Diese Artikel sollte man dann suchen und, sofern noch nicht existent, unter neuem Namen ebenfalls verlinken. Dies erzeugt einen roten Link und fungiert somit als Platzhalter für den Artikel, welcher dann in der Liste der gewünschten Seiten auftaucht. Wenn man möchte, kann man die jeweiligen Artikel dann logischerweise auch gleich im Anschluss ebenfalls übersetzen.
Verlinkungen zwischen den Sprachen setzen
Abschließend muss den Wikis noch mitgeteilt werden, unter welchem Namen die Übersetzung in der anderen Sprache zu erreichen ist. Hierzu verwendet man die Interwiki-Notation, wie bei Wikipedia und ähnlichen Projekten.
Im deutschen Wiki schreibt man auf der Seite "Beispiel":
[[en:Example]]
und im englischen auf der Seite "Example":
[[de:Beispiel]]
