Inhaltsverzeichnis
Styleguide für die einheitliche Formatierung
Texte
Folgende Schreibweisen werden in den Hilfetexten verwendet:
| Element | So sieht's aus | Beschreibung |
|---|---|---|
| Tastaturbefehl | STRG+X | <key>STRG-X</key> Keine weitere Formatierung, die wird ggf. automatisch gesetzt! |
| Menüpfad | System-Initialisierung > Terminkalender | fett & kursiv, Trennzeichen „>“ |
| Schaltfläche / Button | Buttontext | <key>Buttontext</key> Keine weitere Formatierung, die wird ggf. automatisch gesetzt! |
| Pfad im Dateisystem | C:\Rehaverwaltung | als Code formatiert Keine weitere Formatierung, die wird ggf. automatisch gesetzt! |
| vom Anwender einzugebender Text | Morbus Visite | als Code formatiert, fett & kursiv |
| Links zu Erklärungen / Abkürzungen | (siehe Abkürzungen) | Link, keine Fettschrift |
| Links zu anderen Wiki-Seiten | Startseite » Ärzte | Link mit Fettschrift (der #-Link für einen Anker innerhalb der Seite funktioniert nur für komplette Überschriften) |
| Verweis auf ini-Datei | rezept.ini | zwei Backslahes nach den öffnenden eckigen Klammern: **[[\\C:\RehaVerwaltung\ini\<ihre_IK>\rezept.ini|rezept.ini]]** |
| Wichtiger Hinweis, ohne farbig unterlegte Box | Achtung! Bitte unbedingt beachten! | fett, rot, Schriftgröße medium |
| Verschiedene Hinweis-Boxen | Vorsicht bissige Katze! | Wrap-Plugin, Icon zeigt einen Karton |
Wo finde ich noch weitere Formatierungen?
Auf der Syntax-Seite von dokuwiki.org.
Die Formatierung gefällt dir nicht?
Wenn Du eine Formatierung (z. B. bestimmte Abstände) unschön findest, sprich die anderen Bearbeiter im Wiki an (z. B. @Code_of_Conduct_gitlab, @ChristofReinke_gitlab). Bitte verwende keine falschen Formatierungen oder Gliederungen, indem Du z. B. einen Artikel mit einer Überschrift der 3. Ebene beginnst, nur weil sie Dir im Moment grafisch besser gefällt. Verwende stattdessen die richtige Überschrift (1. Ebene), und sprich an, ob wir die Schriftgröße verkleinern oder den Abstand vergrößern sollten. Wir haben bisher noch kein Feintuning an der Formatierung gemacht.
Grafiken
- Grafiken generell im webp-Format (kleinere verlustfrei, größere bei problematischer Dateigröße mit leichter Kompression). Als modernes Format ist webp sowohl JPG als auch PNG deutlich überlegen.
- Vektorgrafiken (z. B. Icons) werden direkt als SVG-Datei importiert.
- Benannt mit einem sprechenden Dateinamen (z. B. werkzeugleiste_stammdaten.webp)
- Ablage in dem Namensraum, der so heißt wie die 1. Glierungesebene (Über Thera-Pi, Bedienung, Stammdaten, Rezepte, …)
- Icons: 30 Pixel breit <html>{{</html>
:allg:icon_diskette.png?nolink&30 |<html>}} </html>
- Bilder: bis ~400 Pixel in Originalgröße, darüber auf 200/300/400/600 Pixel skaliert mit Link auf's Original.
- Grafiken ausrichten durch der Leerzeichen:
- {{wiki:dokuwiki-128.png |Linksbündig}}
- {{ wiki:dokuwiki-128.png |Zentriert }}
- {{ wiki:dokuwiki-128.png|Rechtsbündig}}
Test
- Externer File-Link (2localhost) (in Firefox nur RMT + copy&paste möglich)
Test maximale Breite
Der Inhaltsbereich ist 898 Pixel breit.
Test SVG
Test ul
- Ein wirklich wichtiger Punkt
- Ein wirklich wichtiger Punkt
- Ein wirklich wichtiger Punkt
- Ein wirklich wichtiger Punkt
- Ein wirklich wichtiger Punkt
- Ein wirklich wichtiger Punkt