[edytuj] [odśwież] Dokumentacja

Użycie

edytuj

Szablon podaje bieżący numer podstrony w tekście wielostronicowym, w którym kolejne podstrony są numerowane na końcu swej nazwy cyframi arabskimi, wg schematu:

  • Nazwa strony/1, /2, /3, ... /9, ... /99, ... /999, ... /9999, ...standardowo, bez podania parametru, lub Parametr 1 = 1
  • Nazwa strony/01, /02, /03, ... /99, ... /999, ... /9999, ... — gdy Parametr 1 = 2
  • Nazwa strony/001, /002, /003, ... /999, ... /9999, ... — gdy Parametr 1 = 3
  • Nazwa strony/0001, /0002, /0003, ... /9999, ... — gdy Parametr 1 = 4
  • itd.

Szablon może być umieszczony np. na końcu nazwy kategorii (po znaku „ | “ ) i służyć do automatycznego sortowania tych podstron wg zadanego wzorca zależnego od ich numeru bieżącego (i wyrazu lub ciąg znaków, który został dodany przed tym numerem). Wynikiem pracy szablonu wstawionego na stronie głównej jest * (gwiazdka).

Szablon może być także wstawiony w wywołaniu wyświetlenia danej sekcji indeksu typu: <pages index="abc" from="x" fromsection="{{bierzący}}" to="y" tosection="{{bieżący}}" />. Jeśli numer sekcji będzie taki sam jak numer danego rozdziału, to będzie ona zawsze automatycznie wyświetlona na właściwej stronie z danym rozdziałem, bez potrzeby ręcznej aktualizacji jej numeru.

Zaletą szablonu jest to, że po jego wstawieniu, przy kopiowaniu zawartości danej podstrony do następnej podstrony, nie musimy aktualizować sortowania podstron lub numerów sekcji ręcznie. Dzieje się to automatycznie, co upraszcza pracę i chroni przed pomyłką.

Opis parametrów

edytuj

Szablon ma dwa parametry opcjonalne:

  • Parametr 1 — liczba cyfr (1[1], 2, 3, 4... itd.), z których składa się numer strony - jeśli jednak rzeczywisty numer strony będzie zawierał mniej cyfr to zostanie on uzupełniony od lewej strony odpowiednią ilością zer wiodących; jeśli go pominiemy, to zostanie przyjęta 1 cyfra,
  • Parametr 2 — wyraz lub ciąg znaków, który został dodany przed numerem podstrony, np. Rozdział , Część nr , Numer-, itp. i tworzy z jej numerem nazwę typu /Rozdział 07, /Część nr 8, /Numer-00345, itp. Może on się składać z dowolnych (dozwolonych dla nazw stron znaków) i zawierać spacje, a spacja dodana na jego końcu może być istotna (bez takiej spacji nie będzie przerwy między ciągiem znaków a numerem podstrony). W przypadku pominięcia tego parametru skrypt sam analizuje nazwę podstrony i w przypadku gdy wykryje jakiś ciąg znaków przed jej numerem, to wstawi go automatycznie przed wykrytym numerem. Można to wyłączyć wstawiając pusty parametr 2 w wywołaniu szablonu, np. {{Bieżący|2=}} lub {{Bieżący||}}.

Przykład

edytuj

Zobacz aplikację tego szablonu na podstronach tekstu Diamenty księcia, np. Diamenty księcia/1. Służy on tutaj do sortowania poszczególnych podstron w kategorii wg wzoru złożonego z litery r połączonej z ich bieżącym numerem i do automatycznego wyboru właściwej sekcji w wywołaniu <pages index ... />.




  1. Wartość standardowa, jeśli parametr ma mieć właśnie taką wartość to może zostać pominięty.




Zobacz też

edytuj