Vorlage:TabMenu/Doku/TabFmtInfo/Parameters

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen

Dokumentation[Bearbeiten]
  Zweck und Überblick   Konzept und praktische Anwendung   Formatierung der Tabs   Technischer Hintergrund  
  Tabs oben   Tabs unten   Tabs oben und unten   Menüs verschachteln   Feineinstellungen   Hacks   Fehlersuche   Parameter

Dieses Kapitel enthält eine Zusammenfassung aller Parameter. Zuvor werden die Grundlagen zur Verwendung der Parameter behandelt, inklusive einiger Quellcodebeispiele und der allgemeinen Parametersyntax innerhalb von Vorlagen.

Grundlegendes zur Verwendung der Parameter (Codebeispiele und Syntax)

[Quelltext bearbeiten]

Eine Beispielvorlage, die die hier behandelten Parameter enthält

[Quelltext bearbeiten]

Innerhalb der von Dir erstellten Vorlage wird das globale Erscheinungsbild der Registerkarten (Tabs) konfiguriert, wie die Farbe, Ausrichtung und hinterlegte Links Deines Menüs. Eine solche Vorlage könnte z. B. dafür verwendet werden, ein Tabmenü innerhalb Deiner Benutzerseite darzustellen. Es würde sich in diesem Fall anbieten, die Vorlage auf der Seite

Benutzer:DeinBenutzername/MyTabMenu

anzulegen. Der Inhalt (Quellcode) Deiner Vorlage könnte dieser sein...

  Benutzer   Artikel  

Beispielvorlage (ein Klick darauf führt zum Quellcode der Vorlage)

... wobei in diesem Beispiel der Tab „Benutzer“ auf Deine Benutzerseite zeigt und der Tab „Artikel“ eine Auflistung der Artikel enthalten könnte, die von Dir gepflegt werden.

So wird Deine Vorlage aufgerufen (inklusive einer Liste der möglichen Aufrufparameter)

[Quelltext bearbeiten]

Hier ist der Quellcode, der - bezogen auf das Beispiel - auf Benutzer:DeinBenutzername/Artikel hinterlegt werden muss, um Dein Menü auf dieser Seite anzeigen zu können:

<!-- BEGIN TABS --> {{Benutzer:DeinBenutzername/MyTabMenu | Tab2=Active }}
Inhalt der innerhalb des Tab-Rahmens angezeigt werden soll, beispielsweise eine Liste der von Dir selbst erstellen und gepflegten Artikel ...
<!-- END OF TABS -->{{TabMenu | Mode=EndTabMenu }}

Weitere Parameter, die in der ersten Zeile übergeben werden können (aber nicht müssen) wären: Position BgColor Shadow Rotate FrameWidth FrameAlign Move Margin Padding

Die Parametersyntax innerhalb Deiner Vorlage

[Quelltext bearbeiten]

In der Zusammenfassung aller Parameter werden die Tabmenüparameter aufgelistet, die innerhalb Deiner Vorlage genutzt werden können. Die Parameter erhalten ihren Wert entweder bereits innerhalb Deiner Vorlage, oder erst beim Einbinden Deiner Vorlage. Festgelegt wird das innerhalb Deiner Vorlage durch die folgende Syntax:

Der Unterschied zwischen...
Parameter={{{Parameter}}} Parameter={{{Parameter|x}}} Parameter=x
Diese Syntax kann innerhalb Deiner Vorlage verwendet werden. Sie bedeutet, dass der Parameter seinen Wert nicht schon dort erhält, sondern erst auf der Seite, die Deine Vorlage einbindet, in Form von {{Benutzer:MaxMustermann/DeineVorlage | Parameter=Wert }}. Diese Syntax bedeutet, dass der Parameter ebenfalls seinen Wert auf der Seite erhalten kann, die Deine Vorlage einbindet, in Form von {{Benutzer:MaxMustermann/DeineVorlage | Parameter=Wert }}. Wird der Parameter dort aber nicht gesetzt, so erhält er den Wert x. Wird diese Syntax innerhalb Deiner Vorlage verwendet, bedeutet das, dass der Parameter dort fest den Wert x erhält. Die Seite, die Deine Vorlage einbindet, kann keinen Einfluss mehr nehmen auf diesen Wert.

