Przejdź do zawartości

Szablon:GenLinks

Z Wikiźródeł, wolnej biblioteki
[edytuj] [odśwież] Dokumentacja

Użycie

[edytuj]

{{GenLinks|10|4,7}} tworzy linki do poszczególnych podstron, linki są widoczne jako kolejne liczby rzymskie z zakresu I–X, po IV i VII wstawiany jest znak nowej linii.

Cel użycia

[edytuj]

Podstawowym, najczęstszym użyciem szablonu jest tworzenie minimalistycznego spisu treści na stronie indeksującej, a więc listy linków w stylu:

IIIIII
IVV

Służy do tego pierwszy parametr (nienazwany) oraz drugi. W podanym powyżej przykładzie kod miałby postać {{GenLinks|5|3}}.

Standardowo tworzone są liczby rzymskie (domyślnie). Dla uzyskania liczb arabskich użyjemy parametru liczby (czyli …|liczby=arabskie|….

Jeśli istnieje konieczność dodania na początku lub na końcu takiej listy jeszcze innych linków (np. Epilog) można otrzymać separator odpowiadający stylowi całe listy przez użycie szablonu bez parametrów ({{GenLinks}}).

O ile koniec listy jest określany przy pomocy pierwszego nienazwanego argumentu, co jest konieczne dla uzyskania niepustej listy i lista zaczyna się od liczby 1, to czasem może być konieczne uzyskanie listy zaczynającej się od innej liczby – ten jest określany przez trzeci argument.

Inne parametry są już zdecydowanie rzadziej używane i pozwalają na precyzyjne dopasowanie linków do konkretnej sytuacji.

  • parametr czwarty dostosowuje cel do którego prowadzi kliknięcie a więc [[tę część/III|…]] (np. [[Ciekawa nowela/III|]] lub [[Ciekawa nowela/Rozdział III|]]) – efekt może być pożądany na przykład w sytuacji, gdy na stronie głównej tekstu tworzymy linki do rozdziałów tomu I, tomu II itd.
  • parametr piąty dostosowuje widoczny tekst w linku przez poprzedzenie go prefiksem (czyli [[…|tę część III]]) – np. [[|Ciekawa nowela/III]] lub [[|Rozdział III]]. Może to być przydatne na przykład przy tworzeniu ukrytej listy do rozdziałów w ramach szablonu {{Summary|widoczny=nie}}.

Opis parametrów

[edytuj]
  • Parametr 1 (opcjonalny formalnie) określa koniec listy linków
    • pusty, równy zero lub niezdefiniowany argument powoduje, że szablon zwraca sam separator
  • Parametr 2 (opcjonalny) określa, gdzie ma być podział linii (format np. 7,14,21)
  • Parametr 3 (opcjonalny – domyślnie 1) określa początek listy linków
  • Parametr 4 (opcjonalny) podaje, jak ma wyglądać strona główna i tekst przed samą liczbą
    • np.: Test/ dla uzyskania Test/I, Test/II, Test/III itd. (domyślnie jest to {{FULLPAGENAME}}/)
    • może to być jednak również np. Test/Rozdział␣ dla uzyskania stron Test/Rozdział I, Test/Rozdział II itd.
    • Jako syntactic sugar ukośnik na początku jest zamieniany na {{FULLPAGENAME}}/ np.: /Część druga → {{FULLPAGENAME}}/Część druga/)
  • Parametr 5 (rzadko potrzebny) – określa prefix dla widocznej części linku np.: [[link|prefixXVI]]
  • Parametr liczby (nazwany):
    • jeśli jest słowem arabskie, zwraca liczby arabskie
    • jeśli jest pominięty lub inny, zwraca liczby rzymskie (opcja domyślna)

Przykład

[edytuj]

Lista linków może się lepiej prezentować wycentrowana i złożona większą czcionką:

Kod Wynik Linkuje do
{{c|w=130%|{{GenLinks|10|5}} }}
I        II        III        IV        V
VI        VII        VIII        IX        X
Przykładowa strona/I, Przykładowa strona/II ...
{{c|w=130%|{{GenLinks|8|4||{{ROOTPAGENAME}}/}} }}
I        II        III        IV
V        VI        VII        VIII
Przykładowa strona/III, Przykładowa strona/IV
{{c|w=130%|{{GenLinks|9|5||{{ROOTPAGENAME}}/Część trzecia/}} }}
I        II        III        IV        V
VI        VII        VIII        IX
Przykładowa strona/Część trzecia/II, Przykładowa strona/Część trzecia/III, ...
{{c|w=130%|{{GenLinks|9|3,6||Dowolna strona/}} }}
I        II        III
IV        V        VI
VII        VIII        IX
Dowolna strona/I, Dowolna strona/II, ...
{{c|w=130%|{{GenLinks|10|3,6,8||/Dowolna strona/}} }}
I        II        III
IV        V        VI
VII        VIII
IX        X
Przykładowa strona/Dowolna strona/I, Przykładowa strona/Dowolna strona/II, ...
{{c|w=130%|{{GenLinks|10|7|5}} }}
V        VI        VII
VIII        IX        X
Przykładowa strona/V, Przykładowa strona/VI ...
{{c|w=130%|{{GenLinks|8|4|liczby=arabskie}}}}
1        2        3        4
5        6        7        8
Przykładowa strona/1, Przykładowa strona/2 ...
{{c|w=130%|{{GenLinks|3||||Rozdział }}}}
Rozdział I        Rozdział II        Rozdział III
Przykładowa strona/I, Przykładowa strona/II ...
{{c|w=130%|[[{{FULLPAGENAME}}/Wstęp|Wstęp]]{{GenLinks}}{{GenLinks|3}} }}
Wstęp        I        II        III
Przykładowa strona/Wstęp, Przykładowa strona/I, Przykładowa strona/II


Uwaga: W przestrzeni głównej, gdzie ten szablon jest najczęściej stosowany, {{FULLPAGENAME}} (opcja domyślna) to po prostu nazwa strony, na której jest wywoływany, np. strona główna tekstu. Tutaj użyto Przykładowa strona jako nazwy strony.

Uwagi techniczne

[edytuj]

W szablonie wykorzystywane są głównie parametry pozycyjne (nienazwane). Wynika to z dwóch przyczyn:

  • w przeważającej liczbie przypadków używa się jedynie dwóch pierwszych parametrów np.: {{GenLinks|15|8}}
  • parametry pozycyjne nr 4 i 5 z kolei mogą wymagać podania spacji na końcu argumentu, łatwiej to zrobić w przypadku parametrów pozycyjnych

Zobacz też

[edytuj]