Bearbeitungsfenster¶

Der Bearbeitungseditor von Inyoka erlaubt den grafischen Zugriff auf häufig gebrauchte Syntaxelemente und Textbausteine. Dazu gehören:

• Textformatierung

• Überschriften verschiedener Ebenen

• Textbausteine mit allen wichtigen Vorlage-Elementen zum Kopieren

• Textformat

Hat man JavaScript aktiviert, sieht man im Kopfbereich des Bearbeitungsfensters eine Symbolleiste mit den genannten Möglichkeiten:

Textformatierung¶

Es gibt fünf mögliche Textformatierungen, die im Wiki klar definiert sind und stets für die vorgesehenen Zwecke verwendet werden. Eine Verwendung in anderen als den hier aufgeführten Fällen ist nicht erwünscht.

Textformatierung
Syntax	Schaltfläche	Ergebnis	Ausschließlich verwenden für
'''fett'''		Fettschrift	Dateinamen, Verzeichnisse, Paketnamen und Dateinamenserweiterungen.
''"kursiv"''		"Kursivschrift"	Menüelemente, Schaltflächen, G-Conf-Schlüssel, immer in Anführungszeichen!
`Monotype`		Monotype	Befehle sowie Optionen und Parameter, Terminalausgaben im Fließtext, Module, Benutzer, Gruppen
__unterstrichen__		unterstrichen	Hervorheben von einzelnen Wörtern im Text. Bitte unbedingt sparsam verwenden!
GROSSBUCHSTABEN			Variablen innerhalb von Befehlen oder Konfigurationsdateien

Auch wenn Programme oft den gleichen Namen wie ein Paket haben, werden sie im Fließtext unformatiert gelassen.

Beispiel:

foobar DATEINAME --verbose 

Außer den hier aufgeführten Syntaxelementen sind im Wiki keine weiteren Textformatierungen zulässig. Zusätzlichen Elemente sind für das Forum vorgesehen.

Um einen neuen Absatz einzufügen, verwendet man einen doppelten Zeilenumbruch, also ⏎ + ⏎ . Einfache Zeilenumbrüche werden von Inyoka nicht berücksichtigt! Manuelle Zeilenumbrüche (\\) sind im Wiki unerwünscht.

Textbausteine¶

Für viele häufige Formatierungen, z.B. den Getestet- oder Wissensblock, sind bereits Textbausteine vorhanden, die man einfach kopieren und einfügen kann.

Eine Auflistung aller Möglichkeiten findet sich unter Wiki/Textbausteine

Überschriften¶

Um Wikiartikel zu strukturieren und lesbarer zu gestalten, sollten (wie auch in diesem Artikel) Überschriften verwendet werden. Die Syntax lautet:

= Überschrift 1 =
== Überschrift 2 ==  entspricht der 2.Ebene
=== Überschrift 3 ===  entspricht der 3.Ebene/Stufe

Überschriften dürfen keinen Doppelpunkt beinhalten (siehe Anker)! Weiterhin sind in Überschriften keinerlei Formatierungen erlaubt, also z.B. keine Fettschrift, keine Links etc.

Inhaltsverzeichnis¶

Trägt man am Anfang des Artikels noch vor den einleitenden Worten Folgendes ein

[[Inhaltsverzeichnis()]]

wird automatisch ein Inhaltsverzeichnis aus den Überschriften generiert. Das Makro [[Inhaltsverzeichnis()]] wird in Wikiartikeln unmittelbar vor den eigentlichen Text gesetzt – und somit nach dem „Getestet-“ und „Wissensblock“. In der Klammer kann eine Zahl angegeben werden, bis zu welcher Überschriftenebene das Inhaltsverzeichnis dargestellt werden soll.

Siehe auch: Wiki/Textbausteine (Abschnitt „Inhaltsverzeichnis“)

Tags¶

