Spielwiese/Wiki-Regeln2: Unterschied zwischen den Versionen

Aus Securepoint Wiki
Wechseln zu:Navigation, Suche
K (Format-Vorlagen)
K (Weiterleitung nach Spielwiese/Wiki-Regeln erstellt)
(Markierung: Neue Weiterleitung)
 
(26 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{DISPLAYTITLE:Wiki-Regeln}}
+
#REDIRECT [[Spielwiese/Wiki-Regeln]]
 
 
'''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'
 
|-
 
| '''Sinn und Zweck der Seite in einem Satz und fett'''  || <nowiki>'''Sinn und Zweck der Seite in einem Satz und fett'''</nowiki>||
 
|-
 
| Letzte Anpassung zur Version: '''47.11''' || Versionsnummer fett ||
 
|-
 
| Bemerkung: Was wurde geändert<br>Ein kurzes Changelog, das auch ein bischen Verkaufshilfe sein darf! || ||
 
|-
 
| 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>
 
|
 
{| class="mw-collapsible mw-collapsed"
 
! Archivhinweis
 
|-
 
| {{ Hinweis | ! Achtung: }} Alte Artikel werden als Archivartikel markiert und auf den neuen Seiten verlinkt.
 
Auf die alte Seite {{r|muss}} folgender Hinweis unter Verwendung der Vorlage:<br>
 
'''<nowiki>{{Archivhinweis | aktuelle_Seite }}</nowiki>''' Wobei ''aktuelle_Seite'' der Standardname ist, der Versionsunabhängig gleich bleiben muss.
 
Die Formatierung mit der Vorlage ''Archivhinweis'' sorgt außerdem dafür, daß die Seite in der Suche erst ganz unten auftaucht.
 
<p>Das ganze sieht dann so aus:</p>
 
{{Archivhinweis | Spielwiese/Wiki-Regeln}}
 
|}
 
|-
 
| Automatisches Inhaltsverzeichnis ||  || (Wird - wie der Titel schon sagt -  automatisch generiert)
 
|-
 
| 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.
 
<!--
 
===Konfigurationstitel, Inhalt des Wikis o.ä.===
 
==Konfigurationstitel, Inhalt des Wikis o.ä.== (=Überschrift 2)<br>
 
Hintergrund: Damit das automatische Inhaltsverzeichnis die folgenden Unterabschnitte einheitlich eine Kategorie tiefer nummeriert, als Einleitung und Information, muss hier eine eigene Überschrift ohne weiteren Inhalt eingefügt werden. Da es hier erst richtig losgeht, wird hier mit Ebene 2 formatiert - das Inhaltsverzeichnis nimmt's gelassen
 
-->
 
|-
 
| Konfiguration || ===Konfiguration=== (=Überschrift 3) <br><nowiki>{{ pt | Bildname.png }}</nowiki>Wo startet die Konfiguration? || Beschreibung direkt im Anschluss an die Vorlage <nowiki>{{pt |...}}</nowiki> Das sorgt dafür, daß der Text oben bündig mit dem Bild abschließt.
 
|-
 
| Schritt 1 || ==== Schritt 1==== (=Überschrift 4) ||
 
|-
 
| ||<nowiki>{{pt | Bildname.png}}</nowiki><br>
 
* Unter-Schritt 1.1
 
* Unter-Schritt 1.2
 
* Unter-Schritt 1.3
 
| Beschreibung, was in diesem Schritt erfolgt
 
|-
 
| || <nowiki><br clear=all></nowiki>
 
|-
 
| Schritt 2 || ==== Schritt 2==== (=Überschrift 4)
 
|-
 
| ||<nowiki>{{pt | Bildname.png}}</nowiki><br>
 
* Unter-Schritt 1.1
 
* Unter-Schritt 1.2
 
* Unter-Schritt 1.3
 
| Beschreibung, was in diesem Schritt erfolgt
 
|-
 
| || <nowiki><br clear=all></nowiki>
 
etc.
 
<br><br>
 
|-
 
| Weitere Schritte, außerhalb des Konfigurationsassistenten || ===Weitere Schritte, außerhalb des Konfigurationsassistenten=== (=Überschrift 3)<br>
 
<nowiki>{{ pt | Bildname.png}}</nowiki><br>
 
Beschreibung, was in diesem Schritt erfolgt
 
|-
 
| ||<nowiki>{{pt | Bildname.png}}</nowiki><br>
 
* Unter-Schritt 1.1
 
* Unter-Schritt 1.2
 
* Unter-Schritt 1.3
 
| Beschreibung, was in diesem Schritt erfolgt
 
|-
 
| || <nowiki><br clear=all></nowiki>
 
|-
 
| 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>
 
*{{pt|Zonenkonzept.png|hochkant=2}} 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 Abähngigkeit 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 }} <br><br>
 
| <nowiki>{{Button | Button-Text | Option}}</nowiki>
 
| [[Vorlage:Button | Vorlage]] für Schaltflächen<br> Als Option stehen verschiedene Schalter zur Verfügung. Es reicht, den, bzw. die '''H'''ervorgehobenen Buchstaben anzugeben. Der Schalter ist nicht Case-sensitive<br>
 
: {{Button|| w}} '''W'''''erkzeug''
 
: {{Button|| p}} '''P'''''rinter''
 
: {{Button|| r}} '''R'''''enew''
 
: {{Button|| c}} '''C'''''heck''
 
: {{Button|| s}} '''S'''''tift''
 
: {{Button|| o}} '''O'''''TP-Symbol''
 
: {{Button|| Pl}} '''Pl'''''ay''
 
: {{Button|| d}} '''D'''''ownload''
 
: {{Button|| u}} '''U'''''pload''
 
: {{Button|Text| dr}} '''Dr'''''opdown-Pfeil'' <u>hinter</u> dem Text
 
: {{Button| Text |b}}'''B'''''lau''
 
|-
 
| {{ Reiter | Reiter }} || <nowiki>{{Reiter | Reiter_Text }}</nowiki> || [[Vorlage:Reiter | Vorlage]] für Reiter
 
|-
 
| {{ Menu | Menü | Untermenü | Unter-Untermenü}} || <nowiki>{{Menu | Menü_Text | Untermenü | Unter-Untermenü }}</nowiki> || [[Vorlage:Menu |Vorlage]] für Menüeinträge
 
|-
 
| {{ Beschriftung | Beschriftung }} || <nowiki>{{Beschriftung |Meine_Beschriftung}}</nowiki> || [[Vorlage:Beschriftung | Vorlage]] für Beschriftungen für Felder, in die Werte eingetragen werden müssen
 
|-
 
| {{ Kasten | Kasten }} <br><br>{{ Kasten | KastenGrau | grau }}<br>{{ Kasten | Kasten | blau | fc=yellow; }}|| <nowiki>{{Kasten|Kasten_Text}}</nowiki><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
 
|-
 
|  {{ ButtonAn | Ein }} || <nowiki>{{ButtonAn | Button_Text}}</nowiki> ||  [[Vorlage:ButtonAn | Vorlage]] für in der Standard-Einstellung aktivierte Buttons
 
|-
 
| {{ 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.
 
|}
 
 
 
 
 
<!--
 
* 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==
 
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>
 
 
 
==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 &copy; 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 der [[Vorlage:pt|Vorlage]] <nowiki> {{pt|Bildname|Kurzbeschreibung}}</nowiki>Ohne_Leerzeichen und neue Zeile Text der links davon auf gleicher Höhe erscheinen soll.  Das Bild kann vergrößert oder verkleinert werden mit dem optionalen Parameter <code>hochkant=2.5</code> Standardwert ist 1.5<br><br>
 
* 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>
 
 
 
==Zusammenfassung==
 
Im Ergebnis erhalten wir ein einheitlich layoutetes Wiki, in dem man jederzeit an gleicher Stelle und in gleicher Reihenfolge seine Informationen erhält.
 

Aktuelle Version vom 24. Juni 2019, 10:38 Uhr

Weiterleitung nach: