Regeln für Artikel im Wiki

Aus SamsWiki
Zur Navigation springen Zur Suche springen

Aufbau der Seite

Seitenstruktur

  • Das Farb- und Textbanner steht am Anfang jeder Seite und kennzeichnet den Arbeitsbereich
  • Darunter liefert das Inhaltsverzeichnis eine erste Übersicht zum Thema und generiert sich automatisch aus den angelegten Überschriften
    • werden weniger als drei Überschriften erstellt, generiert sich kein Inhaltsverzeichnis
  • Der erste Punkt umfasst die Navigation, die erklärt wie man zu dieser Hauptseite gelangt und einen durch die Hauptmenüführung der aktuellen Seite leitet
  • Die weiteren Überschriften stellen die Menü-Inhalte detailliert dar

Seitenname

  • Die Seitennamen der Hilfeseiten werden mittels eines fest vorgegebenen Schlüssels im SAMS vergeben.
  • Zusätzlich sollten für alle wichtigen Funktionalitäten auch Klarnamen vergeben werden und auf die jeweiligen Hilfseiten mit dem Systembezeichnungen weitergeleitet werden.

Spezialseiten einzelner Landesverbände

  • Spezialseiten einzelner Landesverbände erhalten im Seitennamen am Ende einen Querstriche und die Verbandskennung, z.B. /SHVV, /SBVV, /VVRP, /DVL, /NVV

Seitenkopf mit Farb- und Textbanner

  • Der Seitenkopf wird mit dem entsprechenden Farb- und Textbanner des jeweiligen Bereichs gekennzeichnet.
  • Folgende Vorlagen stehen hierfür zur Verfügung

Regeln zur Formatierung

Überschriften

  • Überschriften werden in folgenden Kategorien angelet
  • Hauptmenüpunkte (Naviogation und Reiter) sind den Überschriften der Ebene 2 zuzuordnen
    • Anwendung: == "Hauptüberschrift" ==
  • Funktionen bzw. Unterrubriken werden als Überschriften der Ebene 3 dargestellt
    • Anwendung: === "Überschrift 2" ===
  • Unterfunktionen werden unter Überschriften der Ebene 4 aufgelistet
    • Anwendung: ==== "Überschrift 3" ====


Artikel

  • Die Artikel werden stets im Standardtextformat verfasst
  • Anstriche der Texte werden über * und ** am Zeilenanfang realisiert, wobei auch kurze, prägnante Absätze möglich sind
  • Schlüsselwörter und Schaltflächen, die angelickt werden müssen, werden fett hervorgehoben
    • Anwendung: Einbettung des zu markierenden Textes in drei Anführungsstriche '''Text'''
  • Anmerkungen und Hinweise werden kursiv dargestellt und Achtungsbefehle zusätzlich fett hinterlegt
    • Anwendung: ''Hinweis: Text''
    • Anwendung: ''Achtung: Text''
  • Sie werden linksbündig erstellt


Tabellen

  • Tabellen werden nach dem class="wikitable" Standard erstellt
  • Tabellenkopf ist hierbei farblich leicht abgegrenzt vom Rest der Tabelle
  • Spalten- und Zeilenbezeichnungen werden fett (!) und mittig (center) eingebunden über den Befehl (!)
  • Tabellen die mehrfach Anwendung finden sollen im Wiki werden als einmalige Vorlage gespeichert, um nachfolgend eine zentrale Tabelle zu bearbeiten
    • Anwendung: {{Vorlage:Tabellenbezeichnung}}
  • Im Code wird versucht die Tabellenform mit ihren Inhalten zu erhalten, d.h. die Inhalte werden Zeilenweise eingetragen
    • Anwendung:
| Zelle 1a || Zelle 2a
|-
| Zelle 1b || Zelle 2b


Beispieltabelle

Überschrift 1 Überschrift 2
Links1 Rechts1
Links2 Rechts2


Bilder

  • Fotos und Screenshots werden rechtsbündig eingebettet
  • Mit dem Befehl thumb wird eine Standardumrahmung geschaffen
  • Standardformat beträgt 400px oder 600px für eine einheitliche Darstellung
  • Bildtitel wird unter das Bild gesetzt
    • Anwendung: [[Bild:Dateiname.jpeg | thumb | 600px | Bildtitel]]
  • Absatz mit Code <br clear=all> abschließen, damit sich Bild und nachfolgende Überschriften/Absätze nicht überlappen.


Videos/Screencasts

  • Videos/Screencasts werden direkt auf der Wiki-Seite verlinkt
  • Komplexe Vorgänge werden anschaulich aufgearbeitet (sinnvolle Beitragsergänzung)
    • Anwendung: steht noch nicht zur Verfügung


Regeln zum Verfassen von Texten

  • prägnante Schritt-für-Schritt-Anleitungen
  • Anrede des Lesers erfolgt in Sie-Form
  • Aufzählungspunkte enden ohne Satzzeichen
  • Interne und weiterführende Links dienen der besseren Verständlichkeit eines Artikels
    • Anwendung: [[#Titel der zuverlinkenden Überschrift | dargestelltes Wort]]



Vorlagen

Seitenkopf Farb- und Textbanner

  • Folgende Vorlagen stehen hierbei zur Verfügung

Mitgliederbereich

Mitgliederbereich


SHVV-Mitgliederbereich
Shvv.jpeg

Mitgliederbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des SHVV.



VVRP-Mitgliederbereich
Vvrp.jpeg

Mitgliederbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des VVRP.



SBVV-Mitgliederbereich
Sbvv.jpeg

Mitgliederbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des SBVV.




DVV - Dritte Liga-Mitgliederbereich
Dvv.png

Mitgliederbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich der Dritten Ligen.



NVV-Mitgliederbereich
Nvv.jpeg

Mitgliederbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des NVV und BVV.




DVL-Mitgliederbereich
Dvl.png

Mitgliederbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich der DVL.








Adminbereich

ACHTUNG: Sie befinden sich im Adminbereich für Verbandsfunktionäre. Kein Zugriff im Mitgliederbereich.


SHVV-Adminbereich
Shvv.jpeg

Adminbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des SHVV.



VVRP-Adminbereich
Vvrp.jpeg

Adminbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des VVRP.




SBVV-Adminbereich
Sbvv.jpeg

Adminbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des SBVV.





DVV - Dritte Liga-Adminbereich
Dvv.png

Adminbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich der Dritten Liga.




NVV-Adminbereich
Nvv.jpeg

Adminbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des NVV und BVV.





DVL-Adminbereich
Dvl.png

Adminbereich | ACHTUNG: Die Angaben auf dieser Seite gelten nur für den Bereich des DVL.






Entwicklerbereich

Entwicklerbereich | ACHTUNG: Informationen auf dieser Seite sind nur für Entwickler

Kategorien

  • Jede Seite wird einer oder mehrerer Kategorien zugeordnet.

Hilfe für MediaWiki