Eine Zusammenfassung aller Parameter

[Quelltext bearbeiten]

Deine Vorlage, die das Erscheinungsbild Deines Menüs konfiguriert, ist in drei Blöcke unterteilt. Im ersten Block wird die Initialisierung des Menüs vorgenommen. Im darauf folgenden Block werden Deine Tabs definiert. Danach wird die Konfiguration abgeschlossen.

Initialisierungsparameter

[Quelltext bearbeiten]
Initialisierungsparameter
Die folgenden Parameter beziehen sich auf den ersten Code-Block „BeginTemplateDeiner Vorlage (hier beispielhaft abgebildet):
{{TabMenu <!-- Initialisierung  -->
  <!-- Header für den Beginn eines TabMenüs:    -->  | Mode = BeginTemplate | Position = {{{Position|Top}}}      
  <!-- Ausrichtung des Rahmens:                 -->  | Move = {{{Move|0px,0px}}} | FrameAlign = {{{FrameAlign|center}}}
                                                     | FrameWidth = {{{FrameWidth|100%}}}
  <!-- Position und äußeren Abstand zum Rahmen: -->  | Margin = {{{Margin|0px}}}
  <!-- Globales Erscheinungsbild:               -->  | Shadow = {{{Shadow|On}}} | Rotate = {{{Rotate|0}}} }}
Parameter Beschreibung
Mode Das setzen des Parameters
Mode = BeginTemplate

bewirkt, dass das Template zur Initialisierung des Tabmenüs aufgerufen wird.

Position Der Parameter
Position = Top bzw. Position = Bottom

legt fest, ob die Tabs oben oder unten (siehe hier) angezeigt werden sollen. Vorbelegt ist die Position mit dem Wert Top jedoch erhält dieser Parameter seinen tatsächlichen Wert in der Regel erst beim Einbinden Deiner Vorlage in Form von

{{Benutzer:MaxMustermann/DeineVorlage | Position=<Top oder Bottom> | ... }}
Move Der Parameter
Move = 35px -42px

hebt das Menü aus seinen Angeln und verschiebt es auf dem Bildschirm (hier um 35 Bildpunkte nach rechts und 42 nach oben). Für mehr Informationen dazu siehe die Hilfeseite „Das Menü in seiner Position verschieben (Move und Margin)“.

FrameWidth Der Parameter
FrameWidth = 25%

erzeugt ein Tabmenü mit einer Breite von 25% des zur Verfügung stehenden Platzes auf dem Bildschirm. Für weitere Infos dazu siehe die Hilfeseite „Die Breite des Menüs festlegen (FrameWidth)“.

Siehe auch: „Hack: Keine feste sondern eine maximale Breite des Menüs vorgeben

FrameAlign Der Parameter
FrameAlign = left

platziert das Tabmenü innerhalb Deiner Seite links. Weitere Werte können right (für rechts) oder center (mittig) sein. Für weitere Infos dazu siehe die Hilfeseite ab „Das Menü innerhalb Deiner Seite rechts platzieren (FrameAlign = right)“.

Siehe auch: „Hack: Zentriertes Menü umgeben von Text

Margin Der Parameter
Margin = 28px

legt einen äußeren Abstand zur Umgebung des Tabmenüs von 28 Bildpunkten fest (gleichermaßen 28px über dem Tabmenü, rechts, unter dem Tabmenü und links davon). Mit den folgenden Werten

Margin = 0px 10px 10px 0px

wird ein Abstand von 10 Bildpunkten zum rechten und unteren Rand erzeugt (Werte im Uhrzeigersinn für oben, rechts, unten, links). Für mehr Informationen dazu siehe die Hilfeseite „Den äußeren Abstand zum Menürand festlegen (Margin)“.

