Recent Changes - Search:

PmWiki

pmwiki.org

00027

Summary: Table of Contents
Created: 2004-09-04 01:12
Status: Open
Category: CoreCandidate
From: Jonas?
Assigned:
Priority: 55555 55555 55555 55555 55555 43314
Version:
OS:

Description: Adding of a Table of Contens tag to the standard distribution of PmWiki. Something like http://www.pmichaud.com/wiki/Cookbook/PageTableOfContents would be great.


Given the existence of the cookbook script, I'm not quite ready to make this a part of the standard distribution. It needs a few more priority votes and some fleshing out of the basic concepts.

--Pm

Suggestions

  • the toc entrys are Links to the headings
  • <Toc Auto Depth> variable to define the heading depth that gets displayed like: (:toc 2 5:)
  • possibility to display the toc in a other page (for example in a sidebar) without the constraint to have the directive also in the target page
  • either replicate all the functionality of Cookbook/PageTableOfContents or write it in a way that a cookbook recipe can add just the missing features
  • the headings has a link to the toc

more general suggestion

  • Compatible to Cookbook.NumberedHeaders
  • if there is a link form the toc to the heading, there will be a anchor on the heading. To have a anchor on every heading in pages per default (not with the anchor markup) could be very usefull. Maby, it could be a way to make a script for building automatilcy anchors on headings (setable for all pages or just for pages with a toc) and a toc script that makes a list of headings with a link to it. noskule

I don't think I'm ready to say that I'll replicate *all* of the functionality of Cookbook.PageTableOfContents -- it's a little too feature-rich and specific for the core. However, I am fully committed that whatever we design will allow Cookbook/PageTableOfContents to continue to work, most likely by allowing it to simply add any features that don't make it into the core. --Pm


It's also worthy of note that TOC is a core feature in many currently popular wiki engines (e.g. MediaWiki, Dokuwiki). MateuszCzaplinski

Edit - History - Print - Recent Changes - Search
Page last modified on December 25, 2007, at 03:38 PM