Vorlage:Scroll Gallery

Dokumentation für die Vorlage {{Scroll Gallery}}[Ansicht] [Bearbeiten] [Versionsgeschichte] [Aktualisieren]

Shortcuts: {{Galerie}} {{Gallery}}

Diese Vorlage benutzt Modul:Scroll Gallery, Skripte geschrieben in der Programmiersprache Lua. Bitte informiere dich dort, wenn du mehr über die Sprache und ihren Einsatz erfahren willst. Diese Vorlagen sollte im Regelfall nicht ersetzt werden.

Diese Vorlage verwendet TemplateStyles. Die Stilvorlagen sind in der Datei Vorlage:Scroll Gallery/styles.css notiert.

Aufruf

Funktion: Die Vorlage dient zur Präsentation einer Bilderfolge. Es können beliebig viele Bilder präsentiert werden. Auf Bilder mit extremen Seitenverhältnissen sollte man verzichten. Bei der Auswahl der Bilder sollte auf identische Ausrichtung wie Quer- oder Hochformat geachtet werden.
Verwendung:

{{Scroll Gallery
| title =
| align =
| Datei | Unterschrift
| Datei | Unterschrift
| ...
| ...
| ...
| Datei | Unterschrift
}}

Es genügt in den allermeisten Fällen, nur den Titel sowie die Paare Dateiname und Bildunterschrift anzugeben.

Mit zusätzlichen optionalen Parametern:

{{Scroll Gallery
| title =
| align =
| width =
| height =
| upright = 0.76
| Datei | Unterschrift
| Datei | Unterschrift
| ...
| ...
| ...
| Datei | Unterschrift
}}

Optionale Parameter:
- |title= Titel der Bildergalerie
  - |Titel=, |caption=, |Überschrift= Aliase für title.
- |align= Lage am linken Rand (left, links), am rechten Rand (right, rechts) oder mittig (center, Mitte, zentriert). Standard ist rechts (right), d. h., die Angabe rechts kann entfallen.
  - |Ausrichtung= Alias für align.
- |width= Maximale Breite der Bilder mit oder ohne „px“. Standard ist die von den Nutzern in den Einstellungen vorgegebene Breite, meist 250px. Die Breiten- und Höhenangaben sind nicht zwingend notwendig, und man sollte auf sie ähnlich wie im Fall der Bild-MediaWiki-Syntax verzichten.
  - |Breite=, |Größe= Aliase für width.
- |height= Maximale Höhe der Bilder in Pixel mit oder ohne die Angabe „px“. Auch hier gilt, dass man auf die Angabe verzichten sollte. Mit den Argumenten upright/hochkant kann man die Bildhöhe beeinflussen (siehe unten).
  - |maxHeight=, |Höhe= Aliase für height.
- |loop=no oder nein unterdrücken die Weiterschaltung beim ersten oder letzten Bild.
  - |Schleife= Alias für loop.
- |upright Wertloser Verkleinerungsfaktor für alle Bilder in der Galerie. Diese Angabe muss zwingend vor den Bilderangaben stehen. upright ist identisch zu upright = 0.76.
- |upright= Verkleinerungs- oder Vergrößerungsfaktor für alle Bilder in der Galerie. Gültige Werte liegen zwischen 0.5 und 1.5. Werte unter 1 bewirken eine Verkleinerung, Werte über 1 eine Vergrößerung. Ein für viele Fälle passender Wert ist 0.76. |upright= darf nicht zusammen mit |upright verwendet werden.
  - |hochkant= Alias für upright.

Die anzuzeigenden Abbildungen bestehen immer aus paarweisen Angaben: Dateiname und Bildunterschrift. Der Dateiname kann den Namensraumbezeichner enthalten, muss es aber nicht. Im Dateinamen und in der Bildunterschrift dürfen keine senkrechten Striche (pipe) und Gleichheitszeichen enthalten sein. Sollten diese Zeichen nötig sein, so schreibe man für das Gleichheitszeichen = und für den senkrechten Strich |.

Wenn weitere Bildparameter wie der Skalierungsfaktor hochkant gebraucht werden, so muss man sie wie folgt vor der Bildunterschrift notieren:

| Dateiname | hochkant{{==}}0.5{{!}}Bildunterschrift (man achte auf das doppelte Gleichheitszeichen)
| Dateiname | {{hochkant|0.5}}Bildunterschrift

Der Parameter hochkant kann nicht zusammen mit einer festen Größenangabe verwendet werden.

Beispiel:

Kamelmarkt in Birqasch

Zum Vergleich das allein stehende Bild: Kamelmarkt, Bild 1

