¶ How to Wiki
Im Folgenden findest du eine Zusammenfassung über die wichtigsten Funktionen des Wikis. Bei Fragen kannst du dich jederzeit an die zuständigen Administratoren wenden:
- Benno Hölz
- Matthias Ruf
Du möchtest dein Wissen über die Bedienung des Wikis prüfen? Hier findest du ein Online-Quiz!
¶ Grundlegender Aufbau & Navigation
Das Wiki ist in folgende Bereiche gegliedert:
- Navigations-Menü:
Hier kannst du schnell zu einzelnen Seiten navigieren. Über einen Klick aufDurchsuchenbzw.Hauptmenükannst du zwischen einer vorgegebenen Struktur bestimmter Seiten oder einer Navigation über alle Seiten umschalten. - Suchfeld:
Hier kannst du einfach nach bestimmten Inhalten oder Schlagwörtern suchen. - Seitenaktionen & neue Seite:
Hier kannst du die Eigenschaften einer Seite ändern, Seiten löschen oder neue Seiten erstellen. - Profil:
Hier gelangst du zu den Einstellungen deines Nutzer-Profils, und kannst dich mit deinem Wiki-Account an- oder abmelden (etwa um Seiten zu bearbeiten oder bestimmte Seiten sehen zu können). - Aktuelle Seite:
In der Hauptansicht siehst du die Seite, auf der du dich aktuell befindest. - Seiten-Inhalt & -Infos:
Hier siehst du ein Inhaltsverzeichnis der aktuellen Seite, Schlagwörter (nicht im Bild) und wer die Seite zuletzt bearbeitet hat. - Seite bearbeiten:
Hier kannst du die aktuelle Seite bearbeiten (mehr dazu im Abschnitt "Bearbeiten von Seiten").
¶ Erstellen von Seiten
¶ Seitenpfad
Eine neue Seite kann über das Stift-Symbol oben rechts angelegt werden:
Daraufhin öffnet sich ein Dialog zur Auswahl des Speicherortes:
Der Seitenpfad muss folgende Bedingungen erfüllen:
- Nur Kleinbuchstaben:
Ochsenhausenochsenhausen - Bindestriche (
-) statt Leerzeichen:ultimaker 2+ultimaker-2+ - Keine Umlaute und Sonderzeichen (
ä,ö,ü,ß, ...):gerätegeraete
Beispiele für einen richtigen und einen falschen Seitenpfad:
/ochsenhausen/geraete/cnc-fraese
/ochsenhausen/Geräte/CNC Fräse
¶ Seiten-Infos
Bei Erstellen einer Seite wird nach Eingabe ein Fenster zum Eingeben der Seiteninformationen angezeigt:
Hier kann ein Seitentitel (dieser darf auch Leerzeichen, Großbuchstaben und Sonderzeichen enthalten) und eine optionale Kurzbeschreibung vergeben werden. Auch der Seitenpfad kann hier bei Bedarf nochmals angepasst werden.
Zudem können Schlagwörter festgelegt werden, um bestimmte Seiten schneller finden zu können. Die Schlagwörter für eine Seite sollten der Kategorie entsprechen und es sollten dafür wenn möglich bereits existierende Schlagwörter verwendet werden. Auch hier gilt: keine Großbuchstaben, Leerzeichen oder Sonderzeichen verwenden!
Beispiele für Schlagwörter einer Anleitung für den 3D-Drucker "Ultimaker 2+":
geraete,3d-druck
Geräte,3D Druck
¶ Editor
Beim Erstellen einer Seite können verschiedene Editoren gewählt werden. Der ausgewählte Editor wird von nun an für diese Seite verwendet. Hierfür bitte immer den Markdown-Editor verwenden!
Auch wenn der visuelle Editor auf den ersten Blick einfacher erscheinen mag, sind Markdown-Seiten einfacher in der Handhabung, wenn es z.B. um Backups geht. Verwende deshalb bitte stets den Markdown-Editor. Eine Anleitung zu Markdown findest du weiter unten auf dieser Seite.
¶ Generelle Richtlinien zum Erstellen von Unterseiten
Beim Erstellen von Unterseiten solltest du ein paar Richtlinien beachten:
- Unterseiten sollten auf der jeweiligen Oberseite, am besten in Form einer
.{links-list}(siehe Abschnitt "Markdown -> Links und Dateien") verlinkt werden, damit einfacher zwischen den Seiten navigiert werden kann. - Aus Gründen der Übersichtlichkeit sollten lange Seiten zwar in Unterseiten aufgeteilt, aber auf der anderen Seite nicht zu viele kleine Unterseiten erstellt werden.
- Lange Seiten können auch durch die Verwendung von Tabsets (siehe Abschnitt "Markdown -> Tabs") übersichtlicher gestaltet werden, jedoch solltest du beachten, dass Inhalte in geschlossenen Tabs durch die Suchfunktion (Strg+F) des Browsers nicht richtig gefunden werden können.
¶ Bearbeiten von Seiten
Um existierende Seiten bearbeiten zu können (sofern du angemeldet bist und die nötigen Berechtigungen hast), kannst du unten rechts auf das Stift-Symbol klicken:
¶ Markdown
Um Wiki-Seiten zu erstellen, verwenden wir Markdown, eine standardisierte Syntax zur Formatierung von Texten. Die wichtigsten Markdown-Befehle sind unten aufgeführt.
¶ Der Markdown-Editor
Der Editor gliedert sich in mehrere Bereiche:
- Links kannst du Text und Markdown-Befehle eingeben (dazu gleich mehr), rechts siehst du die fertige Seite, wie sie später im Wiki angezeigt wird.
- Oberhalb des Editors befinden sich Knöpfe zur schnellen Formatierung von Text (z.B. fett, kursiv, Aufzählung)
- Über die Knöpfe links kannst du Links zu anderen Seiten, Dateien (z.B. Bilder/PDFs) und Diagramme einfügen.
- Über die Knöpfe rechts oben kannst du deine Bearbeitungen speichern, Seiteninformationen bearbeiten oder den Editor schließen.
¶ Grundlegende Markdown-Befehle
¶ Text-Formatierung
| fett | **fett** |
| kursiv | *kursiv* |
~~durchgestrichen~~ |
¶ Überschriften
Markdown unterstützt sechs Überschriften-Ebenen:
# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4
##### Überschrift 5
###### Überschrift 6
¶ Hoch- & Tiefstellen
| hochgestellerText | hochgesteller^Text^ |
| tiefgestellterText | tiefgestellter~Text~ |
¶ Farbige Blöcke
Blockzitat
> Blockzitat
Info Blockzitat
> Info Blockzitat
{.is-info}
Erfolg Blockzitat
> Erfolg Blockzitat
{.is-success}
Warnung Blockzitat
> Warnung Blockzitat
{.is-warning}
Fehler Blockzitat
> Fehler Blockzitat
{.is-danger}
¶ Listen
Ungeordnete Listen (Aufzählung):
- Element 1
- Element 2
- Element 1
- Element 2
Geordnete Listen (Nummerierung):
- Element 1
- Element 2
1. Element 1
2. Element 2
¶ Checklisten
Check-Listen können wie folgt erstellt werden:
- Nicht erledigtes Element
- Erledigtes Element
- [ ] Nicht erledigtes Element
- [x] Erledigtes Element
¶ Code & Tasten
Code |
`Code` |
| A | <kbd>A</kbd> |
Mehrzeiliger Code:
Zeile 1
Zeile 2
entsteht durch:
```
Zeile 1
Zeile 2
```
¶ Emojis
 |
