doc/plugins/toc.mdwn

   1 [[template id=plugin name=toc author="[[Joey]]"]]
   2 [[tag type/chrome]]
   3
   4 Add a table of contents to a page:
   5
   6         \[[toc ]]
   7
   8 The table of contents will be automatically generated based on the
   9 headers of the page. By default only the largest headers present on the
  10 page will be shown; to control how many levels of headers are shown, use
  11 the `levels` parameter:
  12
  13         \[[toc levels=2]]
  14
  15 The toc plugin will take the level of the first header as the topmost
  16 level, even if there are higher levels seen later in the file.
  17
  18 The table of contents will be created as an ordered list. If you want
  19 an unordered list instead, you can change the list-style in your local
  20 style sheet.