Spielwiese/Wiki-Regeln2: Unterschied zwischen den Versionen

Aus Securepoint Wiki
Wechseln zu:Navigation, Suche
K
K
Zeile 47: Zeile 47:
 
| Konfiguration || ===Konfiguration=== ||=Überschrift 3  
 
| Konfiguration || ===Konfiguration=== ||=Überschrift 3  
 
|-
 
|-
| style="max-width:300px;" |{{pt2|Start utm2.png|Übersichts-Screenshot|{{Reiter|Text Links vom bzw. über dem Bild}} }} Konfigurationstext
+
| style="max-width:300px;" |{{pt2|Start utm2.png|Übersichts-Screenshot|{{Reiter|Formatierte Überschrift}} }} Konfigurationstext
| {{ pt2/Syntax}} ||{{pt2/Doku}}
+
| <nowiki>{{ pt2 | Bildname | Legende | {{h3 | Überschrift fürs Inhaltsverzeichnis | {{ Reiter | Formatierte Überschrift}} }} }}</nowiki>||{{pt2/Doku}}
 
|-
 
|-
 
| Schritt 1 || ==== Schritt 1==== (=Überschrift 4) ||
 
| Schritt 1 || ==== Schritt 1==== (=Überschrift 4) ||
 
|-
 
|-
| ||<nowiki>{{pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}</nowiki><br>
+
|
 
* Unter-Schritt 1.1
 
* Unter-Schritt 1.1
 
* Unter-Schritt 1.2
 
* Unter-Schritt 1.2
 
* Unter-Schritt 1.3
 
* Unter-Schritt 1.3
| Beschreibung, was in diesem Schritt erfolgt
+
|<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
|-
 
| || <nowiki><br clear=all></nowiki>
 
 
|-
 
|-
 
| Schritt 2 || ==== Schritt 2==== (=Überschrift 4)
 
| Schritt 2 || ==== Schritt 2==== (=Überschrift 4)
 
|-
 
|-
| ||<nowiki>{{pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}</nowiki><br>
+
|
 
* Unter-Schritt 2.1
 
* Unter-Schritt 2.1
 
* Unter-Schritt 2.2
 
* Unter-Schritt 2.2
 
* Unter-Schritt 2.3
 
* Unter-Schritt 2.3
| Beschreibung, was in diesem Schritt erfolgt
+
|<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
 
|-
 
|-
| || <nowiki><br clear=all></nowiki>
+
| etc.pp<br>
etc.
 
<br><br>
 
 
|-
 
|-
 
| Weitere Schritte, außerhalb des Konfigurationsassistenten || ===Weitere Schritte, außerhalb des Konfigurationsassistenten=== (=Überschrift 3)<br>
 
| Weitere Schritte, außerhalb des Konfigurationsassistenten || ===Weitere Schritte, außerhalb des Konfigurationsassistenten=== (=Überschrift 3)<br>

Version vom 7. Juni 2019, 08:05 Uhr

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 {{TOC2 | Parameter }} Vorlage

Das Inhaltsverzeichnis wird per styles.css rechtsbündig mit max 48% Breite angezeigt.
Kasten wird inzwischen von Mediawiki bereitgestellt.

Zusätzlich wird die Vorlage <templatestyles src="Vorlage:Styles.css" /> eingebunden.

Parameter Bedeutung
| 1 Optionaler Text, der Linksbündig auf gleicher Höhe wie das Inhaltsverzeichnis mit der Formatierung Bold angezeigt wird.
Sinn und Zweck der Seite in einem Satz und fett {{TOC2 | Sinn und Zweck der Seite in einem Satz und fett}}
Letzte Anpassung zur Version: 47.11 Letzte Anpassung zur Version: '''47.11''' Versionsnummer fett
Bemerkung:
  • Was wurde geändert
  • Ein kurzes Changelog, das auch ein bisschen Verkaufshilfe sein darf!
{{ td | Bemerkung: |
* Was wurde geändert
* Changelog
| w=80px }}
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]]

Nur bei UTM. Nicht bei AV, MobSec, da dort Systembedingt weitestgehend nur aktuelle Versionen vorzufinden sind.

In den alten Seiten muss ein Archiv-Tag eingefügt werden!

Nur bei veralteten Artikeln:

Alert-red-light.png  Dieser Artikel bezieht sich auf eine nicht mehr aktuelle Version! 