{{Scroll Gallery
| title = Kamelmarkt in Birqasch
| timeDependent = yes
| loop = no
| BirqashCamelMarket1.jpg | Kamelmarkt, Bild 1
| BirqashCamelMarket2.jpg | Kamelmarkt, Bild 2
| BirqashCamelMarket3.jpg | Kamelmarkt, Bild 3
| BirqashCamelMarket4.jpg | Kamelmarkt, Bild 4
| BirqashCamelMarket5.jpg | Kamelmarkt, Bild 5
| BirqashCamelMarket6.jpg | Kamelmarkt, Bild 6
| BirqashCamelMarket7.jpg | Kamelmarkt, Bild 7
| BirqashCamelMarket8.jpg | Kamelmarkt, Bild 8
}}

Auf einer Seite lassen sich mehrere Galerien platzieren.

Für zeitabhängige Galerien stehen zwei weitere Parameter zur Verfügung:

|timeDependent=yes
|hideUnitHeader=yes

Die erste Option bewirkt, dass das Startbild im Laufe des Tages so gewechselt wird, dass jedes Bild gleichlang angezeigt würde. Im Falle dieser Option (und nur dieser) könnte es sinnvoll erscheinen, den Zähler und die Pfeile auszublenden. Dies geschieht mit der zweiten Option. Was hinter dem Gleichheitszeichen steht, ist egal. Man könnte auch „ja“ oder „yes“ schreiben.

1. Beispiel einer Bildergalerie mit Bildern im Hochformat:

Variante „alle hochkant“

Im Fall von z. B. hohen Bauwerken wie Türmen oder Kirchen muss man als Fotograf auf das Hochformat setzen. Damit derartige Bilder nicht übergroß dargestellt werden, gibt es den Parameter hochkant/upright bei Bildern. Es ist aber aufwändig, jedes Bild einer Galerie mit diesem Parameter zu versehen. Deshalb ist es möglich, einen derartigen Parameter auch in der Scroll Gallery anzugeben, der dann für alle Bilder gültig ist und Verkleinern (Werte < 1 … 0.5 ) oder Vergrößern (Werte > 1 … 1,5) der Bilder ermöglicht.

{{Scroll Gallery
| title = Variante „alle hochkant“
| upright
| Zug Kapuzinerturm 1.jpg | Kapuzinerturm in Zug, Schweiz
| Zug Pulverturm 2.jpg | Pulverturm in Zug, Schweiz
| Zug Knopfliturm 4.jpg | Knopfliturm in Zug, Schweiz
}}

2. Beispiel einer Bildergalerie mit Bildern im Hochformat:

Das nachfolgende Beispiel veranschaulicht die unterschiedlichen Möglichkeiten der Größenangabe, dabei wurde immer das gleiche Bild zum besseren Vergleich verwendet. Das erste Bild ohne Breitenangabe sollte bei hochformatigen Bildern vermieden werden.

Variante „Breitenangabe je Bild“

{{Scroll Gallery
| title = Variante „Breitenangabe je Bild“
| Zug Kapuzinerturm 1.jpg | Kapuzinerturm, ohne hochkant-Angabe (Faktor 1)
| Zug Kapuzinerturm 1.jpg | hochkant{{==}}0.85{{!}} Kapuzinerturm, hochkant, mit Wert (Faktor 0,85)
| Zug Kapuzinerturm 1.jpg | hochkant{{!}} Kapuzinerturm, hochkant ohne Breitenangabe (Faktor 0,76)
| Zug Kapuzinerturm 1.jpg | {{hochkant|0.5}} Kapuzinerturm, mit Vorlage hochkant (Faktor 0,5)
}}

Technischer Hintergrund

Benannte und unbenannte Parameter

Um die Nutzung der Vorlage möglichst einfach zu halten, werden sowohl benannte als auch unbenannte (also nummerierte) Parameter verwendet.

Benannte Parameter bestehen aus dem Parameternamen, einem Gleichheitszeichen und einen beliebigen Wert, z. B. |title=Das ist der Titel. Bei benannten Parametern werden die Werte immer „getrimmt“, d. h., alle Leerzeichen und Zeilenumbrüche, sog. whitespaces, vor und hinter den eigentlichen Werten werden entfernt.
Unbenannte Parameter bestehen nur aus dem Wert selbst. Damit mehrere derartige Parameter auseinandergehalten werden können, werden sie intern durchnummeriert. Die Modulprogrammierung sorgt dafür, dass im Fall unbenannter Parameter die Werte ebenfalls getrimmt werden. Es können also auch in diesem Fall Leerzeichen und Zeilenwechsel vor und hinter den Werten geschrieben werden.