Jeder Artikel muss mindestens einen Tag besitzen. Hauptzweck ist die Ordnung im Wiki. Diese „Tags“ oder Schlagworte stehen immer am Ende des Artikel. Die Tag-Liste besteht aus einer Raute („#“), dem Schlüsselwort „tag:“ und einer kommaseparierten Liste der passenden Kategorien. Beispiel:

#tag: Server, Netzwerk

Erst durch dieses Tagging („mit einem Etikett versehen“) ist die Erstellung einer Wortwolke (Tagwolke) möglich.

Links und Anker¶

Listen¶

Listen können verschiedene Ebenen haben und auch beliebig verschachtelt werden. Wichtig ist, dass mindestens ein Leerzeichen vor und nach jedem Listenelement stehen muss. Zur Formatierung können die Schaltflächen (für "Bullet-Hole"-Listen) bzw. (für nummerierte Listen) verwendet werden.

Zur besseren Darstellung wird in diesem Beispiel das Symbol ␣ als Lesezeichen verwendet:

␣*␣Punkt␣1
␣*␣Punkt␣2
␣␣1.␣Unterpunkt␣1
␣␣1.␣Unterpunkt␣2
␣␣␣1.Nächste␣Ebene
␣*␣Punkt␣3
␣␣*␣Unterpunkt␣1
␣␣␣*␣Nächste␣Ebene

Das sieht dann so aus:

• Punkt 1

• Punkt 2

  1. Unterpunkt 1

  2. Unterpunkt 2

     1. Nächste Ebene

• Punkt 3

  • Unterpunkt 1

    • Nächste Ebene

Die Anzahl der vorangestellten Leerstellen bestimmt die Ebene (Staffelung) des Punktes. Der * (Stern) definiert ob ein Punkt am Anfang zu ersehen ist. Dieser muss aber auf der ersten Ebene auf jeden Fall verwendet werden. Ausnahme bildet hier die Aufzählung. Hier wird der * (Stern) durch 1. ausgetauscht:

␣1.␣Punkt␣1
␣1.␣Punkt␣2

Ergebnis:

1. Punkt 1

2. Punkt 2

Tabellen¶

Tabellen dienen der übersichtlichen Darstellung von Daten mit inhaltlichem Zusammenhang. Bsp.:

Diese Tabelle wird mit diesem Code erzeugt:

{{{#!vorlage Tabelle
<rowclass="titel"-3> Zelle über drei Spalten
+++
<rowclass="kopf"> Beschreibung 1
Beschreibung 2
Beschreibung 3
+++
Zelle 1
Zelle 2
Zelle 3
}}}

Eine Tabelle wird durch folgendes Grundgerüst erstellt:

{{{#!vorlage Tabelle
1. Zeile/1.Spalte
1. Zeile/2.Spalte
1. Zeile/3.Spalte
+++ Es folgt Zeile 2
2. Zeile/1.Spalte
2. Zeile/2.Spalte
2. Zeile/3.Spalte
}}}

Jeder Zeilenumbruch stellt eine Spalte in einer Tabellenzeile dar. Weitere Zeilen werden durch drei "+"-Zeichen, gefolgt von einem Zeilenumbruch, hinzugefügt. Dieser Zeilentrenner kann für zusätzliche Hinweise, z.B. eine Zeilennummerierung, genutzt werden um eine bessere Übersichtlichkeit zu erreichen.

Eine ausführliche Darstellung zu den Möglichkeiten von Tabellen, z.B. Textausrichtung, farblich vordefinierte Zeilen, Verbinden von Zellen usw. findet sich unter Tabellen

Bilder¶

Um ein Bild in den Text einzufügen, muss zunächst eine Datei hochgeladen werden: Dazu wählt man auf der jeweiligen Wiki-Seite links unter dem Punkt "Konfiguration" "→ Anhänge verwalten".

Anschließend kann dort ein Bild hochgeladen werden. Falls der Dateiname Leerzeichen oder andere nicht internetkonforme Zeichen enthält, kann man das Feld "Umbenennen" verwenden. Dabei ist zu beachten, dass die Dateiendung Bestandteil des Dateinamens ist, also mit angegeben werden muss.

Danach gibt es verschiedene Möglichkeiten, das Bild einzubinden. Normalerweise sollte das Bild als „einfaches Bild“ eingebunden werden. Nur wenn es etwas Wichtiges zu erläutern gibt, sollte eine Bildunterschrift genutzt werden.

Eine ausführliche Darstellung zu Bildern, u.a. auch Bilder mit Bildunterschriften, Anlegen einer Bildersammlung oder Fließtext um die Bilder findet sich unter Bilder

Befehle einfügen¶

Befehle, die nicht im Fließtext stehen, werden in einen Befehlsblock eingefasst:

{{{#!vorlage Befehl
Befehl OPTION
}}}

Ausgabe:

Befehl OPTION 

Code einfügen¶

Terminalausgaben oder Auszüge aus Konfigurationsdateien werden in einen einfachen Codeblock eingefasst:

{{{
Terminalausgabe
}}}

Möchte man den Code mit Syntaxhervorhebung formatieren – was die Lesbarkeit deutlich erhöht – so nutzt man folgende Syntax:

{{{#!code sprache
Text
}}}

sprache muss dabei durch die entsprechende (unterstützte) Sprache ersetzt werden, wobei auf Kleinschreibung zu achten ist. Nach Markieren des Textes kann über die Schaltfläche Codeblock die gewünschte Sprache ausgewählt werden. Ein Python-Beispiel würde dann so dargestellt:

1
2
3
4
5
6
7

import numpy as np

#Linear Gleichungen lösen
equations = np.array([[3,1], [1,2]])
results = np.array([9,8])
solution = np.linalg.solve(equations,results)
print(solution)

Anhänge¶

Um einen Anhang in den Text einzufügen, muss zunächst eine Datei (Deb-Pakete sind nicht als Anhang erlaubt!) auf einer Seite hochgeladen werden. Dazu muss auf der jeweiligen Wiki-Seite der Punkt "Konfiguration → Anhänge verwalten" gewählt werden.

Tasten¶

Die allgemeine Syntax ist:

[[Vorlage(Tasten, TASTE)]]

wobei TASTE durch die entsprechende Taste ersetzt werden muss. Ein paar Beispiele:

[[Vorlage(Tasten, a)]]
[[Vorlage(Tasten, enter)]]
[[Vorlage(Tasten, ctrl+a)]]

A , ⏎ , Strg + A

Eine vollständige Übersicht über alle möglichen darstellbaren Tasten erhält man unter Tasten.

Links¶

• Wiki Grundlagenartikel und Übersicht

  • Wiki/Benutzung - Allgemeine Benutzung des Wikis außerhalb des Editierens

  • Wiki/Referenz - Sprache (Ausdruck), Anspruch und Regeln für einen Artikel

  • Wiki/Syntax-Übersicht - Komplette Übersicht aller Syntaxelemente

  • Wiki/Textbausteine - erleichtern die Verwendung immer wiederkehrender Floskeln

  • Wiki/Kopiervorlage - wichtige Elemente zum Kopieren

  • Wiki/Bilder - Einbinden von Bildern

  • Wiki/Tasten - Abbildungen von Tasten und Tastenkürzeln

  • Wiki/Tabellen -Ausführliche Beschreibung der Tabellensyntax

  • Wiki/Flaggen - Länder- bzw. Sprachkennzeichnungen

  • Wiki/Icons - weitere Symbole

  • Wiki/Smilies - ☺ und andere Symbole

  • Wiki/InterWiki - spezielle Auszeichnungen von Links

  • Wiki/Tag - Einsatz von Stichwörtern zur Katalogisierung

• Forum/Syntax - Ausführliche Einführung in die Benutzung des Forums

• InyokaEdit - Spezialeditor für Wikartikel und andere Inyoka-Projekte