Spielwiese/Wiki-Regeln2: Unterschied zwischen den Versionen
K |
K |
||
Zeile 1: | Zeile 1: | ||
{{DISPLAYTITLE:Wiki-Regeln}} | {{DISPLAYTITLE:Wiki-Regeln}} | ||
− | + | {{TOC}} | |
'''Diese Seite beschreibt die Regeln für zukünftige Seiten im Wiki'''<br> | '''Diese Seite beschreibt die Regeln für zukünftige Seiten im Wiki'''<br> | ||
Entwurf im Dezember 2018 / Januar 2019<br> | Entwurf im Dezember 2018 / Januar 2019<br> | ||
Zeile 16: | Zeile 16: | ||
|- | |- | ||
| style="width: 350px;" | || style="width: 350px;" | <nowiki>{{DISPLAYTITLE:So-soll-diese-Seite-heißen}}</nowiki> || Gibt den Seiten-Titel an. Auf dieser Seite z. B.: 'Wiki-Regeln' | | style="width: 350px;" | || style="width: 350px;" | <nowiki>{{DISPLAYTITLE:So-soll-diese-Seite-heißen}}</nowiki> || Gibt den Seiten-Titel an. Auf dieser Seite z. B.: 'Wiki-Regeln' | ||
+ | |- | ||
+ | | Inhaltsverzeichnis || {{TOC/Syntax}} | ||
+ | | [[Vorlage:TOC | Vorlage]] <br> {{TOC/Doku}} | ||
|- | |- | ||
| '''Sinn und Zweck der Seite in einem Satz und fett''' || <nowiki>'''Sinn und Zweck der Seite in einem Satz und fett'''</nowiki>|| | | '''Sinn und Zweck der Seite in einem Satz und fett''' || <nowiki>'''Sinn und Zweck der Seite in einem Satz und fett'''</nowiki>|| | ||
Zeile 37: | Zeile 40: | ||
|} | |} | ||
|- | |- | ||
− | | | + | | |
+ | ---- | ||
+ | | ---- || Horizontale Trenn-Linie | ||
|- | |- | ||
| Einleitung<br>Kurze Beschreibung des Themas, der Voraussetzungen, des Einsatz-Zwecks etc. || ===Einleitung=== (Überschrift 3) || Erst hier kommt die erste als Überschrift formatierte Zeile! | | Einleitung<br>Kurze Beschreibung des Themas, der Voraussetzungen, des Einsatz-Zwecks etc. || ===Einleitung=== (Überschrift 3) || Erst hier kommt die erste als Überschrift formatierte Zeile! |
Version vom 11. April 2019, 10:36 Uhr
Inhaltsverzeichnis
Diese Seite beschreibt die Regeln für zukünftige Seiten im Wiki
Entwurf im Dezember 2018 / Januar 2019
Bestehende Regeln wurden verschriftlicht und angepasst.
Einleitung
Es werden hier bestehende Regeln zussammengefasst und aktualisiert.
Ein Anspruch auf vollständigkeit besteht nicht, wird aber angestrebt;-)
Alle neuen Artikel sollten diese Vorgaben einhalten - sie sind unser Aushängeschild!
Aufbau eines Wiki-Artikels
Inhalte | Formatierung | Hinweis | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
{{DISPLAYTITLE:So-soll-diese-Seite-heißen}} | Gibt den Seiten-Titel an. Auf dieser Seite z. B.: 'Wiki-Regeln' | |||||||||||
Inhaltsverzeichnis | {{TOC}} {{ TOC | optionale Parameter }} |
Vorlage Setzt das Inhaltsverzeichnis in einen rechtsbündigen Kasten. Schrift und Zeilenabstand sind etwas kleiner als normal.
| ||||||||||
Sinn und Zweck der Seite in einem Satz und fett | '''Sinn und Zweck der Seite in einem Satz und fett''' | |||||||||||
Letzte Anpassung zur Version: 47.11 | Versionsnummer fett | |||||||||||
Bemerkung: Was wurde geändert Ein kurzes Changelog, das auch ein bischen Verkaufshilfe sein darf! |
||||||||||||
Vorherige Version: 11.6.12 | 11.7 | Vorherige Version:
Hier: [[UTM/VPN/IPSec-S2S_v11.6 | 11.6.12]] | [[UTM/VPN/IPSec-S2S | 11.7]] |
| ||||||||||
|
---- | Horizontale Trenn-Linie | ||||||||||
Einleitung Kurze Beschreibung des Themas, der Voraussetzungen, des Einsatz-Zwecks etc. |
===Einleitung=== (Überschrift 3) | Erst hier kommt die erste als Überschrift formatierte Zeile! | ||||||||||
Vorbereitung | ggf.:===Vorbereitung=== (Überschrift 3) | Vorbereitende Aufgaben, die nicht im eigentliche Sinne zu der beschriebenen Aufgabe gehören, aber als Voraussetzung erfüllt sein müssen. | ||||||||||
Konfiguration | ===Konfiguration=== (=Überschrift 3) {{ pt | Bildname.png }}Wo startet die Konfiguration? |
Beschreibung direkt im Anschluss an die Vorlage {{pt |...}} Das sorgt dafür, daß der Text oben bündig mit dem Bild abschließt. | ||||||||||
Schritt 1 | ==== Schritt 1==== (=Überschrift 4) | |||||||||||
{{pt | Bildname.png}}
|
Beschreibung, was in diesem Schritt erfolgt | |||||||||||
<br clear=all> | ||||||||||||
Schritt 2 | ==== Schritt 2==== (=Überschrift 4) | |||||||||||
{{pt | Bildname.png}}
|
Beschreibung, was in diesem Schritt erfolgt | |||||||||||
<br clear=all>
etc.
| ||||||||||||
Weitere Schritte, außerhalb des Konfigurationsassistenten | ===Weitere Schritte, außerhalb des Konfigurationsassistenten=== (=Überschrift 3) {{ pt | Bildname.png}} | |||||||||||
{{pt | Bildname.png}}
|
Beschreibung, was in diesem Schritt erfolgt | |||||||||||
<br clear=all> | ||||||||||||
Abschluss | ===Abschluss=== (Überschrift 3) | Eine Endkontrolle und Beschreibung, was jetzt vorliegen sollte. ggf. mit Abbildung |
Formulierungen
- Direkte Anreden werden vermieden.
Also: Statt: Wählen Sie dies und das => Auswahl von diesem und jenem... - Bezeichnung der Netzwerke
- Das Netz hinter der Firewall ist das lokale Netz bzw. interne Netz (Internal Network), angeschlossen an eth1 (Internal Interface)
- Das Netz vor der Firewall ist das Transfer-Netz bzw. externe Netz (external Network), angeschlossen an eth0
Bezeichnungen: Externes Netz, external Network, die Zone dazu ist die external zone
Farben
Farben werden in Abähngigkeit der verwendeten Anwendung definiert. Verwendung: {{Farbe | Farbwert }}. Parameter siehe Vorlage .
Format-Vorlagen
Beispiel | Verwendung | Beschreibung | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code |
<code>Eingabe-Text</code> | Text der eingegeben werden muss | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Standardwert |
{{ StandardWert | Wert | Optionaler Tooltip-Text}}" ]] {{ sw | Wert }} |
Vorlage, für Standardwerte, die geändert werden können. Tooltipvorgabe ist: Standardwert. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Button |
{{Button | Button-Text | Option}} | Vorlage für Schaltflächen Als Option stehen verschiedene Schalter zur Verfügung. Es reicht, den, bzw. die Hervorgehobenen Buchstaben anzugeben. Der Schalter ist nicht Case-sensitive | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Reiter | {{Reiter | Reiter_Text }} | Vorlage für Reiter | |||||||||||||||||||||||||||||||||||||||||||||||||||||
→ Menü →Untermenü | {{ Menu | Eintrag1 | Optional: Eintrag2 | Optional: Eintrag3 }} | Vorlage für Menüeinträge Formatiert bis zu 3 Einträge im Menü-Layout der UTM mit jeweils einem Pfeil davor. → Menü1 →Menü2 →Menü3 Optional: Als 2. Paramater ein 'n' | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Beschriftung | {{Beschriftung |Meine_Beschriftung}} | Vorlage für Beschriftungen für Felder, in die Werte eingetragen werden müssen | |||||||||||||||||||||||||||||||||||||||||||||||||||||
╭╴ Kasten ╶╮ KastenGrau Kasten |
{{Kasten|Kasten_Text}} {{Kasten |KastenGrau_Text | grau}} {{ Kasten | Kasten | blau | fc=yellow; }} |
Vorlage für Gruppenbeschriftungen, die einen durchgezogenen Kasten unterbrechen Überschriften von Datentabellen | |||||||||||||||||||||||||||||||||||||||||||||||||||||
{{ButtonAn | Button_Text}} | Vorlage für in der Standard-Einstellung aktivierte Buttons | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{ButtonAus | Button_Text}} | Vorlage für in der Standard-Einstellung deaktivierte Buttons | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Positiv Hinweis |
{{ Hinweis | Poisitv-Text | grün }} {{ Hinweis | Hinweis-Text | gelb }} |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Diese Vorlage blendet einen farblich hinterlegten Text ein. Er kann automatisch ausgeblendet werden.
Das aktuelle Majorrelease der UTM z.B. ist: 11.8.5 Der Wert {{#titleparts: {{{ 2 | {{fullurl:{{FULLPAGENAMEE}} }} }}} | 1 | 4 }} wertet anhand der URL die Anwendung aus. Hier: fullurl: https://wiki.securepoint.de/Spielwiese/Wiki-Regeln2 Mein Wert: 11.0714 verglichen mit Majorrelease: 11.08 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Schaltfläche | {{spc | Schaltfläche oder Symbol-Kürzel | Formatierung | Option }} | Schaltflächen in der Securepoint Cloud . Es wird eine formatierte Schaltfläche mit Beschriftung angezeigt. Formatierung: (als 2. Argument)
Option (als 3. Argument):
- oder x : Nur Icon, ohne Text Zahlreiche Icons, z.B.: Details in der Vorlage. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{{Archivhinweis | Spielwiese/Wiki-Regeln}} | Archiv-Tag, damit so markierte Seiten in der Suche erst am Schluss auftauchen. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
{{ h3 | Unsichtbare Überschriften {{ h4 | |
{{h3 | Unsichtbare_Überschrift3 }} {{h3 | Unsichtbar | sichtbar }} |
Formatierte Überschriften sehen im Inhaltsverzeichnis seltsam aus, manchmal sollen sie auch im Text nicht extra auftauchen. Optional kann direkt ein sichtbarer Text übergeben werden. Es stehen die Vorlagen {{h3 |... bis {{ h6 | ... zur verfügung | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Zentriert |
{{center | Zentrierter-Text }} | Vorlage, die Text innerhalb einer div-Box zentriert. Wird benötigt für Vorlagen, die keine <...>-Tags verkraften | |||||||||||||||||||||||||||||||||||||||||||||||||||||
SehrlangerCodeTextohneTrennzeichen | {{code | Code-Text }} | Vorlage, die Text als Code formatiert und einen Zeilenumbruch im Wort erzwingt. Wichtig für Code, der mit Doppelklick kopiert werden können soll. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Anzeige-Text | {{ Hover | Anzeige-Text | mit Hover-Erklärung }} | Erzeugt eine Hover-Blase mit einem Text, wenn man mit der Maus über den gepunktet-unterstrichenen Text fährt |
Layout
Feldbeschriftungen und deren Eingabewerte werden zweispaltig jeweils linksbündig wie folgt formatiert:
- Vorlage {{TabDL | Linksbündiger_Text | Tab_Text }}
Kurzform {{td | ...}} -
- Die Standardbreite (width) beträgt 16em und kann mit z.B. | w=100px geändert werden (beliebige Einheit).
- Der Standardabstand (margin) nach unten beträgt 0px und kann mit z.B. | m=3px überschrieben werden
- Eingerückte Listen werden erzeugt, indem innerhalb der Vorlage ein Zeilenumbruch und in der neuen Zeile ein * eingefügt wird.{{td | xyz↩* Listentext}}
- {{ a | 1 }}
- erzeugt einen kleinen Abstand in Höhe von n Pixeln zur nächsten Zeile
Inhalte
- Einzelne Schritte werden mit den gleichen, vollständigen Bezeichnungen beschrieben, wie auch in der Software bezeichnet
- Schritte so ausführlich, dass man auch mit wenig Fachwissen, den gewünschten Schritt nachvollziehen kann.
- Erklärung, was die Funktion tut
- Keine Erklärungen, warum etwas so sein muss (das gehört in die Zertifizierungs-Schulung).
- Bei Nutzung von Texten, Bildern, Software oder sonstiger Quellen externer Herkunft sind unbedingt © Copyright- oder Lizenz-Hinweise anzugeben.
Bilder
- Benennung:
[Produkt-Kürzel]
_v[Versionsnummer]
_[Thema]
_[Schritt]
[Nummer].png
z.B.: UTM_v11-7_SSL-VPN_Vorbereitung2.png - grundsätzlich rechtsbündig, zugehöriger Text links davon, Kurzbesschreibung unter dem Bild. Breite ca 450 Pixel
Das ist gut zu erreichen mit {{ pt | Bildname | Legende }}Ohne_Leerzeichen und neue Zeile Text der links davon auf gleicher Höhe erscheinen soll. Bildgröße und Position lassen sich ändern, siehe Vorlage - Upload der Bilder auf der Seite Spezial:Hochladen
- Schaltflächen im Fießtext sind möglichst nicht als Bilder darzustellen.
Wenn doch: 20 Pixel hoch und ohne Link also:
[[Datei:Bildname.png|x20px|Link=]]
Besser: {{Button |Button_Text}} - Abschluss eines Absatzes mit Bild erfolgt mit
<br clear=all>
Das sorgt dafür, daß ein neuer Abschnitt erst unterhalb eines Bildes des aktuellen Abschnittes beginnt.
Zusammenfassung
Im Ergebnis erhalten wir ein einheitlich layoutetes Wiki, in dem man jederzeit an gleicher Stelle und in gleicher Reihenfolge seine Informationen erhält.