playground:styleguide
Inhaltsverzeichnis
Styleguide
Style
- Boxen verwenden zum Highlighten von wichtigen Infos, siehe Seite boxen
- Accordeon-Stil für einklappbare Textbausteine über Folded-Plugin nutzen: https://www.dokuwiki.org/plugin:folded, möglichst mit Hinweis auf Ausklappbarkeit wie z.B. 🔽-Symbol oder Zusatz „(ausklappen)“
- Keine Unterstreichung für Überschriften und Text-Highlights verwenden, denn Unterstreichungen sind für die Darstellung interner Verlinkungen reserviert. Für Highlights entweder Fettdruck oder
< wrap em > mein Text < / wrap >
nutzen - Navigation anpassen geht über diese Seite: sidebar
Bilder & Medien
- Bilder müssen ALT-Texte haben für Barrierefreiheit, Beispiel:
{ { Link zum Bild | ALT-Text als Bildbeschreibung, welcher bei Maus-Hover angezeigt und vom Screenreader vorgelesen werden kann } }
, alternativ bitte „Bild zur Dekoration“ schreiben, wenn Bild irrelevant für Inhalt ist - Bilder, Videos, PDFs und weitere Medien sollen im richtigen Namensraum einsortiert werden, kann über den Medien-Manager erfolgen/geprüft werden
- Hinterlegte Dateien wie z.B. PDFs im Text kennzeichnen, zum Beispiel durch den Zusatz „(PDF)“ in Klammern für Barrierefreiheit
- Umlaute in Dateinamen vermeiden
Namenskonventionen
- ISIS|Moodle, sofern die Pipe | im Text möglich ist und nicht der Bild- oder Link-Formatierung dient
Verlinkungen
- TU-Seiten über Kurzlinks verlinken, Kurzlink findet sich bei jeder Seite ganz am unteren Seitenende rechts und dann mit Rechtsklick auf „Link kopieren“ gehen. Beispiel:
https://www.tu.berlin/go55014/
statthttps://www.tu.berlin/zewk/arbeitsbereiche/wissenschaftliche-weiterbildung/medienproduktion
(Hintergrund: Lange Links verhindern u.a. Lesbarkeit im Wiki-Editor) - Umlaute in Links vermeiden
- möglichst keine versteckten Seiten anlegen, die nicht aus der Sidebar erreichbar sind, sowie keine verwaisten Seiten, die nicht über Backlinks erreichbar sind: nicht wartungsfreundlich (werden schnell vergessen)!
- neue Seiten im richtigen und sinnvollen Namensraum anlegen, z.B. eine Seite zu Mikrofonen im Namensraum Medien anlegen
medien:mikrofone
und nicht im Namensraumpruefung:mikrofone
und nicht auf der Hauptebene. Übersicht der Seiten und Namensräume: https://digit.zewk.tu-berlin.de/wiki/doku.php?id=sidebar&do=index oder über „Übersicht“ im Top-Menü oder über die Excel-Datei in unserem Isis-Kurs beim Wiki-Wartungstag - Interne Seiten immer über den namespace verlinken
[ [ pagename | link text ] ]
Rating-Plugin
Das Rating wird automatisch unter jeden Beitrag eingefügt und kann vom Ersteller nicht geändert oder ausgeblendet werden. Aktuelles Rating (10 beste Seiten): tag=ol,score=true,startdate=2024-04-01
Seitenmanagement
Mittels "display orphans"-Plugin lassen sich Seiten im Wiki finden, die verwaist, geplant und verlinkt sind.
Verwaist („Displays a table of orphaned pages, ie pages that exist but aren't linked to.“):
«display orphaned»
Geplant („Displays a table of wanted pages, ie pages that do not exist but are linked to.“):
«display wanted»
Verlinkt („ Displays a table of linked pages, ie pages that do exist and are linked to.“):
«display linked»