Spielwiese/Wiki-Regeln2: Unterschied zwischen den Versionen

Aus Securepoint Wiki
Wechseln zu:Navigation, Suche
K (Format-Vorlagen)
K (Format-Vorlagen)
Zeile 185: Zeile 185:
 
| <nowiki>{{code | Code-Text }} </nowiki>  
 
| <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.
 
|  [[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
 
|}
 
|}
  

Version vom 11. März 2019, 13:32 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'
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]]

Archivhinweis
   Achtung:   Alte Artikel werden als Archivartikel markiert und auf den neuen Seiten verlinkt.

Auf die alte Seite muss folgender Hinweis unter Verwendung der Vorlage:
{{Archivhinweis | aktuelle_Seite }} 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.

Das ganze sieht dann so aus:

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.

Automatisches Inhaltsverzeichnis (Wird - wie der Titel schon sagt - automatisch generiert)
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}}
  • Unter-Schritt 1.1
  • Unter-Schritt 1.2
  • Unter-Schritt 1.3
Beschreibung, was in diesem Schritt erfolgt
<br clear=all>
Schritt 2 ==== Schritt 2==== (=Überschrift 4)
{{pt | Bildname.png}}
  • Unter-Schritt 1.1
  • Unter-Schritt 1.2
  • Unter-Schritt 1.3
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}}
Beschreibung, was in diesem Schritt erfolgt

{{pt | Bildname.png}}
  • Unter-Schritt 1.1
  • Unter-Schritt 1.2
  • Unter-Schritt 1.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ü →Unter-Untermenü {{Menu | Menü_Text | Untermenü | Unter-Untermenü }} Vorlage für Menüeinträge
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 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
| 1 Meldungs-Text
| 2 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.
Farbe Farbwert aus der Vorlage {{ Farbe | ...}} default: rot
| 3 farbe Farbwert aus der Vorlage {{ Farbe | ...}} default: rot
| Anw= UMS, MS, UTM Optional, nur notwendig, wenn in der URL nicht der Anwendungsname vorkommt.
(z.B.: Inneralb der UTM-Seiten erfolgt ein Hinweis auf eine neue Funktion in der UMA)
Als Defaultwert wird das Major-Release der UTM ausgegeben.
| bc= background-color Optional, Standardwert ist das SP-eigene rot. Mögliche Werte: rot, grün, gelb oder html- #Farbwerte
| fc= Font-Color Standardwert ist white
| bdc= border-Color Standardwert ist #cacaca;
§ Trennzeichen stellt den folgenden Text-Teil normal dar, blendet ihn aber (bei Angabe einer Versions-Nummer) mit aus.


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

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

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 der Vorlage {{pt|Bildname|Kurzbeschreibung}}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 hochkant=2.5 Standardwert ist 1.5

  • 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.