3.5 KiB
| title | description | published | date | tags | editor | dateCreated |
|---|---|---|---|---|---|---|
| Wiki.js | true | 2021-04-03T13:44:47.484Z | markdown | 2021-03-24T20:05:08.805Z |
Nutzung von Wiki.js
Unser Wiki soll alle nötigen Information über den Bastelei e. V. und zur Nutzung unserer Dienste bereitstellen. Dies beinhaltet also vor allem Seiten wie diese, um zu erklären wofür und vor allem wie ein Dienst genutzt werden kann. Wenn du mit dich mit deinem we.bstly-Account eingeloggt hast bietet dir Wiki.js genau zwei Kernfunktionen:
- eine neue Seite erstellen
- eine vorhanden Seite bearbeiten
Da dies in der Handhabung identisch sind, wird es hier eher um Einhaltung der gewünschten Struktur sowie der Formatierung gehen.
Auswahl des Editors
Wir verwenden aktuell für alle Wiki Seiten den Markdown Editor. Solltest du also eine neue Seite erstellen, wähle bitte Markdown aus. Vorhande Seiten sollten sich bereite im Markdown Editor öffnen. Wiki.js bietet eine Backup-/Synchronisation über Git an, so dass alle Wiki Inhalte auch in unserem Git-Repository zur Verfügung stehen. Der Editor selbst bietet auch eine Auswahl an Formatierungen an, es ist allerdings zu empfehlen sich ein mal kurz mit der Markdown Syntax [englisch] auseinander zu setzen.
Hierarchien
Eine Seite sollte mit einer H1 Überschrift 1 mit dem Seitentitel beginnen. Nachfolgende Abschnitte sollen mit H2 aufgeteilt werden. Wir verwenden zusätzlich zu den automatisierten Ankern noch Kurzformen für die einzelnen Abschnitte. Daher sollte nach jeder Überschrift noch ein <a name="shortword" id="shortword"></a> eingefügt werden, wobei eine kleingeschriebene, englische Kurzform für den Abschnitt gewählt werden sollte.
Verlinkungen
Nach Möglichkeit sollten Referenzen zu anderen Wiki Seiten sowie zu anderen Diensten oder Informationen auch entsprechend verlinkt werden. Des weiteren sollten nach Möglichkeit Verankerungen zu Abschnitten innerhalb der Seite angegeben werden. Dazu können die in Hierarchien angegebenen Anker genutzt werden.
Hervorhebungen
Namen von Diensten, Unternehmen oder anderen Bezeichnern bitte kursiv darstellen, wenn diese nicht explizit verlinkt werden. Kontrollelemente oder Schaltflächen sowie Betonungen werden fett dargestellt.
Zusätzliche Informationen
Zusätzlich zu üblichen Blockzitaten in Markdown bietet Wiki.js die Möglichkeit diesen ein zusätzliches Attribut zuzufügen. Wir nutzen dies um wichtige Zusatzinformationen an den entsprechenden Stellen einzublenden.
Das Info Blockzitat bietet sich zum Hervorheben von ergänzenden Informationen an um z.B. Hinweise zur Nutzung zu geben, die eventuell nicht alle Benutzer betreffen oder zur Verlinkung auf weiterführende Informationen. {.is-info}
Das Warnung Blockzitat sollte der Namensgebung folgen und Warnungen und Informationen z.B. bei der Nutzung bestimmter Dienste oder Funktionen geben. Auch wenn Benutzer etwas unbedingt beachten sollten, bietet sich die Hervorhebung durch ein Warnung Blockzitat an. {.is-warning}
Das Fehler Blockzitat wird verwendet wenn Informationen unvollständig oder fehlerhaft sind. Verwende dieses also um diese Fehler sofort sichtbar zu machen. {.is-danger}