¶ Übersicht
In dem folgenden Abschnitt soll eine kurze Übersicht gegeben werden, wie das Wiki bearbeitet werden kann. Es ist absolut empfohlen, sich die offizielle Dokumentation der Software durchzulesen, da diese mehr ins Detail geht! Die offizielle Doku ist hier zu finden.
¶ The Zen of the Wiki [1]
- Explizit ist besser als implizit.
- Einfach ist besser als komplex.
- Komplex ist besser als kompliziert.
- Spärlich ist besser als dicht.
- Lesbarkeit zählt.
- Sonderfälle sind nicht speziell genug, um nicht dokumentiert zu werden.
- Im Angesicht von Mehrdeutigkeit sollte man nicht raten müssen.
¶ Erste Schritte
¶ Seiten anlegen
Links im Wiki sind immer nur absolut. Das heist der Link
/page/new-page/ist äquivalent zuhttps://newwiki.stuve.uni-ulm.de/de/page/new-pageegal in welchem Pfad man sich aktuell im Wiki befindet.
¶ Möglickeit 1
Um eine Seite anzulegen muss auf den Seite anlegen Button () geklickt werden. In dem Dialog kann dann unten der gewünschte Pfad eingegeben werden. Außerdem kann zu einem Pfand im Baum navigiert werden, indem man sich durch den Ordnerbaum klickt.
¶ Möglichkeit 2
Seiten können auch angelegt werden indem auf einer Seite der Link geschrieben wird. Sobald dann jemand auf diesem Link klickt, wird diese Person aufgefordert die neue Seite unter diesem Link zu erstellen.
¶ Seiten bearbeiten
Um in den Bearbeitungsmodus zu wechseln, muss man auf den runden Kreis mit einem Stift in der Mitte klicken. Dieses Icon wird unten rechts auf der zu bearbeiteten Seite angezeigt. Durch den klick wird man automatisch zu dem Editor weitergeleitet. Es können nur Seiten bearbeitet werden, für die entsprechende Rechte vergeben wurden.
Alternativ kann der Bearbeitungsmodus auch über den Seitenaktionen Button oben rechts erreicht werden.
¶ Editoren
Es gibt zwei verschiedene Editoren, mit denen man das Wiki bearbeiten kann. Es kann zwischen den Editoren gewechselt werden.
¶ Visual Editor
Dieser Editor ist ein WYSIWYG-Editor („What You See Is What You Get“-Editor). Das ist zu vergleichen mit z.B. MS-Word. Der Vorteil eines solches Editors ist, dass man ohne jegliches Vorwissen damit arbeiten kann. Für komplexere Seiten ist jedoch der Markdown Editor empfohlen.
¶ Markdown Editor
Markdown hat verschiedene Versionen. Aus diesem Grund kann es vorkommen dass das Pad andere Features als das Wiki unterstützt.
Alle grundsätzlichen Markdown Feaures sind jedoch überall erhältlich.
Dieser Editor ist ähnlich wie der des neuen Pads.
Dieser Editor nutzt die Markdown als Sprache. Die Markdown syntax ist leicht zu verstehen. Mit dem Markdown Editor können wesentlich vielseitigere Seiten erstellt werden, die zum Beispiel Diagramme enthalten.
Auf der linken Seite sieht man, was man tippt, und auf der rechten wie das Getippte angezeigt wird .
¶ Einführung Markdown
¶ Überschirften
# Überschirft 1
## Überschirft 2
### Überschirft 3
¶ Textformatierung
| Fetter Text | **Fetter Text** |
| Unterstrichen | _Unterstrichen_ |
| Kurisiv | *Kursiv* |
~~Durchstrichen~~ |
¶ Sonderzeichen
Manche Zeichen wie zum Beispiel <, > und \ haben in Markdown eine spezielle Funktion und werden deswegen nicht angezeigt. Wenn die dennoch angezeigt werden sollen, müssen sie mit einem Backslash escaped werden: \<, \>, \\
¶ Tabellen
Durch die : kann angegeben werden, ob die Spalte linksbündig (Standart Fall), mittig oder rechtsbündig ausgerichtet werden soll.
| Spalte 1 | Spalte 2 | Spalte 3 |
|:---------|:--------:|---------:|
| a | b | c |
| a | b | c |
| a | b | c |
| a | b | c |
wird dahrgestellt als:
| Spalte 1 | Spalte 2 | Spalte 3 |
|---|---|---|
| a | b | c |
| a | b | c |
| a | b | c |
| a | b | c |
¶ Stichpunkt Listen
- Punkt 1
- Punkt 2
- Punkt 3
- Unterpunkt a
- Unterpunkt b
- Punkt 4
wird dargestellt als:
- Punkt 1
- Punkt 2
- Punkt 3
- Unterpunkt a
- Unterpunkt b
- Punkt 4
¶ Nummerierte Listen
Wenn jeder Punkt mit
'1.'nummeriert wird, übernimmt Markdown die richtige fortlaufende Nummerierung bei dem Darstellen der Seite.
1. Punkt 1
1. Punkt 2
1. Punkt 3
1. Unterpunkt a
1. Unterpunkt b
1. Punkt 4
wird dargestellt als:
- Punkt 1
- Punkt 2
- Punkt 3
- Unterpunkt a
- Unterpunkt b
- Punkt 4
¶ Task Listen
- [ ] Punkt 1
- [x] Punkt 2
- [ ] Punkt 3
wird dargestellt als:
- Punkt 1
- Punkt 2
- Punkt 3
¶ Links
[Wikipedia](www.wikipeadia.org)
wird dargestellt als:
¶ Farben
Hiermit kann Text bunt dahrgestellt werden.
¶ CSS Klassen
Für das einfach Verwenden von Farben im Wiki sind die typischen StuVe Farben als CSS-Klassen verfügbar.
Mein text ist Grün.
{.StuVe-Text-Gruen}
Wir dahrgestellt als →
Mein text ist Grün.
Insgesamt sind folgende Klassen verfügbar:
{ .StuVe-Text-Gruen }→ Grün{ .StuVe-Text-Dunkel-Gruen }→ Dunkel Grün{ .StuVe-Text-Blau }→ Blau{ .StuVe-Text-Dunkel-Blau }→ Dunkel Blau{ .StuVe-Text-Grau }→ Grau{ .Text-Info }→ Info Farbe{ .Text-Success }→ Erfolg Farbe{ .Text-Warning }→ Warnung Farbe{ .Text-Error }→ Fehler Farbe{ .Text-Default }→ Normale Farbe
¶ Inline CSS
Level: Fortgeschritten
Es ist in Markdown möglich einfach HTML zu schreiben. So kann auch
<span style="color:green; background-color:yellow;"> Hallo Welt </span>
wird dargestellt als:
Hallo Welt
Damit ein Text gestyled werden kann, muss er in einem <span> oder div eingeschlossen werden.
Dann kann per inline css z.B. die Textfarbe (color), die Hintergrundfarbe (background-color) und vieles mehr angepasst werden.
¶ Farbige Boxen
Text hier ...
{.box-grau}
... Text da ...
{.box-blau}
... Text überall.
(Es gehen auch mehrere Zeilen :smile: )
{.box-gruen}
Text hier …
… Text da …
… Text überall.
(Es gehen auch mehrere Zeilen 
)
¶ Zitate und Infoboxen
> Zitat
> Zweite Zeile
> Info Box
{.is-info}
> Erfolgs Box
{.is-success}
> Warnung
{.is-warning}
> Fehler
{.is-danger}
wird dargestellt als:
Zitat
Zweite Zeile
Info Box
Erfolgs Box
Warnung
Fehler
¶ Latex
Inline: 42 $\le$ 69
Block:
$$
\gamma^2+\theta^2=\omega^2
$$
wird dahrgestellt als:
Inline: 42 69
Block:
¶ Tabs
### Tabs {.tabset}
#### A
Text in Tab A
#### B
Text in Tab B
wird dahrgestellt als:
Text in Tab A
Text in Tab B
¶ Plant UML Diagramme
Diagramme sind nur im Markdown Editor verfügbar.
Auch ein Diagramm wird in einer speziellen Syntax geschrieben. Das Wiki unterstützt zwei verschiedene Syntaxe.
Hier wird jeweils nur ein sehr kleines Beispiel gebracht, jedoch immer auf die vollständige Dokumentation verwiesen.
Offizielle Dokumentation von PlantUML
Auch hier muss der Backslash in Zeile 9 weggelassen werden, wenn das Diagramm angezeigt werden soll.
Außerdem stellt PlantUML noch mehr Arten von Diagrammen bereit (Siehe Doku)
```plantuml
@startmindmap
* root node
* some first level node
* second level node
* another second level node
* another first level node
@endmindmap
\```
wird dargestellt als:
¶ Text-Templates
Hierbei handelt es sich um ein selbstgecoodetes Feature des C-Ref’s und ist nicht von Wiki-JS selbst
Achtung: Dieses Feature ist in Beta (spricht noch nicht Bug-Frei). Wenn dir ein Bug auffällt melde diese sehr gerne dem C-Ref, das wir den beheben können.
¶ Beispiel
Hallo {{Empfänger:Wem möchtest du schreiben?}}
Ich mag dich sehr 🥰!
Viele Grüße,
{{Sender:Wie hießt du?}}
Der Markdown Code um dieses Template zu erzeugen ist der foldende:
```template
Hallo {{Empfänger:Wem möchtest du schreiben?}}
Ich mag dich sehr 🥰!
Viele Grüße,
{{Sender:Wie hießt du?}}
```
Wichtig dabei ist, dass template als Code-Syntact genutzt wird (Zeile 1). Dadruch wird der Block automatisch als Template erkannt und das User Interface wird gerendert.
Die Eingaben werden nirgends gespeichert. Wenn die Seite neugeladen wird, sind die eingegeben Werte wieder zurückgesetzt.
¶ Syntax
Die Variable und der Placeholder dürfen beide nicht
:,{oder}enthalten. Sonst sind alle Zeichen erlaubt.
Um eine Variable zu definieren, muss sie einfach in zwei geschweifte Klammern gesetzt werden: {{my_variable}}.
Um dem User noch Hinweis für den korrekten Input zu geben ist es außerdem optional möglich eine Platzhalter zu definieren, dieser wird dann im Input-Feld angezeigt wenn diese leer ist: {{my_variable:placeholder}}
Eine Variable kann auch mehrfach in einem Text verwendet werden. Es wird dann eine Text-Box angezeigt die alle Nennungen der Variable ersetzt. Wenn eine Variable mehrfach verwendet reicht es, bei der ersten Nennung den Platzhalter anzugeben.
¶ Anwendungsmöglichkeiten
- Email Template
- Konfigurations Dateien
- Massen-Liebesbriefe,
- Text-Formulare
- …
Abgewandelt von The Zen of Python ↩︎