Quelltext der Seite Vorlage:Benutzernavigation/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{BenutzerMenüleiste/Übersicht}}
Auf dieser Seite wird die korrekte Einbindung und der Funktionsumfang der Vorlage [[Vorlage:Benutzernavigation]] beschrieben. Wer bei der Einbindung von Vorlagen schon erfahrener ist, findet [[Vorlage:Benutzernavigation#Kurzzusammenfassung|weiter unten]] eine Zusammenfassung.

== Seitennamen ==

Die Seiten müssen wie folgt heißen, um von der Navigation erfasst werden zu können, wobei ''XYZ'' durch den eigenen Benutzernamen ersetzt werden muss. Die mit einem Stern (*) gekennzeichneten Seiten existieren automatisch und müssen nicht angelegt werden. Die E-Mail-Seite setzt voraus, dass bei der Anmeldung eine E-Mail-Adresse angegeben wurde.

* Benutzer:''XYZ'' *
* Spezial:Emailuser/''XYZ'' *
* Benutzer Diskussion:''XYZ'' *
* Spezial:Contributions/''XYZ'' *
* Benutzer:''XYZ''/Vertrauen
* Benutzer:''XYZ''/Bewertung
* Benutzer:''XYZ''/Baustelle
* Benutzer:''XYZ''/ToDo
* Benutzer:''XYZ''/Vorlagen

Es müssen nicht alle hier vorgeschlagenen Seiten angelegt werden, einzelne Punkte können auch aus der Navigationsleiste entfernt werden, siehe dazu: [[Vorlage:Benutzernavigation#einzelne Elemente ausblenden|einzelne Elemente ausblenden]].

== Einbindung ==

=== Einfache Einbindung ===
Die Vorlage kann, wenn keine weiteren Parameter verändert werden sollen, einfach mittels des folgenden Codes eingefügt werden.
<pre>
{{Benutzernavigation
|user=XYZ
}}
</pre>
Anstelle von <code>XYZ</code> muss der eigene Benutzername eingegeben werden, dadurch werden automatisch die korrekten Verlinkungen erstellt.

== Mögliche Änderungen ==

=== Einzelne Elemente ausblenden ===
Um einzelne Elemente auszublenden, wird in der Variablen <code><nowiki>|disp</nowiki></code> eine Kette aus neun Ziffern angegeben, wobei jede Ziffer für eines der einzelnen Elemente steht und eine '''1''' das Element sichtbar werden lässt und eine '''0''' es versteckt:

{| class="wikitable" style="text-align:center;"
|-
! colspan="9"| Stelle in der neunstelligen Zahlenkette
|-
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
|-
| Benutzer || E-Mail || Diskussion || Beiträge || Vertrauen || Bewertung || Baustelle || Aufgaben || Vorlagen
|}

Dazu ein Beispiel:
Sollen beispielsweise der Link für die '''Beiträge''' und die '''Vertrauensseite''' ausgeblendet werden, so schaut man in der Tabelle, welche Stellen die beiden Seiten haben, hier die Stellen '''4''' und '''5'''. Hier muss also nun eine '''Null''' eingesetzt werden, somit sieht die Kette dann so aus:

{| class="wikitable" style="text-align:center;"
|-
! colspan="9"| Stelle in der neunstelligen Zahlenkette
|-
| aktiv
| aktiv
| aktiv
| nicht<br />aktiv
| nicht<br />aktiv
| aktiv
| aktiv
| aktiv
| aktiv
|-
| '''1'''
| '''1'''
| '''1'''
| '''0'''
| '''0'''
| '''1'''
| '''1'''
| '''1'''
| '''1'''
|-
| Benutzer|| E-Mail|| Diskussion|| Beiträge|| Vertrauen|| Bewertung|| Baustelle|| Aufgaben|| Vorlagen
|}

Also sieht die Zahlenkette so aus: '''111001111'''.
Dies wird nun in den zusätzlichen Parameter <code><nowiki>| disp=</nowiki></code> eingesetzt, also sieht der Code nun so aus:

<pre>
{{Benutzernavigation
|user=XYZ
|disp=111001111
}}
</pre>

'''Und das Ergebnis:'''
{{Benutzernavigation
|user=XYZ
|disp=111001111
|align=left
}}
<div style="clear:both;"></div>

=== Titel angeben ===

Der Titel der Navigationsleiste ist standardmäßig ausgeblendet, wenn er angezeigt werden soll, muss im Parameter <code><nowiki>|title=</nowiki></code> ein Titel angegeben werden. Alternativ kann auch nichts eingesetzt werden, dadurch wird nur eine leere Zeile eingesetzt und die Leiste bekommt eine farblich abgesetzte „leere Überschrift“. Wenn weder eine Überschrift noch eine leere Zeile gewünscht ist, so muss in den Parameter '''no''' eingesetzt werden: <code><nowiki>| title=no</nowiki></code> So sieht es mit dem leeren Titel aus:
{{Benutzernavigation
| user=XYZ
| disp=111111111
| title=
}}
<br />
<pre>
{{Benutzernavigation
| user=XYZ
| disp=111111111
| title=
}}
</pre>

=== Farben angeben ===

Die Vorlage erlaubt die Angabe von unterschiedlichen Farben für den Titel, den mittleren Bereich um die Logos und für die Links in der untersten Zeile. Die Parameter heißen wie folgt:

<pre>
| bgt=HINTERGRUNDFARBE TITEL
| bgl=HINTERGRUNDFARBE LINK
| bgi=HINTERGRUNDFARBE IMAGE
</pre>
Die Namen der Parameter leiten sich aus den Buchstaben ''bg'' für ''background'' (engl. für Hintergrund) und dem jeweiligen Buchstaben: ''t'' für ''Titel'', ''l'' für ''Links'' und ''i'' für ''Image'' (engl.: Bild) ab.
Als Farbwerte können hier die hexadezimalen Farbangaben verwendet werden, eine Übersicht befindet sich unter [[Webfarbe#CSS 3|Webfarbe]]. Den entsprechenden Farbcode (das <nowiki>#</nowiki>-Zeichen und der 6-stellige Farbcode) jeweils als Parameter einsetzen. Hier noch ein Beispiel mit anderen Farben:

{{Benutzernavigation
|user=XYZ
|disp=111111111
|title=Titel
|bgt=#FFFFFF
|bgl=#F0F0F0
|bgi=#DDDDDD
|align=left
}}
<div style="clear:both;"></div>

<pre>
{{Benutzernavigation
|user=XYZ
|disp=111111111
|title=Titel
|bgt=#FFFFFF
|bgl=#F0F0F0
|bgi=#DDDDDD
}}
</pre>

=== Rahmen einfügen ===
<div class="center">
<div style="border: 1px solid; width: 50%;">'''1 Pixel Rahmenbreite'''</div>
<div style="border: 2px solid; width: 50%; margin-top:5px;">'''2 Pixel Rahmenbreite'''</div>
<div style="border: 3px solid; width: 50%; margin-top:5px;">'''3 Pixel Rahmenbreite'''</div>
<div style="border: 4px solid; width: 50%; margin-top:5px;">'''4 Pixel Rahmenbreite'''</div>
</div>
Die gesamte Menübox kann mit einem Rahmen umgeben werden. Dazu dieht das Attribut <code><nowiki>| border=</nowiki></code>. Hier wird die Rahmenbreite in Pixeln angegeben (die Eingabe aber ohne „px“). Oben sind Rahmen in der Dicke von 1 bis 4 Pixel beispielhaft gezeigt. Wenn beispielsweise ein Rahmen von 4 Pixeln Stärke erzeugt werden soll, sehen der Code und das Ergebnis so aus:
<pre>
{{Benutzernavigation
|user=XYZ
|disp=11111111
|title=Titel
|border=4
}}
</pre>
{{Benutzernavigation
|user=XYZ
|disp=11111111
|title=Titel
|border=4
}}

==== Rahmenfarbe verändern ====
Die Rahmenfarbe kann individuell verändert werden, hierzu existiert der Parameter <code><nowiki>|bfarbe=</nowiki></code>. Dort kann ebenfalls eine Farbe in Hexadezimalschreibweise angegeben werden (s. [[Webfarbe#CSS 3|Webfarbe]] ). Somit sieht das obige Beispiel mit dem Farbwert <code><nowiki>#FF0000</nowiki></code> (Rot) wie folgt aus:
<pre>
{{Benutzernavigation
|user=XYZ
|disp=11111111
|title=Titel
|border=4
|bfarbe=#FF0000
}}
</pre>
{{Benutzernavigation
|user=XYZ
|disp=11111111
|title=Titel
|border=4
|bfarbe=#FF0000
}}

==== Rahmenecken abrunden ====
Zusätzlich kann der Rahmen an den Ecken abgerundet werden. Das notwendige Element heißt <code><nowiki>|rundung=</nowiki></code>. Dort wird der Radius angegeben, mit dem die Ecken abgerundet werden sollen. Ein gebräuchlicher Wert ist hier <code>10</code>. Das Beispiel unten mit einer Abrundung von 8:
<pre>
{{Benutzernavigation
|user=XYZ
|disp=11111111
|title=Titel
|border=4
|bfarbe=#FF0000
|rundung=8
}}
</pre>
{{Benutzernavigation
|user=XYZ
|disp=11111111
|title=Titel
|border=4
|bfarbe=#FF0000
|rundung=8
}}

=== Ausrichtung auf der Seite ===
Mit dem Attribut <code><nowiki>|align=</nowiki></code> wird angegeben, wo die Box sich auf der Seite, in der sie eingebunden ist, befinden soll. Drei Möglichkeiten sind erlaubt:
# ''center'' (zentrierte Ausrichtung)
# ''left'' (linker Seitenrand)
# ''right'' (rechter Seitenrand)

<div class="centered" style="width: 30%; border: 1px solid; text-align:center;">''center''</div>
<div class="float-left" style="width: 30%; border: 1px solid;">''left''</div>
<div class="float-right" style="width: 30%; border: 1px solid; text-align:right;">''right''</div>

<div style="clear:both;"></div>

== Elementübersicht ==

=== Code ===
<pre>
{{Benutzernavigation
| user=
| disp=
| title=
| bgt=
| bgl=
| bgi=
| border=
| bfarbe=
| rundung=
| align=
| langlink=<!-- Bei Benutzerseiten und Benutzerdiskussionsseiten wird nach "Benutzer:Beispielbenutzer" "/{{{langlink}}}" angehangen -->
| lang1=<!-- Übersetzung des Lemmas in Englisch -> dann "en" eintragen -->
| lang2=<!-- Übersetzung des Linktextes in Englisch -> dann "en" eintragen -->
}}
</pre>

=== Standardwerte ===

Wenn die einzelnen Attribute nicht angegeben sind, besitzen sie die folgenden '''Standardwerte''':

* '''user: [[Benutzer:Max Mustermann|Max Mustermann]]'''
* '''disp: 111111111''' (alle Elemente eingeblendet)
* '''title: no''' (keine Überschrift)
* '''bgt: {{Farbe|#FFDAB9|Text=#FFDAB9}}'''
* '''bgl: {{Farbe|#FFDAB9|Text=#FFDAB9}}'''
* '''bgi: {{Farbe|#FDF5E6|Text=#FDF5E6}}'''
* '''border: no''' (kein Rahmen)
* '''bfarbe: black''' (Schwarz)
* '''rundung: no''' (keine Abrundung)
* '''align: center''' (mittig)

=== Kurzzusammenfassung ===

<pre>
{{Benutzernavigation
| user = Benutzername
| disp = anzuzeigende Elemente
| title = Titel (oder „no“)
| bgt = Hintergrundfarbe Titel
| bgl = Hintergrundfarbe Links
| bgi = Hintergrundfarbe Bilder
| border = Rahmendicke (oder „no“)
| bfarbe = Rahmenfarbe
| rundung = Radius von Rundung der Rahmenecken (oder „no“)
| align = Ausrichtung
}}
</pre>

== Technische Anmerkung ==
Die Vorlage ist mit [[Hypertext Markup Language|HTML]] erstellt, da der Quellcode mit der Wiki-Syntax zu unübersichtlich wäre oder ein nur schwer zu verhindernder Fehler aufträte!