HowTo - Wiki Formatierungen

Wiki bearbeiten Wiki editing Wiki modifier

Inhaltsverzeichnis

1 Teufelchen und Engelchen
2 HowTo - Wiki formatieren
- 2.1 Textgestaltung
3 Spezielle Vereinbarungen für den Artikel "Vom Auschecken bis zum Image"

Teufelchen und Engelchen

Wichtig!

Schaue Dir den Quellcode von bestehenden Dateien/Artikel an, bevor Du Deine ersten Änderungen vornimmst.
Nutze die Vorschau, bevor Du eine Seite endgültig veränderst oder erstellst.
Wenn ein und derselbe Text mehrfach verwendet werden kann, erstelle eine Vorlage und nutze diese!
Denke vorausschauend, z.B. an die Multilingualität (Mehrsprachigkeit), bevor Du neue Seiten erstellst.
Benutze HTML nur, wenn der Wiki-Code nicht ausreicht!
Verwende keine absoluten Links innerhalb des Wikis, wenn Wiki-Links verwendet werden können! (Siehe nachfolgende Tabelle).
Für die Verlinkung zur Streamboard-Hauptseite existieren die folgenden Spezial-Linkmöglichkeiten:

Syntax	Beschreibung	Beispiel
Streamboard:<URL>	Verlinkung auf eine Seite der Streamboard-Domain. Achtung: Es dürfen keine Parameter im Link sein!	Timeline
Streamboard-Post:<PostID>	Verlinkung eines Postings im Forum	Erster Post
Streamboard-Thread:<ThreadID>	Verlinkung eines Threads im Forum	Erster Thread
Streamboard-Board:<BoardID>	Verlinkung eines Boards im Forum	Smalltalk
Streamboard-Attachment:<AttachmentID>	Verlinkung eines Attachments im Forum	mpcsmon-src-0.6.tar.bz2

Hinweise:

Beachte auch Kleinigkeiten wie Absätze, Leerzeilen und Leerzeichen.
Verwende Leerzeichen anstatt Tabs, wenn Du eine Seite in einem externen Editor bearbeitest.

Schlecht! - Bad! - Mauvais!	Gut! - Good! - Bon!	Kommentar - Comment - Commentaire
`= Überschrift 1 =`		Die Ebene 1 ist für den Seitentitel reserviert und innerhalb von Artikeln unerwünscht. Beginne also immer mit Ebene 2 und verwende Ebene 1 so gut wie nie.
`==Überschrift==`	`== Überschrift ==`	Achte auf die Leerzeichen, auch wenn beides funkioniert.
`== '''Überschrift 2''' ==`	`== Überschrift 2 ==`	Es ist doch eine Überschrift, also verzichte bitte auf weitere Formatierungen.
`== Überschrift 2 == === Überschrift 3 ===`	`== Überschrift 2 == === Überschrift 3 ===`	Überschriften, oder Texte nach einer Überschrift, können direkt danach folgen, also ohne Absatz.
`[http://www.domain.irgendwo/wiki/index.php/Hauptseite]`	`[[Hauptseite]]`	Links innerhalb eines Wikis sollten nicht absolut angegeben werden! Denk nur mal daran, wenn das Wiki die Domain wechselt...

HowTo - Wiki formatieren

Textgestaltung

Hier wird erklärt wie man verschieden Darstellungen von Texten im Wiki beeinflussen kann/sollte. Es handelt sich hier um ein MediaWiki-System, das dieselben Formatierungsmöglichkeiten bietet wie Wikipedia.

Ergebnis	Code	Kommentar
kursiv	`''kursiv''`	z.B. für Dateinamen
fett	`'''fett'''`	z.B. für wichtige Hinweise
fett und kursiv	`'''''fett und kursiv'''''`	z.B. für wichtige Dateinamen
Wiki-Sonderzeichen, zB.: < > '' [ ] ==	`<nowiki>Wiki-Sonderzeichen, zB.: < > '' [ ] ==</nowiki>`	z.B. für Code Schnipsel, damit vorkommende Zeichen vom Wiki nicht als Formatierung interpretiert werden
wichtiger Hinweis Zeile 2 Zeile 4	`<LEERZEICHEN>wichtiger Hinweis <LEERZEICHEN>Zeile 2 <LEERZEICHEN> <LEERZEICHEN>Zeile 4`	Einfügen von Code, Kommandos oder wichtigen Hinweisen in einem Kasten werden per Leerzeichen am Zeilenanfang eingeleitet. Mit <LEERZEICHEN> im Code-Beispiel ist ein echtes Leerzeichen gemeint, hierbei handelt es sich nicht um "Wiki-Code" ;)
eins zwei zwei-eins zwei-zwei drei	`* eins * zwei zwei-eins zwei-zwei * drei`	Aufzählungen, z.B. benötigte Pakete
Überschriften	`== Überschrift Ebene 2 ==` `====== Überschrift Ebene 6 ======`	Die Ebene 1 ist für den Seitentitel reserviert und innerhalb von Artikeln unerwünscht.
<syntaxhighlight lang="php"> <?php ich bin ein Kommentar echo 'ich bin PHP Code'; ?> </syntaxhighlight>	`<syntaxhighlight lang="php"> <?php # ich bin ein Kommentar echo 'ich bin PHP Code'; ?> </syntaxhighlight>`	Syntaxhervorhebung in PHP
<syntaxhighlight lang="bash"> ich bin ein Kommentar echo 'ich bin Bash Code' </syntaxhighlight>	`<syntaxhighlight lang="bash"> # ich bin ein Kommentar echo 'ich bin Bash Code' </syntaxhighlight>`	Syntaxhervorhebung in Bash

