Szablon:BieżącyR/opis
To jest podstrona dokumentacji dla strony Szablon:BieżącyR. Zawiera ona informacje na temat użycia tej strony, jej kategoryzację i inną zawartość niebędącą częścią oryginalnej strony. |
Użycie
edytujSzablon podaje bieżący numer podstrony w tekście wielostronicowym, w którym kolejne podstrony są numerowane na końcu swej nazwy cyframi rzymskimi w zakresie liczb od I do C[1].
Szablon może być np. wstawiony w wywołaniu wyświetlenia danej sekcji indeksu typu: <pages index="abc" from="x" fromsection="{{bierzącyR}}" to="y" tosection="{{bieżącyR}}" />. 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.
W tym zastosowaniu nie powinien być stosowany, ponieważ opiera się na nieudokumentowanej kolejności parsowania i może przestać działać.
Wynikiem pracy szablonu wstawionego na stronie głównej jest * (gwiazdka).
Zaletą szablonu jest to, że po jego wstawieniu, przy kopiowaniu zawartości danej podstrony do następnej podstrony, nie musimy aktualizować numerów sekcji ręcznie. Dzieje się to automatycznie, co upraszcza pracę i chroni przed pomyłką.
Komplementarnym szablonem dla tego szablonu jest szablon {{BieżącyRA}}, który odczytuje rzymski numer strony na której aktualnie został użyty i podaje go cyframi arabskimi, co może być czasami przydatne.
Opis parametrów
edytujSzablon ma jeden parametr opcjonalny:
- Parametr 1 — wyraz lub ciąg znaków, który został dodany przed numerem podstrony, np. Rozdział , Część nr , Numer-, itp. i tworzy z numerem jej nazwę typu /Rozdział VII, /Część nr VIII, /Numer-XXXII, 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 1 w wywołaniu szablonu, np. {{BieżącyRA|1=}} lub {{BieżącyRA|}}. Szablon do analizy numeru bierze ostatni ciąg znaków znajdujących się po prawej stronie ostatniej spacji (przy czym może to być dowolny typ spacji, a więc także tzw. spacja twarda) lub ostatnim znaku "-" w nazwie danej podstrony.
Przykład
edytujZobacz aplikację tego szablonu na podstronach tekstu Włamywacz Raffles mój przyjaciel, np. Raffles mój przyjaciel/Rozdział I. Służy on tutaj do automatycznego wyboru właściwej sekcji w wywołaniu <pages index ... />.
- ↑ Czyli od 1 do 100 - jest to zakres w zupełności wystarczający przy numeracji rozdziałów w typowych książkach, lecz w razie potrzeby można go łatwo rozszerzyć przez powiększenie wewnętrznej tablicy przeliczeń szablonu o kolejne liczby.
Zobacz też
edytuj- dla liczb rzymskich: {{BieżącyRA}}, {{NastępnyR}}, {{PoprzedniR}}
- dla liczb arabskich: {{Bieżący}}, {{Następny}}, {{Poprzedni}}
- oraz: {{Dane tekstu}}, {{Nagłówek}}