Alert-green.png  Der Artikel für die aktuelle Version steht hier.

{{Archivhinweis | aktuelle_Seite }} Vorlage

  Achtung:   Alte Artikel werden als Archivartikel markiert und auf den neuen Seiten verlinkt.
Als aktuelle_Seite muss ein Standardname verwendet werden, der Versionsunabhängig gleich bleiben muss.

Diese Vorlage sorgt außerdem dafür, daß die Seite in der Suche erst ganz unten auftaucht.


----(4x Minuszeichen am Anfang einer Zeile) 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
Formatierte Überschrift
Übersichts-Screenshot

Konfigurationstext
{{ pt2 | Bildname | Legende | {{h3 | Überschrift fürs Inhaltsverzeichnis | {{ Reiter | Formatierte Überschrift}} }} }} Zeigt ein Bild rechtsbündig an.

Optional Linksbündig bzw. in mobil-Ansicht darüber einen Text.

Parameter Bedeutung
| 1 Bildname
| 2 Legende (optional)
| 3 Text, der bei normalem Viewport Linksbündig und obenbündig angezeigt wird.
In mobilansicht wird dieser Text über dem Bild angezeigt.
| hochkant= Default: 2 (=600px) Bestimmt die Größe des Bildes (1=300px)
| w= Default: mini Bestimmt die Größe des Bildes
| link= externer Link
| d= Default: Leer Beliebiger weiterer Parameter
Schritt 1 ==== Schritt 1==== (=Überschrift 4)
  • Unter-Schritt 1.1
  • Unter-Schritt 1.2
  • Unter-Schritt 1.3
{{pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}
* Unter-Schritt 1.1
* Unter-Schritt 1.2
* Unter-Schritt 1.3
<br clear=all>
Beschreibung, was in diesem Schritt erfolgt
Schritt 2 ==== Schritt 2==== (=Überschrift 4)
  • Unter-Schritt 2.1
  • Unter-Schritt 2.2
  • Unter-Schritt 2.3
{{pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}
* Unter-Schritt 2.1
* Unter-Schritt 2.2
* Unter-Schritt 2.3
<br clear=all>
Beschreibung, was in diesem Schritt erfolgt
etc.pp
Weitere Schritte, außerhalb des Konfigurationsassistenten ===Weitere Schritte, außerhalb des Konfigurationsassistenten=== (=Überschrift 3)

{{ pt2 | Bildname.png | Detail-Screenshot | Kapitelüberschrift}}
Beschreibung, was in diesem Schritt erfolgt

====Überschrift===
  • Unter-Schritt 3.1
  • Unter-Schritt 3.2
  • Unter-Schritt 3.3
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...

  • Zonenkonzept.png
    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
Werkzeug
Link= Printer
Link= Renew
Check
Stift
Link= OTP-Symbol
Play
Download
Upload
Text  Dropdown-Pfeil hinter dem Text
Text Blau
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'
Darstellung ohne Pfeil (Nur ein Eintrag möglich!) z.B. für Überschriften:
‌ Menü 

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
Ein {{ButtonAn | Button_Text}} Vorlage für in der Standard-Einstellung aktivierte Buttons
Aus {{ButtonAus | Button_Text}} Vorlage für in der Standard-Einstellung deaktivierte Buttons
Positiv 

Hinweis 

  Warnung  

Neu Neu in 11.8 

Neu-in 11.8 

  güner   und normaler Text  

  Andere Farbe  

{{ Hinweis | Poisitv-Text | grün }}

{{ Hinweis | Hinweis-Text | gelb }}

{{ Hinweis | ! Warnungs-Text }}

{{ Hinweis | Neu in 11.8 | 11.8 }}

{{ Hinweis | Neu-Text | 11.8 | grün}}

{{ Hinweis | ! güner § und normaler Text | grün}}

{{ Hinweis | ! Andere Farbe | bc=#2bc6b9;}}

Diese Vorlage blendet einen farblich hinterlegten Text ein. Er kann automatisch ausgeblendet werden.
Das wird über die übergebene Release-Nummer im Vergleich mit der gespeicherten Major-Release-Versionsnummer realisiert.
Ist die Nummer des Major-Release gößer als die angegebene Versions-Nummer wird der Hinweis nicht mehr eingeblendet.

Parameter Wert Beschreibung Darstellung
| 1 {{Hinweis|Hinweis}} Meldungs-Text Hinweis 
| 2 {{Hinweis|Hinweis|11.7.14}} Release-Nummer z.B.: 11.7.14 Nur wenn diese Versions-Nummer größer oder gleich der Major-Release-Nummer ist, wird der Text eingeblendet.
{{Hinweis|Hinweis|31.0}} Release-Nummer größer oder gleich der Major-Release-Nummer Neu Hinweis 
Farbe Farbwert aus der Vorlage {{ Farbe | ...}} default: rot
| 3 {{Hinweis|Hinweis|grün}} Farbwert aus der Vorlage {{ Farbe | ...}} default: rot Hinweis 
| Anw= {{Hinweis|Hinweis|grün|Anw=MS}} Optional, nur notwendig, wenn in der URL nicht der Anwendungsname vorkommt.
Mögliche Werte: AV, MDM, USR, MS / UTM / UMA
(z.B.: Innerhalb der UTM-Seiten erfolgt ein Hinweis auf eine neue Funktion in der UMA)
Als Defaultwert wird das Major-Release der UTM ausgegeben.
Hinweis 
| bc= {{Hinweis|Hinweis|bc=orange}} background-color Optional, Standardwert ist das jeweils Anwendungs-eigene rot. Siehe Vorlage:Farbe, html- #Farbwerte oder englische Farbnamen Hinweis 
| fc= {{Hinweis|Hinweis|fc=blue}} font-color Standardwert ist white Hinweis 
| bdc= {{Hinweis|Hinweis|bdc=blau}} border-Color Standardwert ist #cacaca; Hinweis 
§ »{{Hinweis|Hinweis§ohne Farbe}}« Trennzeichen stellt den folgenden Text-Teil normal dar, bei Angabe einer Versions-Nummer wird er aber mit ausgeblendet. »Hinweis ohne Farbe «
! {{Hinweis|! Hinweis}} ein ! vor dem Text wird als gesondertes Kästchen dargestellt   Hinweis  
!! {{Hinweis|!! Hinweis}} mehrere ! vor dem Text werden in einer großen Box dargestellt.
Je mehr ! desdo größer die Box
 
Hinweis
 
 
! {{Hinweis|!|r}} Ohne Hintergrund, hier gilt die Farbangabe als Schriftfarbe.
Ersetzt {{spc|!!|o|-|c={{{c|{{{2|}}} }}} }}


Das aktuelle Majorrelease der UTM z.B. ist: 11.8.6

Der Wert {{#titleparts: {{{ 2 | {{fullurl:{{FULLPAGENAMEE}} }} }}} | 1 | 4 }} wertet anhand der URL die Anwendung aus.

Hier: fullurl: https://wiki.securepoint.de/Spielwiese/Wiki-Regeln2
=> Spielwiese
(Das ergibt hier wenig Sinn, aber aus https://wiki.securepoint.de/UTM/APP/HTTP_Proxy wird dann UTM
Über die Vorlage Majorrelease wird dann das aktuelle Majorrelease für diese Anwendung ermittelt und mit dem übergebenen Wert verglichen


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)
Button Button / Schaltflächen

Menü Menü

Eigenschaft Eigenschaft

Ohne
Die Standardbreite ist bei Buttons dynamisch, ansonsten 100px. Der Wert kann mit dem Parameter w=120px (width)geändert werden.
Der Standardabstand nach rechts ist 0px. Der Wert kann mit dem Parameter mr=10px (margin-right) geändert werden.

Option (als 3. Argument): - oder x : Nur Icon, ohne Text
Symbole:

Zahlreiche Icons, z.B.: Details in der Vorlage.

Alert-red-light.png  Dieser Artikel bezieht sich auf eine nicht mehr aktuelle Version! 

Alert-green.png  Der Artikel für die aktuelle Version steht hier.

{{Archivhinweis | Spielwiese/Wiki-Regeln}} Archiv-Tag, damit so markierte Seiten in der Suche erst am Schluss auftauchen.
{{ h3 | Unsichtbare Überschriften

{{ h4 |
{{ h5 |
{{ h6 |

{{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

Absatz einrücken mit : <div style="margin-left: 30px;">

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

Vorlage: {{mobil | Text-Mobil | Text Monitor }}
Zeigt Text nur bei Mobil- bzw nur bei Monitor-Breite an.

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.



IP-Adressen

Documentation-IPs nach RFC

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.