:star: |
 |
:exclamation: |
 |
:question: |
 |
:white_check_mark: |
 |
:warning: |
 |
:x: |
 |
:+1: |
 |
:-1: |
 |
:computer: |
Eine Liste aller Markdown-Emojis findest du hier.
¶ Trennlinien
Eine waagrechte Trennlinie kann durch --- erstellt werden:
¶ Links & Dateien
Verlinkungen auf andere Wiki-Seiten, Datein oder externe Seiten können wie folgt oder über den Button links oben eingefügt werden:
| Geräte Ochsenhausen | [Geräte Ochsenhausen](/ochsenhausen/geraete) |
| SFZ-Logo | [SFZ-Logo](/allgemein/logo.png) |
| SFZ-Website | [SFZ-Website](https://sfz-bw.de/) |
Über
{.links-list}kann eine Liste von Links schön formatiert werden, bspw. um andere Seiten zu verlinken:
Geräte Ochsenhausen Geräte am Standort Ochsenhausen- [:gear: Geräte Ochsenhausen *Geräte am Standort Ochsenhausen*](/ochsenhausen/geraete)
{.links-list}
¶ Bilder
Um Bilder direkt in eine Markdown-Seite einzubinden, kann ein ! direkt vor den Link gesetzt werden: 
Über =<Höhe>x<Breite> kann die Höhe und/oder Breite angegeben werden, also z.B.  für ein SFZ-Logo der Höhe 100 Pixel:
Beim Hochladen von Bildern oder Dateien müssen aus Gründen der Übersichtlichkeit entsprechende Unterordner für die Seiten angelegt werden! (Bitte die Hinweise zum Anlegen von Ordnern im Abschnitt "Hochladen von Dateien" beachten!
¶ Tabellen
Tabellen ohne Kopfzeile:
| Zeile 1, Spalte 1 | Zeile 1, Spalte 2 |
| Zeile 2, Spalte 1 | Zeile 2, Spalte 2 |
|:-|:-|
| Zeile 1, Spalte 1 | Zeile 1, Spalte 2 |
| Zeile 2, Spalte 1 | Zeile 2, Spalte 2 |
Tabellen mit Kopfzeile:
| Überschrift 1 | Überschrift 2 |
|---|---|
| Zeile 1, Spalte 1 | Zeile 1, Spalte 2 |
| Zeile 2, Spalte 1 | Zeile 2, Spalte 2 |
| Überschrift 1 | Überschrift 2 |
|-------------------|-------------------|
| Zeile 1, Spalte 1 | Zeile 1, Spalte 2 |
| Zeile 2, Spalte 1 | Zeile 2, Spalte 2 |
Da vor allem größere Tabellen direkt in Markdown sehr aufwändig zu erstellen sind, kann z.B. die Website Tablesgenerator.com verwendet werden, um den Markdown-Code zu generieren. Hier können z.B. auch bestehende Excel-Tabellen eingefügt und kovertiert werden.
¶ Tabs
Um lange Seiten besser zu organisieren, können Tabs verwendet werden. Allerdings bringen Tabs auch Nachteile mit sich, etwa dass Inhalte von ungeöffneten Tabs nicht mit der Suchfunktion des Browsers gefunden werden können!
Im Vorschau-Modus des Markdown-Editors werden Tabs nicht richtig angezeigt.
Um Tabs zu erstellen, werden Überschriften unterhalb der aktuellen Überschriftenebene und der Befehl {.tabset} bebötigt:
##### Tabs {.tabset}
###### A
Inhalt von Tab A
###### B
Inhalt von Tab B
Inhalt von Tab A
Inhalt von Tab B
¶ Hochladen von Dateien
Beim Hochladen von Dateien müssen aus Gründen der Übersichtlichkeit Unterordner angelegt werden! Die Ordnerstruktur sollte dabei der Seitenstruktur entsprechen, also z.B. /ochsenhausen/software/cura/<bild-datei> für ein Bild das auf der Seite ochsenhausen/software/cura hochgeladen werden soll.
Bitte beim Anlegen von Ordnern auf den korrekten Speicherort und die richtige Schreibweise achten! In der aktuellen Version von WikiJS können falsch angelegte Ordner nicht gelöscht oder umbenannt werden!
Ein neuer Ordner kann über die Schaltfläche + Neuer Ordner angelegt werden. Über die Ordnersymbole oberhalb der Dateiliste kann nun zum gewünschten Ordner navigiert werden. Die hochzuladende Datei kann nun rechts auf die entsprechende Fläche gezogen und über einen Klick auf HOCHLADEN hochgeladen werden. Durch Auswählen der Datei aus der Liste und einen Klick auf EINFÜGEN kann die Datei bzw. das Bild an der aktuellen Stelle im Text eingefügt werden.
¶ Berechtigungen
Im Wiki existieren verschiedene Nutzergruppen, denen Benutzer zugeordnet werden können. Je nach Nutzergruppe hat ein Benutzer andere Berechtigungen:
- Guests (ohne Login):
- Bestimmte Seite lesen (Startseite & How to Wiki)
- Students (Schüler):
- Seiten lesen
- Bestimmte Seiten bearbeiten (mit entsprechender Projekt-Berechtigung)
- Editors (Editoren):
- Seiten lesen
- Seiten erstellen & bearbeiten
- Moderators (Moderatoren):
- Seiten lesen
- Seiten erstellen & bearbeiten
- Benutzer & Gruppen erstellen & verwalten
- Administrators (Administratoren):
- Seiten lesen
- Seiten erstellen & bearbeiten
- Benutzer & Gruppen erstellen & verwalten
- Wiki-Einstellungen ändern