Manuelle Zeilenumbrüche können mit <br /> erzwungen werden. Damit sollte aber sparsam umgegangen werden!

Kategorien

Jeder Artikel sollte kategorisiert werden und somit z.B. wie folgt beginnen:

[[Kategorie:OSCam]]

Die "Haupt"-Artikel/-Seiten dürfen auch mehreren Kategorien zugeordnet werden, z.B.:

[[Kategorie:HowTo]]
[[Kategorie:Cardserver]]
[[Kategorie:OSCam]]

Unter-Artikel/-Seiten sind wiederum nur der Kategorie der übergeordneten Seite zuzuordnen.

Farbige Texte

Ergebnis	Code
ÄNDERUNG - CHANGE - MODIFICATIONS - MODIFICA	`<span style="background-color:Blue;color:White;padding:0 5px;">ÄNDERUNG - CHANGE - MODIFICATIONS - MODIFICA</span>`
NEU - NEW - NOUVEAU - NUOVO	`<span style="background-color:Green;color:White;padding:0 5px;">NEU - NEW - NOUVEAU - NUOVO</span>`
HINWEIS - TIP - CONSEIL - NOTA	`<span style="background-color:Yellow;padding:0 5px;">HINWEIS - TIP - CONSEIL - NOTA</span>`
VERALTET - OBSOLETE - OBSOLÈTE - ANTIQUATO	`<span style="background-color:Red;color:White;padding:0 5px;">VERALTET - OBSOLETE - OBSOLÈTE - ANTIQUATO</span>`

Farbige Hinweise (Vorlagen)

Am "Code" siehst Du, dass viele (bzw. in diesem Fall englische und französische) Köche den Brei auch verderben können :(

Ergebnis	Code
Parameter ist optional	`{{Optional}}`
Parameter wird benötigt	`{{Mandatory}}`
Parameter wird abhängig vom Setup/Programmversion benötigt.	`{{Depends}}`
parameter is optional	`{{Optional/en}}`
parameter is required	`{{required}}`
parameter depends on setup/programversion	`{{Depends/en}}`
Ce paramètre est optionnel	`{{Pasindispensable}}`
Ce paramètre est obligatoire	`{{Obligatoire}}`
Ce paramètre dépend de la configuration/version du programme.	`{{Version}}`
Parametro facoltativo	`{{Optional/it}}`
Parametro necessario	`{{Mandatory/it}}`
Parametro necessario secondo la impostazione e versione del programma	`{{Depends/it}}`

Status-Meldungen

Ergebnis	Code
Hilfe:	`[[Datei:HelpS.png\|text-bottom]] '''Hilfe:''' oder "Help" für englisch, oder "Aide" für französisch, oder "Aiuto" für italienisch`
Info:	`[[Datei:MessageS.png\|text-bottom]] '''Info:'''`
Achtung:	`[[Datei:WarningS.png\|text-bottom]] '''Achtung:''' oder "Attention" für englisch und französisch, oder "Attenzione" für italienisch`
Fehler:	`[[Datei:ErrorS.png\|text-bottom]] '''Fehler:''' oder "Error" für englisch, oder "Erreur" für französisch, oder "Errore" für italienisch`
Baustelle	`[[Datei:UnderConstruction.jpg\|text-bottom]] '''Baustelle''' oder "Under Construction" für englisch, oder "En cours d'élaboration" für französisch, oder "in construzione" für italienisch`
Unsicher	`[[Datei:Unsicher.gif\|text-bottom]] '''Unsicher''' oder "Unsure" für englisch, oder "incertain" für französisch, oder "Incerto" für italinisch`
Nicht mehr verwendet!	`[[Datei:Obsolet.jpg\|text-bottom]] '''Nicht mehr verwendet''' oder "Obsolet!" für englisch, oder "Obsolète" für französisch, oder "non piu utilizzato" für italienisch`