Tworzenie spisu treści

Informacje ogólne

Mechanizm Wiki ma możliwość automatycznego tworzenia spisu treści dowolnej strony. Spis treści jest dynamicznie generowany na podstawie nagłówków zawartych w dokumencie, przy czym nie są uwzględniane nagłówki pierwszego poziomu (taki nagłówek powinien występować na każdej stronie co najwyżej raz).

Nagłówki w dokumentach


Nagłówki Wiki


Nagłówki w dokumentach Wiki tworzy się za pomocą znaków równości. W danym dokumencie powinien być co najwyżej jeden nagłówek najwyższego poziomu (odpowiednik <h1>) oraz dowolna ilość nagłówków niższych poziomów. Dla wygody poszczególne nagłówki zostały nazwane zgodnie z numerem, który generują przy tworzeniu Spisu Treści? dokumentów.

Przykłady nagłówków


==Nagłówek najwyższego poziomu==

Nagłówek najwyższego poziomu

===Nagłówek pierwszego poziomu===

Nagłówek pierwszego poziomu

====Nagłówek drugiego poziomu====

Nagłówek drugiego poziomu

=====Nagłówek trzeciego poziomu=====

Nagłówek trzeciego poziomu

======Nagłówek czwartego poziomu======
Nagłówek czwartego poziomu
=======Nagłówek piątego poziomu=======
Nagłówek piątego poziomu


Składnia polecenia

Podstawowy

Spis treści dokumentu tworzony jest za pomocą komendy {{toc}} (od angielskiego Table Of Contents).

Parametry

Komenda może przyjmować dodatkowe parametry {{toc page="nazwastrony" title="Nowy tytu&#322; strony" numerate=1}}, gdzie:


  1. page – jest nazwą strony, dla której wyświetlony zostanie spis treści. Jeżeli parametr nie zostanie podany, spis tworzony jest dla bieżącej strony,
  2. title – dodaje tytuł tworzonego spisu treści,
  3. numerate – włącza i wyłącza automatyczną numerację poszczególnych odnośników.

Przykłady


  • Spis treści bieżącego dokumentu: {{toc}}


  • Spis treści zewnętrznego dokumentu WIKI: {{toc page="formatowanietekstu"}}


  • Spis treści bieżącego dokumentu, ze zmienionym tytułem: {{toc title="Strony, której tytu&#322; jest inny"}}


  • Spis treści zewnętrznego dokumentu WIKI, osnośniki numerowane:{{toc page="/Doc/Polski/FormatowanieTekstu" numerate=1}}