Im Fall benannter Parameter gibt es in den meisten Fällen Ersatz- bzw. Aliasbezeichnungen, üblicherweise in Deutsch und Englisch.

Im Fall der Mediendefinitionen werden genau zwei Parameter benötigt: der Medien-Dateiname und die Medienbeschreibung. Dies sind unbenannte Parameter. D. h., die erste Mediendefinition könnte auf nachfolgende zwei Weisen geschrieben werden:

| erster Medien-Dateiname | erste Medienbeschreibung
| 1 = erster Medien-Dateiname | 2 = erste Medienbeschreibung

Die Zählung bei den Mediendefinitionen beginnt üblicherweise mit 1.

Die Beschränkung auf nur zwei Parameter birgt das Problem, dass man keine weiteren Medienparameter wie hochkant, class= o. a. verwenden kann. Diese müssen vor die Medienbeschreibung gesetzt werden, wobei der Strich „|“ (pipe) und das Gleichheitszeichen durch {{!}} bzw. {{==}} (zwei Gleichheitszeichen!) zu ersetzen sind, damit sie von der Vorlage nicht fehlinterpretiert, also als unbenannter/benannter Parameter interpretiert werden. Um die Schreibarbeit etwas zu vereinfachen, gibt es die Vorlage {{hochkant}}, die mit oder ohne Faktor eingesetzt werden kann.

| Mediendateiname1 | {{Hochkant|0.5}} Medienbeschreibung1
| Mediendateiname2 | hochkant {{!}} link {{==}} Artikel {{!}} Medienbeschreibung2

Hochkant-Definitionen

Eine Besonderheit stellt der Parameter hochkant/upright dar. Er wird gleichartig auf alle Medien angewandt. Den Parameter gibt es sowohl als unbenannten als auch benannten Parameter.

Benannter Parameter: | hochkant = 0.5 oder | upright = 0.5.
Unbenannter Parameter: | hochkant oder | upright. Genau genommen ist dies kein Parametername, sondern nur ein Wert. Die Modulsoftware sucht nach diesem Wert und sorgt dafür, dass im entsprechenden Bild der Standardwert 0,76 zur Anwendung gelangt. Natürlich bringt dieser unbenannte Wert die Zählung bei den Medien durcheinander. Deswegen muss diese Angabe zwingend vor den Mediendefinitionen erfolgen. Dies wird von der Modulsoftware berücksichtigt, d. h., die Zählung bei der Mediendefinition beginnt bei 2, nicht bei 1.

Unbenannte und benannte | hochkant Parameter stellen zwei verschiedene Parameter dar und sollten nicht gleichzeitig in einer Vorlage eingesetzt werden. Wird dies dennoch vorgenommen, so wird dem unbenannten Parameter | hochkant der Vorzug gegeben, und es erfolgt eine Fehlerausschrift.

Größenangaben

Auf Angaben wie |Breite= oder |Höhe= sollte verzichtet werden. Bilder mit diesen Festparametern sind nicht skalierbar, weil sie eben einen festen Wert besitzen. Damit werden die Nutzereinstellungen für die Standardbildbreite (wenn nicht verändert, sind dies gegenwärtig 250px), ignoriert. Erst recht sollten keine Definitionen für übergroße Medien vorgenommen werden, da diese auf Mobiltelefonen häufig nicht vollständig angezeigt werden. Gegenwärtig gelten Bilder ab einer Größe von 251 Pixeln als übergroß.

Natürlich gibt es Fälle, in denen Bilder mit einer geringeren oder größeren Breite benötigt werden. Dann sollten aber die Faktoren hochkant oder upright angewandt werden.

Wartungskategorien

Bekannte Probleme

Die gängigen Browser (Chrome, Edge, Mozilla, Opera, Safari) haben bei der Bildschirmdarstellung kaum Probleme. Im Fall von deaktiviertem JavaSript wird nur das erste Bild ohne Rollen-Werkzeug dargestellt. Beim Drucken können Fehler auftreten.

Hinweise

Die obige Dokumentation wurde aus der Seite Vorlage:Scroll Gallery/Doku eingefügt. (bearbeiten | Versionsgeschichte) Die Kategorien für diese Vorlage sollten in der Dokumentation eingetragen werden. Die Interwiki-Links sollten auf Wikidata eingepflegt werden.
Zur Vorlage gibt es eine XML-Beschreibung für die Vorlageneingabe mit Formularen.
Liste der Unterseiten