Styleguide für den offenen Bereich des SyS-C Wiki

Hier werden Merkmale und Vorgaben zu Aufbau und Content der Seiten hinterlegt.

Aufbau

Namespace

Für jedes Produkt bzw. Gerätekategorie wird ein eigener Namespace vergeben. In jedem Namespace gibt es die Startseite (Landing Page), die den gleichen Namen trägt wie der Namespace. Diese bündelt zentrale Informationen (s.u.)

Für alle weiteren Inhalte zu dem Thema gibt es eigene Detailseiten.

Beispiel:

 id=sysc_cloud:sysc_cloud

Startseite

Logo (wenn möglich)
Kurzbeschreibung
Highlights
Pagelist (Plugin)

Am besten an vorhandenen Startseiten orientieren - viele der Plugins können 1:1 übertragen werden.

Detailseite

Footer

---- [<10>]

Tags, falls sinnvoll

 {{tag>Klassetag}}

Einsatz von Stilmitteln

Fett, Kursiv, usw.

fett: Dringlichkeit und bei Links zur besseren Lesbarkeit
kursiv: Eigennamen, Fachbegriffe, Feldbezeichnungen (Maskenbeschreibung)
unterstrichen: Hervorhebung, Betonung
wrap-Elemente: besondere Hervorhebung, z.B. Warnungen

Links

Interne Links, so kurz wie möglich (kein voll qualifizierter Pfad notwendig).

Interwiki-Links („2 Kettenglieder) - verwenden wenn möglich
syschelpdesk

syschelpdesk: https://ticket.sysc-chemnitz.de/{NAME}
sysccloud: https://cloud.sysc-chemnitz.de/{NAME}
syscmail: https://webmail.sysc-chemnitz.de/{NAME}
syscportal: https://portal.sysc-chemnitz.de/{NAME}

 
[[syscmail>]] --> https://webmail.sysc-chemnitz.de
[[syschelpdesk>tickets/new|Ticket neu]]

Externe Links erhalten „Weltkugelsymbol“. Weitere Symbole für PDF, Word.