[edytuj] [odśwież] Dokumentacja

Użycie edytuj

Szablon (w połączeniu np. z szablonami {{SpisPozycja}} i {{id}}) umożliwia tworzenie spisów treści tekstów, które działają prawidłowo umieszczone jednocześnie zarówno na zwykłych stronach i podstronach tekstów (np. na stronach tytułowych), jak i na stronach zbiorczych ich całości.

Szablon sprawdza na jakiej stronie aktualnie pracuje i gdy jest na stronie tytułowej, generuje link do strony (lub podstrony) danego rozdziału; natomiast gdy stwierdzi, że pracuje na stronie całości, (której nazwa kończy się frazą /całość) generuje link do danej jej sekcji (a więc zwykle do oznaczonego rozdziału).

Aby szablon pracował prawidłowo, poszczególne tytuły rozdziałów (sekcji) powinny być uprzednio oznaczone tzw. kotwicą #id, np. za pomocą szablonu {{id}}. Można do tego celu użyć także inne szablony, które mają możliwość wstawiania kotwicy #id, np: {{f}}, {{f*}} lub {{c}} - wykorzystując ich parametr o nazwie id.

Opis parametrów edytuj

  • Parametr 1nazwa identyfikatora tytułu rozdziału, wstawionego uprzednio do tekstu, np. za pomocą szablonu {{id}}, najlepiej stosując go w postaci: {{id|nazwa identyfikatora tytułu|span|nazwa tytułu rozdziału}},
  • Parametr 2nazwa tytułu rozdziału (sekcji),
  • Parametr 3 (opcjonalny)nazwa strony, do której będzie generowany link na "zwykłych" stronach; gdy parametr zostanie pominięty, szablon wygeneruje link do strony o nazwie typu Nazwa_strony_tytułowej/Nazwa_identyfikatora, a więc np. Potop/Rozdział XX, gdy jako parametr 1 podamy Rozdział XX a szablon będzie pracował na stronie (lub podstronie strony) Potop.

Przykład edytuj

Zobacz aplikację tego szablonu w Szablon:Skradzione perły/Spis treści, który jest następnie inkludowany na stronie tytułowej: Skradzione perły i na stronie całości: Skradzione perły/całość.

Zauważ, że gdy {{Szablon:Skradzione perły/Spis treści}} inkludowany jest na stronie tytułowej to jego linki prowadzą do poszczególnych rozdziałów tego tekstu, które znajdują się na oddzielnych podstronach; natomiast gdy szablon jest inkludowany na stronie całości, to jego linki prowadzą do tytułów rozdziałów tego tekstu, znajdujących się na tej samej stronie.

Zobacz też edytuj