Zum Hauptinhalt springen

Hinweisboxen

Hinweisboxen heben Informationen vom Fließtext ab. Es gibt fünf Arten. Auf GitHub erscheinen sie als normaler Text mit :::-Zeilen – der Inhalt bleibt lesbar.

Die fünf Arten​

hinweis

Hinweis – neutrale Zusatzinformation.

tipp

Tipp – eine Abkürzung oder Empfehlung, die Zeit spart.

info

Info – Hintergrundwissen, das nicht zwingend nötig ist.

warnung

Warnung – Achtung, sonst passiert etwas Unerwartetes (z. B. Daten werden überschrieben).

gefahr

Gefahr – kann Daten zerstören oder den Shop lahmlegen.

Eigener Titel​

Schneller zum Ziel

Mit Strg + K öffnest du in der Administration die Suche.

Vor dem Update lesen

Version 1.0 speichert Hinweise anders als 1.1. Erstelle vor dem Update eine Datensicherung.

Inhalte in Hinweisboxen​

Hinweisboxen dürfen alle anderen Elemente enthalten:

Voraussetzungen

Bevor du startest, brauchst du:

  1. Administrator-Rechte
  2. Eine aktive Lizenz
ShopwarePlugin
6.61.0
6.71.1

Wann welche Box?​

ArtEinsatzHäufigkeit
noteErgänzungengelegentlich
tipAbkürzungengelegentlich
infoHintergrundselten
warningRisiko mit Folgennur wenn nötig
dangerDatenverlust, Ausfallsehr selten
hinweis

Zu viele Boxen verlieren ihre Wirkung. Faustregel: höchstens zwei pro Bildschirmseite.