HaBo WiKi:Syntax
Inhaltsverzeichnis |
Einleitung
Wiki-Syntax - Was ist das?
Wiki-Syntax (engl.: wiki-markup) ist eine Auszeichnungsspache, ähnlich HTML. Sie dient dazu, Beiträge in Wikis zu erstellen und zu formatieren. Da es noch keinen allgemein gültigen Standart gibt, hängt die Syntax von der verwendeten Wiki-Software ab. Die im folgenden erklärete Syntax bezieht sich auf die Software des Habo-Wikis.
Textgestaltung
Ein normaler Text wird so wiedergegeben, wie man ihn eingibt. Für einen Absatz fügt man einfach eine Leerzeile ein.
Um Texte hervorzuheben, kann man sie Fett, Kursiv oder Unterstrichen darstellen.
'''Fett''' ''Kursiv'' <u>Unterstrichen</u>
Inhaltsverzeichnis
Ein der Übersicht dienendes Inhaltsverzeichnis wird von der Wiki-Software automatisch erzeugt, sobald mehr als drei Überschriften im Artikel vorhanden sind. Per Default steht dieses über der ersten Überschrift, es sei denn, man erzwingt mit __TOC__ ein Inhaltsverzeichnis an einer beliebigen Stelle.
Ist kein Inhaltsverzeichnis gewünscht, so schreibt man einfach __NOTOC__ an eine beliebige Stelle im Artikel. Der Übersichthalber sollte es allerdings ganz oben stehen.
Überschriften
Um einen Artikel übersichtlich zu gestalten, sollte er in verschiedene Abschnitte unterteilt werden. Diese werden mit Überschriften gegliedert.
Als erste Überschrift wird automatisch der Seitenname verwendet. Alle andern Überschriften setzt man, in dem man die Überschrift mit zwei = einklammert. Für Unterabschnitte erhöht man einfach die Anzahl der =.
Beispiel:
== Überschrift == === Unterüberschrift === ==== Unter-Unterüberschrift ====
Listen
Eine Liste mit einer kleinen Bullet-Grafik am Anfang erstellt man, indem man ein * an den Anfang der Zeile setzt. Für verschachtelte Listen erhöht man einfach die Anzahl der *. Auch nummerierte Listen sind möglich; man ersetzt einfach das * durch #.
Beispiel:
Syntax:
*Punkt 1 *Punkt 2 ** Unterpunkt 1 #Punkt 1 #Punkt 2 ##Unterpunkt 1
- Punkt 1
- Punkt 2
- Unterpunkt 1
- Punkt 1
- Punkt 2
- Unterpunkt 1
Text ausrichten
Standartmäßig ist der Text im Wiki linksbündig. Dies kann man mit einem div-Container ändern.
| Syntax | Ausrichtung |
|---|---|
| <div align="right">text</div> | Rechtsbündig |
| <div align="center">text</div> | Zentriert |
| <div align="justify">text</div> | Blocksatz |
Alles was zwischen den beiden <div> steht, wird entsprechend ausgerichtet.
Möchte man zwei Texte nebeneinander stehen haben, benutzt man wieder div mit dem Attribut style.
Syntax:
<div style="float:left;"> Dieser Text steht links. </div> <div style="float:right;"> Dieser Text steht rechts. </div>
Ausgabe:
Dieser Text steht links.
Dieser Text steht rechts.
Kommentare und Diskussionen
Kommentare kann man mit in den Quellcode eines Artikels schreiben. Sie dienen zum besseren Verständnis ("Was zur Hölle hat der da gemacht?") und werden bei der Ausgabe des Artikels ignoriert.
Definiert werden sie so:
<!-- Hier steht der Kommentar-->
Diskussion dagegen dienen der Abstimmung über Inhalt und Layout eines Artikels. Um auf die Diskussionsseite eines Artikels zu kommen, klickt man ganz oben auf der Seite auf "Diskussion". Einen neuen Kommentar legt man mit dem + an. Sollte noch keine Diskussionsseite angelegt worden sein (Link zur Diskussionsseite ist rot), schreibst man seinen Kommentar einfach in das große Textfeld. Damit man weiß, von wem der Kommentar stammt, kann man seine Signatur + Uhrzeit/Datum hinterlassen.
| Syntax | Ausgabe |
|---|---|
| --~~~ | --Benutzername |
| --~~~~ | --Benutzername 10:57, 15. Okt. 2006 (CET) |
| --~~~~~ | --10:57, 15. Okt. 2006 (CET) |
Verknüpfungen
Verknüpfungen (Links) sind ein wichtiges Element von Wikis. Durch sie kann man zwischen verschiedenen, zusammenhängenden Artikeln hin- und herspringen.
Einem Link auf eine andere Wiki-Seite legt man mit [[Name_der_Seite]] an. Die Ausgabe ist dann Name_der_Seite.
Möchte man die Beschriftung des Links ändern, schreibt man [[Name_der_Seite|Titel]]. Die Ausgabe ist dann Titel.
Wenn man auf eine Seite außerhalb des Wikis verlinkt, wird nur eine eckige Klammer verwendet. Außerdem wird der | durch ein Leerzeichen ersetzt. Links ohne Beschreibung werden automatisch durchnummeriert.
http://www.hackerboard.de wird zu http://www.hackerboard.de
[http://www.hackerboard.de] wird zu [1].
[http://www.hackerboard.de Hackerboard] wird zu Hackerboard.
Um deutlich zu machen, in welcher Sprache ein externer Link ist, kann man diesen mit einer kleinen Flagge kennzeichnen.
[http://www.hackerboard.de Hackerboard] {{de}} wird zu Hackerboard
[http://www.hackerboard.de Hackerboard] {{en}} wird zu Hackerboard
[http://www.hackerboard.de Hackerboard] {{fr}} wird zu Hackerboard
Einzelnachweise
Aussagen im Text können mit Hilfe von Einzelnachweisen belegt werden. Mit den Markierungen <ref> und </ref> werden Belege in den Text eingefügt. In einem eigenen Abschnitt, in dem die Belege dann als Fußnote erscheinen sollen, wird der Befehl <references /> eingefügt. Um wiederholt auf dieselbe Quelle zu verweisen, muss ein eindeutiger Name mit <ref name="..."> vergeben werden. Im Wiederholungsfall wird dann namentlich mit <ref name="..."/> (ohne zusätzlichen Klammerabschluss </ref>) auf die vollständige Quelle verwiesen.
Beispiel:
Text.<ref name="Magazin">''Popular Science''. 12, 2005, S. 12.</ref> Text.<ref>Name der Quelle: ''[http://www.quelle.de Titel der Quelle]''</ref> Text.<ref name="Magazin"/> Text.<ref name="Magazin"/> ==== Einzelnachweise ==== <references/>
Text.<ref name="Magazin">Popular Science. 12, 2005, S. 12.</ref> Text.<ref>Name der Quelle: Titel der Quelle</ref> Text.<ref name="Magazin"/> Text.<ref name="Magazin"/>
Einzelnachweise
<references/>
Bilder
Bilder lassen sich mit [[Bild:Bildname|Beschreibung]] in das Wiki einbinden. Es erscheint dann in Orginalgröße.
Möchte man einen Rahmen um das Bild, fügt man einfach ein "framed" hinzu.
[[Bild:Bildname|framed|Beschreibung]]
Aus Rücksicht auf Modem-Besitzer sollte man allerdings ein Thumbnail erstellen. Dieses ist Standartmäßig 180 Pixel breit. Die Höhe wird aus dem Seitenverhältnis automatisch berechnet. Ein Klick auf das Thumbnail zeigt das Bild in Originalgröße.
[[Bild:Bildname|thumb|Beschreibung]]
Die Breite eines Thumbnails lässt sich auch manuell bestimmen.
[[Bild:Bildname|thumb|100px|Beschreibung]]
Außerdem lassen sich die Bilder noch mit left/ right/ none ausrichten.
[[Bild:Bildname|left|Beschreibung]]
Vorlagen
Vorlagen sind Wiki-Seiten, dessen Inhalt mit bestimmten Befehlen an beliebiger Stelle im Artikel eingebunden werden können. Das ist zum Beispiel dann sinnvoll, wenn man eine Vorlage anlegt, in der steht, dass ein Artikel noch ausbaufähig ist. Findet man einen solchen Artikel, lässt sich einfach die (einheitliche) Vorlage einbinden, statt dass man sich immer einen neuen Text aus den Fingern saugen muss.
Vorlagenseiten legt man wie jede andere Wiki-Seite auch an, nur dass der Namensraum ein anderer ist.
http://wiki.hackerboard.de/index.php/Vorlage:Testvorlage erzeugt die Vorlagenseite "Vorlage:Testvorlage". Diese lässt sich jetzt wie gewohnt über "bearbeiten" anlegen/ändern.
Ist die Vorlage fertiggestellt, kann man sie jederzeit mit dem Befehl {{Name_der_Vorlage}} in die Seite einbinden. D.h., {{Name_der_Vorlage}} wird durch den Inhalt der Seite Name_der_Vorlage ersetzt.
Für die Testvorlage müssten wir zum Einbinden also schreiben:
{{Testvorlage}}
Damit sich nicht jeder, der eine Vorlage betrachtet, fragt "Wozu ist die denn gut?", kann man eine kurze Erklärung abgeben, welche nicht mit eingebunden wird. Man verwendet dazu <noinclude></noinclude>.
Beispiel:
<noinclude> Dieser Text wird beim Einbinden in einen Artikel ignoriert. </noinclude> Inhalt der Vorlage, welcher eingebunden wird.
Manchmal möchte man einer Vorlage noch einen Kommentar hinzufügen, z.B., um zu sagen, warum ein Artikel noch ausbaufähig ist. Für dieses Problem gibt es in der Wiki-Software sogenannte Parameter.
Parameter werden optional in den Code zum Einbinden einer Vorlage geschrieben, mit einem | vom Vorlagenname getrennt.
{{Testvorlage|Dies ist ein Parameter}}
Nun muss man in der Vorlage noch definieren, wo der Parameter eingefügt werden soll. Dazu verwendet man {{{1}}}. Das {{{1}}} wird beim Einbinden in einen Artikel durch den Inhalt des Parameters ersetzt.
Natürlich kann man auch mehrere Parameter verwenden.
{{Testvorlage|Parameter1|Parameter2}}
Testvorlage
{{{1}}}
{{{2}}}
Ausgabe:
Testvorlage Parameter1 Parameter2
Zurzeit im HaBo-Wiki verfügbare Vorlagen
Weblinks
|