Siehe auch: „Das Menü in seiner Position verschieben (Move und Margin)

Shadow Der Parameter
Shadow = On

schaltet den Schatten des Tabmenüs an, wohingegen der Wert Off den Schatten ausschaltet. Die dazu gehörende Hilfeseite findest Du hier: „Schatten und Rotation“.

Siehe auch: „Hack: Im aktiven Tab unten einen Schatten erzeugen

Rotate Der Parameter
Rotate = 0

schaltet die Rotation aus. Positive Werte lassen Dein Tabmenü nach rechts kippen; nagative Werte kippen es links herum. Die dazu gehörende Hilfeseite findest Du hier: „Schatten und Rotation“.

Siehe auch: „Hack: Schiefes TabMenü


Tab-Parameter

[Quelltext bearbeiten]
Tab-Parameter
Die folgenden Parameter beziehen sich auf den mittleren Code-Block „Tabs zeichnenDeiner Vorlage (hier beispielhaft abgebildet):
{{TabMenu <!-- Tab1 -->
  <!-- Tab-Bezeichner und sein Modus: -->  | Mode = {{{Tab1|Passive}}}FirstLBTab | Shadow = {{{Shadow|On}}}
  <!-- Tab-Titel mit Link:            -->  | Name = [[Benutzer:DeinBenutzername|Benutzer]]
  <!-- Tab-Titel Parameter:           -->  | PaFont = Arial | ActFont = 'Segoe Script'
  <!-- Tab-Farbe:                     -->  | PaBgColor = CAE1FF | ActBgColor = {{{BgColor|FFFFFF}}}
  <!-- Tab-Formatierung:              -->  | TabWidth = 1 | TabSpace = 3 | TabHeight=25
  <!-- Zum Einbinden des Tabmenüs:    -->  | Position = {{{Position|Top}}} }}
{{TabMenu <!-- Tab2 -->
  <!-- Tab-Bezeichner und sein Modus: -->  | Mode = {{{Tab2|Passive}}}LastLMTab | Shadow = {{{Shadow|On}}}
  <!-- Tab-Titel mit Link:            -->  | Name = [[Benutzer:DeinBenutzername/Artikel|Artikel]]
  ...
Parameter Beschreibung
Mode Der Parameter
Mode = {{{<TabBezeichner>|Passive}}}

erhält als erstes den Bezeichner des Tabs, der beispielsweise Tab1 heißen kann (Mode={{{Tab1|Passive}}}) oder Tab2 (Mode={{{Tab2|Passive}}}), etc. Der Bezeichner ist frei wählbar. Du kannst stattdessen also auch TabBenutzer oder TabArtikel oder eine beliebige andere Bezeichnung für den Tab wählen und dort eintragen. Der von Dir festgelegte Tabbezeichner wird später auf der Seite benötigt, in der Du Dein Tabmenü einbindest. Dort gibst Du ihn als Parameter an und versetzt damit einen der Tabs in den Modus eines aktiven (angeklickten) Tabs, beispielsweise per

{{Benutzer:MaxMustermann/DeineVorlage | Tab2=Active | ... }}

Der Wechsel des Darstellungsmodus von einem passiven (nicht angeklickten) zu einem aktiven (angelickten) Tab erfolgt also erst beim Einbinden des Tabmenüs. Daher sollte jeder Tab innerhalb Deiner Vorlage zunächst den Modus Passive erhalten in Form von

Mode = {{{<TabBezeichner>|Passive}}}
FirstTab- / LastTab-Zusatz
Innerhalb Deiner Vorlage kann der erste und letzte Tab abhängig von der gewünschten Formatierung mit einem Zusatz versehen werden in Form von
Mode = {{{<TabBezeichner>|Passive}}}<Zusatz>

Darüber lassen sich die Tabs links, rechts, mittig oder als Block ausrichten. Im Folgenden werden die dafür benötigten Zusätze beschrieben.

Hinweis: Bei allen anderen Tabs enfällt der Zusatz.
FirstLBTab Der First...-Zusatz kommt lediglich beim ersten Tab zur Anwendung, beeinflußt dabei aber die Ausrichtung sämtlicher Tabs:
Mode = {{{Tab1|Passive}}}FirstLBTab

Darüber erhält das Tabmenü einen speziellen Modus, wenn die Tabs links oder als Block ausgerichtet sein sollen. Bei einem mittig oder rechts ausgerichteten Tabmenü entfällt der FirstLBTab-Zusatz, allerdings muss dann stattdessen der erste Tab auf

TabSpace = 0

gesetzt werden.

LastRBTab, LastLMTab Die beiden Last...-Zusätze finden lediglich beim letzten Tab Anwendung. In Kombination mit dem Modus für den ersten Tab (siehe oben) ist der Zusatz
Mode = {{{TabX|Passive}}}LastRBTab

für die Tabausrichtung rechts oder als Block zuständig. Im Unterschied dazu findet der Zusatz

Mode = {{{TabX|Passive}}}LastLMTab

für links oder mittig ausgerichtete Tabs Anwendung.

Siehe auch die Hilfeseiten zu „Tabs rechts anordnen“, „Tabs mittig anordnen“, „Tabs links anordnen“, „Tabs über die komplette Breite ziehen (Block)“ und „Ein einzelner Tab“.
Position Siehe hier.
Shadow Siehe hier.
Name Innerhalb Deiner Vorlage läßt sich pro Tab mit dem Parameter
Name = [[Link|Titel]]

der Tabtitel festlegen, mit dazugehörendem Link. Die dazu gehörende Hilfeseite findest Du hier: „Tabtitel (Name, Schriftart, Form)“.

PaFont Der Parameter
PaFont = Arial

legt die Schriftart fest, die ein passiver (nicht angeklickter) Tab haben soll (hier die Schriftart Arial). Die dazu gehörende Hilfeseite findest Du hier: „Tabtitel (Name, Schriftart, Form)“.

Siehe auch: „Hack: Text mit Schatten“ und „Hack: Textgröße anpassen

PaFontWeight Der Parameter
PaFontWeight = normal

legt die Strichstärkte fest. Der hier gezeigte Wert entspricht der Standardeinstellung; der PaFontWeight-Parameter muss also nich angegeben werden, es sei denn, Du willst den Wert ändern. Für eine normale Darstellung gibt es das Schlüsselwort normal, während bold für Fettschrift steht. Die dazu gehörende Hilfeseite findest Du hier: „Tabtitel (Name, Schriftart, Form)“.

ActFont Der Parameter
ActFont = Arial

legt die Schriftart fest, die ein aktiver (angeklickter) Tab haben soll (hier die Schriftart Arial). Die dazu gehörende Hilfeseite findest Du hier: „Tabtitel (Name, Schriftart, Form)“.

Siehe auch: „Hack: Text mit Schatten“ und „Hack: Textgröße anpassen

ActFontWeight Der Parameter
ActFontWeight = bold

legt die Strichstärkte fest. Der hier gezeigte Wert entspricht der Standardeinstellung; der ActFontWeight-Parameter muss also nich angegeben werden, es sei denn, Du willst den Wert ändern. Für eine normale Darstellung gibt es das Schlüsselwort normal, während bold für Fettschrift steht. Die dazu gehörende Hilfeseite findest Du hier: „Tabtitel (Name, Schriftart, Form)“.

PaBgColor Der Parameter
PaBgColor = CAE1FF

legt die Hintergrundfrabe fest, die der Tab haben soll, so lange er passiv (nicht angeklickt) ist. Der Wert CAE1FF ist ein RGB-Farbwert. Auf der Seite Hilfe:Farbtabelle kannst Du Dir die passende Farbe und den dazu gehörenden Wert heraussuchen und ihn über den o.g. Parameter dem Tab zuweisen.

ActBgColor Der Parameter
ActBgColor = FFFFFF

legt die Hintergrundfrabe fest, die der Tab haben soll, so lange er aktiv (angeklickt) ist. Der Wert FFFFFF ist ein RGB-Farbwert. Auf der Seite Hilfe:Farbtabelle kannst Du Dir die passende Farbe und den dazu gehörenden Wert heraussuchen und ihn über den o.g. Parameter dem Tab zuweisen. Besser ist es, wenn der Wert wie folgt zugewiesen wird

ActBgColor = {{{BgColor|FFFFFF}}}

weil dann auch der Parameter BgColor einen Einfluss auf die Tabfarbe nehmen kann (siehe den folgenden Punkt).

BgColor BgColor legt die Hintergrundfarbe des Tabmenüs im gerade aktiven Tab fest. Er wird ausschließlich als Parameter beim Einbinden Deines Tabmenüs verwendet in Form von beispielsweise
{{Benutzer:MaxMustermann/DeineVorlage | BgColor=FFFFFF | ... }}

Dabei überschreibt der Parameter nicht nur die Farbe des gerade aktiven Tabs, sondern auch die innerhalb des restlichen Rahmens. Der Wert FFFFFF ist ein RGB-Farbwert. Auf der Seite Hilfe:Farbtabelle kannst Du Dir die passende Farbe und den dazu gehörenden Wert heraussuchen und ihn über den o.g. Weg dem Tabmenü zuweisen.

TabWidth Mit Hilfe des Parameters
TabWidth = 20%

läßt sich die Breite einzelner Tabs unterschiedlich festlegen (hier erhält der Tab für den der Wert festgelegt wird 20% der verfügbaren Breite des Tabmenüs). Die passende Hilfeseite findest Du hier: „Registerkarten (Tabs) links, rechts, mittig oder in Kombination anordnen“.

TabSpace Der Parameters
TabSpace = 35

legt den Abstand zwischen den Tabs fest. Für den entsprechenden Tab wird hier ein Abstand zu seinem vorhergehenden Tab von 35 Bildpunkten gewählt. Die passende Hilfeseite findest Du hier: „Registerkarten (Tabs) links, rechts, mittig oder in Kombination anordnen“.

TabHeight Der Parameter
TabHeight = 42

hinter einem beliebigen Tab erzeugt die große Tabhöhe von 42 Bildpunkten. Die passende Hilfeseite findest Du hier: „Tabhöhe“.

AdjustRight Der Parameter
AdjustRight = 55

legt fest, dass ein Abstand von 55 Bildpunkten zwischen dem letzten Tab und dem rechten Rand des Tabmenüs erzeugt werden soll. Du kannst auch

AdjustRight = 23%

schreiben und damit einen rechten Rand festlegen, der 23% der ferfügbaren Fläche des Tabmenüs entspricht. Die passende Hilfeseite findest Du hier: „Registerkarten (Tabs) links, rechts, mittig oder in Kombination anordnen“.


Parameter für den Vorlagenabschluss

[Quelltext bearbeiten]
Parameter für den Vorlagenabschluss
Die folgenden Parameter beziehen sich auf den abschließenden Code-Block „EndTemplateDeiner Vorlage (hier beispielhaft abgebildet):
{{TabMenu | Mode=EndTemplate | Position={{{Position|Top}}} | ActBgColor={{{BgColor}}} | Shadow={{{Shadow|On}}} | Padding={{{Padding|10px}}} }}
Parameter Beschreibung
Mode Der Parameter
Mode = EndTemplate

bewirkt, dass das Template zum Abschluss des Tabmenüs aufgerufen wird.

Position Siehe hier.
Padding Dieser Abschnitt befindet sich im Aufbau...
ActBgColor Dieser Abschnitt befindet sich im Aufbau...
BgColor Dieser Abschnitt befindet sich im Aufbau...
Shadow Siehe hier.

  Tabs oben   Tabs unten   Tabs oben und unten   Menüs verschachteln   Feineinstellungen   Hacks   Fehlersuche   Parameter
  Zweck und Überblick   Konzept und praktische Anwendung   Formatierung der Tabs   Technischer Hintergrund