|
|
| (9 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) |
| Zeile 1: |
Zeile 1: |
| − | {{DISPLAYTITLE:Wiki-Regeln}}
| + | #REDIRECT [[Spielwiese/Wiki-Regeln]] |
| − | {{TOC}}
| |
| − | '''Diese Seite beschreibt die Regeln für zukünftige Seiten im Wiki'''<br>
| |
| − | Entwurf im Dezember 2018 / Januar 2019<br>
| |
| − | Bestehende Regeln wurden verschriftlicht und angepasst.<br>
| |
| − | | |
| − | =Einleitung=
| |
| − | Es werden hier bestehende Regeln zussammengefasst und aktualisiert.<br>
| |
| − | Ein Anspruch auf vollständigkeit besteht nicht, wird aber angestrebt;-)<br>
| |
| − | Alle neuen Artikel sollten diese Vorgaben einhalten - sie sind unser Aushängeschild!
| |
| − | | |
| − | ==Aufbau eines Wiki-Artikels==
| |
| − | | |
| − | {| class="table wikitable"
| |
| − | ! Inhalte !! Formatierung !! Hinweis
| |
| − | |-
| |
| − | | 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 || {{TOC2/Syntax}}
| |
| − | | [[Vorlage:TOC2 | Vorlage]] <br> {{TOC2/Doku}}
| |
| − | |-
| |
| − | | '''Sinn und Zweck der Seite in einem Satz und fett''' || <nowiki>{{TOC2 | Sinn und Zweck der Seite in einem Satz und fett}}</nowiki>||
| |
| − | |-
| |
| − | | Letzte Anpassung zur Version: '''47.11''' || <nowiki>Letzte Anpassung zur Version: '''47.11'''</nowiki> ||Versionsnummer fett
| |
| − | |-
| |
| − | | {{ td | Bemerkung: |
| |
| − | * Was wurde geändert
| |
| − | * Ein kurzes Changelog, das auch ein bisschen Verkaufshilfe sein darf!|w=80px}}
| |
| − | | <nowiki>{{ td | Bemerkung: |</nowiki><br><nowiki>* Was wurde geändert</nowiki><br><nowiki>* Changelog</nowiki><br><nowiki>| w=80px }}</nowiki> ||
| |
| − | |-
| |
| − | | Vorherige Version: [[UTM/VPN/IPSec-S2S_v11.6 | 11.6.12]] | [[UTM/VPN/IPSec-S2S | 11.7]] || Vorherige Version:
| |
| − | <p>Hier: '''<nowiki>[[</nowiki>'''''UTM/VPN/IPSec-S2S_v11.6'' '''<nowiki>|</nowiki>''' ''11.6.12'''''<nowiki>]] | [[</nowiki>'''''UTM/VPN/IPSec-S2S'' '''<nowiki>|</nowiki>''' ''11.7'''''<nowiki>]]</nowiki>'''</p>
| |
| − | | Nur bei UTM. Nicht bei AV, MobSec, da dort Systembedingt weitestgehend nur aktuelle Versionen vorzufinden sind.<br>
| |
| − | In den alten Seiten muss ein Archiv-Tag eingefügt werden!
| |
| − | |-
| |
| − | | Nur bei veralteten Artikeln:{{Archivhinweis | Spielwiese/Wiki-Regeln}}
| |
| − | | {{Archivhinweis/Syntax}} || [[Vorlage:Archivhinweis | Vorlage]]{{Archivhinweis/Doku}}
| |
| − | |-
| |
| − | |
| |
| − | ----
| |
| − | | ----(4x Minuszeichen am Anfang einer Zeile) || 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!
| |
| − | |-
| |
| − | | 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
| |
| − | |-
| |
| − | | style="max-width:300px;" |{{pt2|Start utm2.png|Übersichts-Screenshot|{{Reiter|Formatierte Überschrift}} }} Konfigurationstext
| |
| − | | <nowiki>{{ pt2 | Bildname | Legende | {{h3 | Überschrift fürs Inhaltsverzeichnis | {{ Reiter | Formatierte Überschrift}} }} }}</nowiki>||{{pt2/Doku}}
| |
| − | |-
| |
| − | | Schritt 1 || ==== Schritt 1==== (=Überschrift 4) ||
| |
| − | |-
| |
| − | |
| |
| − | * Unter-Schritt 1.1
| |
| − | * Unter-Schritt 1.2
| |
| − | * Unter-Schritt 1.3
| |
| − | |<nowiki>{{pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}</nowiki><br>* Unter-Schritt 1.1<br>* Unter-Schritt 1.2<br>* Unter-Schritt 1.3<br><nowiki><br clear=all></nowiki> || Beschreibung, was in diesem Schritt erfolgt
| |
| − | |-
| |
| − | | Schritt 2 || ==== Schritt 2==== (=Überschrift 4)
| |
| − | |-
| |
| − | |
| |
| − | * Unter-Schritt 2.1
| |
| − | * Unter-Schritt 2.2
| |
| − | * Unter-Schritt 2.3
| |
| − | |<nowiki>{{pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}</nowiki><br>* Unter-Schritt 2.1<br>* Unter-Schritt 2.2<br>* Unter-Schritt 2.3<br> <nowiki><br clear=all></nowiki> || Beschreibung, was in diesem Schritt erfolgt
| |
| − | |-
| |
| − | | etc.pp<br>
| |
| − | |-
| |
| − | | Abschluss || ===Abschluss=== (Überschrift 3) || Eine Endkontrolle und Beschreibung, was jetzt vorliegen sollte.<br>ggf. mit Abbildung<br><br>
| |
| − | |}
| |
| − | | |
| − | ==Formulierungen==
| |
| − | * Direkte Anreden werden vermieden.<br> Also: Statt: Wählen Sie dies und das => Auswahl von diesem und jenem...<br><br>
| |
| − | {{pt2|Zonenkonzept.png|hochkant=1 | Zonenkonzept |Bezeichnung der Netzwerke}} <p>
| |
| − | * Das Netz hinter der Firewall ist das '''lokale Netz''' bzw. '''interne Netz''' (Internal Network), angeschlossen an eth1 (Internal Interface)</p>
| |
| − | * Das Netz vor der Firewall ist das '''Transfer-Netz''' bzw. '''externe Netz''' (external Network), angeschlossen an eth0<p>
| |
| − | Bezeichnungen: Externes Netz, external Network, die Zone dazu ist die '''external zone'''</p>
| |
| − | <br clear=all>
| |
| − | <br><br>
| |
| − | | |
| − | == Farben==
| |
| − | Farben werden in Abhängigkeit der verwendeten Anwendung definiert.
| |
| − | Verwendung: <nowiki>{{Farbe | Farbwert }}</nowiki>. Parameter siehe [[Vorlage:Farbe | Vorlage]] .
| |
| − | ==Format-Vorlagen==
| |
| − | | |
| − | | |
| − | {| border="0" {{prettytable}}
| |
| − | | |
| − | !'''Beispiel''' !! |'''Verwendung''' !! Beschreibung
| |
| − | |-
| |
| − | | <code>code</code> || <nowiki><code>Eingabe-Text</code></nowiki> || Text der eingegeben werden muss
| |
| − | |-
| |
| − | | {{ StandardWert | Standardwert | Standardwert }} || <nowiki>{{ StandardWert | Wert | Optionaler Tooltip-Text}}" ]] </nowiki><br><nowiki>{{ sw | Wert }}</nowiki> || [[Vorlage:StandardWert | Vorlage]], für Standardwerte, die geändert werden können. <br>Tooltipvorgabe ist: Standardwert.
| |
| − | |-
| |
| − | | {{ Button | Button }} || {{ Button/Syntax}} || [[Vorlage:Button | Vorlage]] {{ Button/Doku}}
| |
| − | |-
| |
| − | | {{ Reiter | Reiter }} || {{Reiter/Syntax}} || [[Vorlage:Reiter | Vorlage]] {{Reiter/Doku}}
| |
| − | |-
| |
| − | | {{ Menu | Menü | Untermenü }} || {{ Menu/Syntax}} || [[Vorlage:Menu |Vorlage]] für Menüeinträge<br>{{Menu/Doku}}
| |
| − | |-
| |
| − | | {{ Beschriftung | Beschriftung }} || {{Beschriftung/Syntax}}
| |
| − | | [[Vorlage:Beschriftung | Vorlage]] für Beschriftungen {{Beschriftung/Doku}}
| |
| − | |-
| |
| − | | {{ Kasten | Kasten }} <br><br>{{ Kasten | KastenGrau | grau }}<br>{{ Kasten | Kasten | blau | fc=yellow; }}|| {{Kasten/Syntax}}<br><br><nowiki>{{Kasten |KastenGrau_Text | grau}}</nowiki><br><nowiki>{{ Kasten | Kasten | blau | fc=yellow; }}</nowiki> || [[Vorlage:Kasten | Vorlage]] für Gruppenbeschriftungen, die einen durchgezogenen Kasten unterbrechen<br> Überschriften von Datentabellen {{Kasten/Doku}}
| |
| − | |-
| |
| − | | {{ ButtonAn | Ein }} || {{ ButtonAn/Syntax}} || [[Vorlage:ButtonAn | Vorlage]] für in der Standard-Einstellung aktivierte Buttons. {{ ButtonAn/Doku}}
| |
| − | |-
| |
| − | | {{ ButtonAus | Aus }} || <nowiki>{{ButtonAus | Button_Text}}</nowiki> || [[Vorlage:ButtonAus | Vorlage]] für in der Standard-Einstellung deaktivierte Buttons
| |
| − | |-
| |
| − | | {{ Hinweis | Positiv | grün }} <br><br>
| |
| − | {{ Hinweis | Hinweis | gelb }} <br><br>
| |
| − | {{ Hinweis | ! Warnung }} <br><br>
| |
| − | {{ Hinweis | Neu in 11.8 | 99 }} <br><br>
| |
| − | {{ Hinweis | Neu-in 11.8 | bc=grün}} <br><br>
| |
| − | {{ Hinweis | ! güner § und normaler Text | grün}} <br><br>
| |
| − | {{ Hinweis | ! Andere Farbe | bc=#2bc6b9;}} <br><br>
| |
| − | | <nowiki>{{ Hinweis | Poisitv-Text | grün }} </nowiki><br><br>
| |
| − | <nowiki>{{ Hinweis | Hinweis-Text | gelb }} </nowiki><br><br>
| |
| − | <nowiki>{{ Hinweis | ! Warnungs-Text }} </nowiki><br><br>
| |
| − | <nowiki>{{ Hinweis | Neu in 11.8 | 11.8 }} </nowiki><br><br>
| |
| − | <nowiki>{{ Hinweis | Neu-Text | 11.8 | grün}} </nowiki><br><br>
| |
| − | <nowiki>{{ Hinweis | ! güner § und normaler Text | grün}}</nowiki> <br><br>
| |
| − | <nowiki>{{ Hinweis | ! Andere Farbe | bc=#2bc6b9;}} </nowiki><br><br>
| |
| − | |
| |
| − | |-
| |
| − | | {{Hinweis/Doku}}
| |
| − | |-
| |
| − | | |
| − | |-
| |
| − | | {{ spc | Schaltfläche }} || <nowiki>{{spc | Schaltfläche oder Symbol-Kürzel | Formatierung | Option }} </nowiki>|| Schaltflächen in der Securepoint Cloud .<br>Es wird eine formatierte Schaltfläche mit Beschriftung angezeigt.<br> Formatierung: (als 2. Argument) <br>
| |
| − | : {{ spc | Button | b}} '''B'''utton / Schaltflächen {{a|5}}
| |
| − | : {{ spc | Menü | m}} '''M'''enü{{a|5}}
| |
| − | : {{spc | Eigenschaft | e }} '''E'''igenschaft{{a|5}}
| |
| − | : '''O'''hne
| |
| − | : Die Standardbreite ist bei Buttons dynamisch, ansonsten 100px. Der Wert kann mit dem Parameter '''w=''120''px''' (width)geändert werden.<br>
| |
| − | : Der Standardabstand nach rechts ist 0px. Der Wert kann mit dem Parameter '''mr=''10''px''' (margin-right) geändert werden.<br>
| |
| − | Option (als 3. Argument):
| |
| − | '''-''' oder '''x''' : Nur Icon, ohne Text<br>Symbole:<br>
| |
| − | | |
| − | Zahlreiche Icons, z.B.: {{ spc | t | o |- }} {{ spc | a | o |- }} {{ spc | b | o | -}} Details in der [[Vorlage:spc | Vorlage]].
| |
| − | |-
| |
| − | | {{Archivhinweis | Spielwiese/Wiki-Regeln}}
| |
| − | |<nowiki>{{Archivhinweis | Spielwiese/Wiki-Regeln}}</nowiki>
| |
| − | | Archiv-Tag, damit so markierte Seiten in der Suche erst am Schluss auftauchen.
| |
| − | |-
| |
| − | | <nowiki>{{ h3 | </nowiki> Unsichtbare Überschriften <br>
| |
| − | <nowiki>{{ h4 |</nowiki><br>
| |
| − | <nowiki>{{ h5 |</nowiki><br>
| |
| − | <nowiki>{{ h6 |</nowiki>
| |
| − | |<nowiki>{{h3 | Unsichtbare_Überschrift3 }}</nowiki><br><br><nowiki>{{h3 | Unsichtbar | sichtbar }}</nowiki>
| |
| − | | Formatierte Überschriften sehen im Inhaltsverzeichnis seltsam aus, manchmal sollen sie auch im Text nicht extra auftauchen.<br> Optional kann direkt ein sichtbarer Text übergeben werden.<br> Es stehen die Vorlagen <nowiki>{{h3 |... bis {{ h6 | ... zur verfügung </nowiki>
| |
| − | |-
| |
| − | | {{center | Zentriert }} || <nowiki>{{center | Zentrierter-Text }} </nowiki> || [[Vorlage:Center | Vorlage]], die Text innerhalb einer div-Box zentriert. <br>Wird benötigt für Vorlagen, die keine <...>-Tags verkraften
| |
| − | |-
| |
| − | | <span style="display: inline-block; width:150px;"> {{ Code | SehrlangerCodeTextohneTrennzeichen }} </span>
| |
| − | | <nowiki>{{code | Code-Text }} </nowiki>
| |
| − | | [[Vorlage:Code | Vorlage]], die Text als Code formatiert und einen Zeilenumbruch im Wort erzwingt. Wichtig für Code, der mit Doppelklick kopiert werden können soll.
| |
| − | |-
| |
| − | | {{ Hover | Anzeige-Text | mit Hover-Erklärung }} || <nowiki> {{ Hover | Anzeige-Text | mit Hover-Erklärung }} </nowiki> || Erzeugt eine Hover-Blase mit einem Text, wenn man mit der Maus über den gepunktet-unterstrichenen Text fährt
| |
| − | |}
| |
| − | | |
| − | | |
| − | <!--
| |
| − | * Ein Tabulator wird mit der [[Vorlage:Tab|Vorlage]] <nowiki>{{Tab | Linksbündiger_Text | Tab_Text }}</nowiki> formatiert. <br>Standardbreite des Linksbündigen Textes: {{sw | 16em}}. Der Wert kann als dritter Parameter mit | ''xy''em überschrieben werden</p>
| |
| − | * Lesefreundliche Auflistungen mit Tabulator werden mit der [[Vorlage:TabP | Vorlage]] <nowiki>{{TabP | Linksbündiger_Text | Tab_Text }}</nowiki> formatiert. Der Zeilen-Abstand wird mit <nowiki><p> bzw. </p> etwas erhöht.</nowiki><p>
| |
| − | * Ein Tabulator mit einem Aufzählungszeichen am Anfang wird mit der [[Vorlage:TabA|Vorlage]] <nowiki>{{TabA | Eingerückter_Text | Tab_Text }}</nowiki> formatiert. <br>Standardbreite des Linksbündigen Textes: {{sw | 16em}}. Der Wert kann als dritter Parameter mit | ''xy''em überschrieben werden</p>
| |
| − | * Ein lesefreundlicher Tabulator mit einem Aufzählungszeichen am Anfang und etwas Abstand zur nächsten Zeile wird mit der [[Vorlage:TabAP | Vorlage]] <nowiki>{{TabAP | Eingerückter_Text | Tab_Text }}</nowiki> formatiert. <br>Standardbreite des Linksbündigen Textes: {{sw | 16em}}. Der Wert kann als dritter Parameter mit | ''xy''em überschrieben werden
| |
| − | -->
| |
| − | <br><br>
| |
| − | | |
| − | ==Layout==
| |
| − | | |
| − | Absatz einrücken mit : <code><nowiki><div style="margin-left: 30px;"></nowiki></code><br>
| |
| − | Feldbeschriftungen und deren Eingabewerte werden zweispaltig jeweils linksbündig wie folgt formatiert:<p></p><p>
| |
| − | {{td | [[Vorlage:TabDL| Vorlage]]<b></b> <nowiki>{{TabDL | Linksbündiger_Text | Tab_Text }}</nowiki><br>Kurzform <nowiki>{{td | ...}}</nowiki>
| |
| − | |
| |
| − | * Die Standardbreite (width) beträgt 16em und kann mit z.B. <nowiki>| w=</nowiki>''100''px geändert werden (beliebige Einheit).
| |
| − | * Der Standardabstand (margin) nach unten beträgt 0px und kann mit z.B. <nowiki>| m=</nowiki>''3''px überschrieben werden
| |
| − | * Eingerückte Listen werden erzeugt, indem innerhalb der Vorlage ein Zeilenumbruch und in der neuen Zeile ein * eingefügt wird.<nowiki>{{td | xyz↩* Listentext}}</nowiki>
| |
| − | | w=350px }}
| |
| − | {{ td | <nowiki>{{ a | 1 }} </nowiki> | erzeugt einen kleinen Abstand in Höhe von n Pixeln zur nächsten Zeile | w=350px }}
| |
| − | </p>
| |
| − | <p>{{ td | [[Vorlage:Mobil | Vorlage:]] <nowiki>{{mobil | Text-Mobil | Text Monitor }}</nowiki> | Zeigt Text nur bei Mobil- bzw nur bei Monitor-Breite an. | w=350px }}
| |
| − | | |
| − | ==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.
| |
| − | <br><br>
| |
| − | | |
| − | ==Bilder==
| |
| − | * Benennung: <code>[Produkt-Kürzel]</code>_<code>v[Versionsnummer]</code>_<code>[Thema]</code>_<code>[Schritt]</code><code>[Nummer].png</code><br> z.B.: UTM_v11-7_SSL-VPN_Vorbereitung2.png<br><br>
| |
| − | * grundsätzlich rechtsbündig, zugehöriger Text links davon, Kurzbesschreibung unter dem Bild. Breite ca 450 Pixel<br> Das ist gut zu erreichen mit <nowiki> {{ pt | Bildname | Legende }}</nowiki>Ohne_Leerzeichen und neue Zeile Text der links davon auf gleicher Höhe erscheinen soll. Bildgröße und Position lassen sich ändern, siehe [[Vorlage:pt|Vorlage]]
| |
| − | * Upload der Bilder auf der Seite [[Spezial:Hochladen]]<br><br>
| |
| − | * Schaltflächen im Fießtext sind möglichst ''nicht'' als Bilder darzustellen.<br> Wenn doch: 20 Pixel hoch und ohne Link also: <br><nowiki>[[Datei:Bildname.png|x20px|Link=]]</nowiki><br> '''Besser:''' <nowiki>{{Button |Button_Text}}</nowiki>
| |
| − | * Abschluss eines Absatzes mit Bild erfolgt mit <code><nowiki><br clear=all></nowiki></code> Das sorgt dafür, daß ein neuer Abschnitt erst unterhalb eines Bildes des aktuellen Abschnittes beginnt.
| |
| − | <br><br>
| |
| − | | |
| − | == IP-Adressen ==
| |
| − | Documentation-IPs nach [https://datatracker.ietf.org/doc/rfc5737/ RFC]
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | | 192.0.2.0/24 || TEST-NET-1
| |
| − | |-
| |
| − | | 198.51.100.0/24 || TEST-NET-2
| |
| − | |-
| |
| − | | 203.0.113.0/24 || TEST-NET-3
| |
| − | |-
| |
| − | | 2001:DB8::/32 || Test-Net IPv6
| |
| − | |}
| |
| − | | |
| − | ==Zusammenfassung==
| |
| − | Im Ergebnis erhalten wir ein einheitlich layoutetes Wiki, in dem man jederzeit an gleicher Stelle und in gleicher Reihenfolge seine Informationen erhält.
| |
