Recent Changes - Search:

Cookbook

PmWiki

pmwiki.org

NumberedHeaders

Summary: Display numbered headers, indented paragraphs and table of contents
Version: 0.7
Status: Stable
Prerequisites: pmwiki-2
Maintainer: PRZ
Categories: TOC
Votes:

Goal

1/ Setting numbered headers, like

1 - Header
1.1 - Subheader
1.2 - Subheader
2 - Another Header
2.1 - Subheader
2.2 - Subheader

2/ Indenting the text following the header level

3/ Set a table of contents of said headers

Answer

Load the file numtoc.zipΔ

Copy the file numtoc.php in the cookbook directory

Set in the local/config.php file the line :

  include_once('cookbook/numtoc.php');

Documentation page PmWiki.NumberedHeaders will go in /wikilib.d directory.

You should make a reference to this page in the PmWiki.Documentation Index and probably also in a page describing the particularities of your own wiki.

Notes and comments

  • This recipe was last tested on PmWiki version: 2.2.0.beta57
  • This recipe requires at least PmWiki version: 2.?
  • php code size : 3.5 ko.

Usage

Use it with the usual headers !, !!, !!! -> !!!!!!
This is limited to four levels but can start from any level.
This is on purpose, please take care of your readers by making small pages, an easy task on a Wiki.

- Numbering

To have numbered headers, set the directive (:num:) and the headers will be numbered after the directive setting. (:nonum:) stops the numbering. The numbering starts from the first numbered header level seen:

!!general header (not numbered)
(:num:)
!!Header numbered
!!!Subheader numbered
!!!Subheader...
!!Another Header
!!!Subheader
(:nonum:)
!!Header not numbered (Annex..)
!!Header not numbered (Annex..)

general header (not numbered)

1. Header numbered

1.1. Subheader numbered

1.2. Subheader...

2. Another Header

2.1. Subheader

Header not numbered (Annex..)

Header not numbered (Annex..)

- Table of Contents

To have a page table of contents, set the directive (:toc:):

!general header - not in toc
''' Table of Contents'''
(:toc:)
!Header
!!Subheader
!!Subheader
!Another Header
!!Subheader
(:notoc:)
!A new Header - not in toc
!!Subheader - not in toc

general header - not in toc

Table of Contents

Header

Subheader

Subheader

Another Header

Subheader

A new Header - not in toc

Subheader - not in toc

directive (:notoc:) stops the table of contents recording, but only one table of contents can exist in a page.

The table and indentation will work on 4 levels maximum.

- Indentation

To have text indented following the header level, set the directive (:indent:) before the first header. The indentation margin is based upon the first header seen after the directive. Anything below that level will show strange results

(:indent:)
!!general header
!!Header
!!!Subheader
!!!Subheader...
!!Another Header
!!!Subheader
(:noindent:)
Text not indented

general header

Header

Subheader

Subheader...

Another Header

Subheader

Text not indented


The browsers default headers being way too large, if they are not redefined in your skin, you may want to set in your config.php the below text, which give more reasonnable sizes.

 
$HTMLStylesFmt['numheader'] = " 
  h1 {font-size:132%; margin:20px 0px;}
  h2 {font-size:124%; margin:16px 0px;}    
  h3 {font-size:116%; margin:12px 0px;}
  h4 {font-size:108%; margin:12px 0px;}  
";

Note that if css files are defined in the /pub/css directory, they will override the hereabove settings.

Site example :

Options

You can define the numbering type with a parameter in the directive (:num:) , like (:num A-1.a.1) :), which gives you the following numbering

A) Header
A-1) SubHeader
A-1.a.1) ...
B) ...
B-2.c.4) ...
You always should define 4 numbering characters, 3 separators and ending chars.
The separators are defined with only one character, but the final ending can have multiple character, like (:num 1.1.1.1/ - :). More than one blank chars are only displayed as one blank.
You can change the default value '1.1.1.1. ' by setting the variable $DefNum = 'your desc'; in your local/config.php file, e.g.
$DefNum = 'A 1-a.1/ ';

Styling

You can override the default styling which are as follows.

The table of contents is in a container with the class .tocstyle . Default content of the class : empty.

The indentation of the table of contents is defined by the following classes :

 
$HTMLStylesFmt['nmhtoc']= "
  .toc1 {margin-left:1em;}
  .toc2 {margin-left:2em;}
  .toc3 {margin-left:3em;}
  .toc4 {margin-left:4em;}  
";

The indentation of the text blocks is defined by the following classes :

 
$HTMLStylesFmt['nmhindent']= "
  .indent1 {margin-left:1.25em;}
  .indent2 {margin-left:2.5em;}
  .indent3 {margin-left:3.75em;}
  .indent4 {margin-left:5em;}  
";

And the header have a negative indentation compared to the hereabove. This is defined in a variable :

 $HdrIndStyle = 'text-indent:-1em;';

Restrictions

You should deactivate the recipe PageTableOfContents of John Rankin.

Instead of the recipe of John Rankin, there is no parameter for (:toc:) directive. Only a naked directive will work.

The Q: markups are listed in the table of contents. If you don't want that, deactivate the markup '^Q:toc'.

This recipe should not be used together with AutoTOC, which can automatically create numbered headers.

History

  • V0.1 First issue feb. 2005
  • V0.3 Issue with table of contents 20 feb. 2005
  • V0.4 Allow start at a level > 1 - 20 feb. 2005
  • V0.5 Corrected bug with [[link|text]] - 22 feb. 2005
  • V0.6 Corrected bug w/ smileys - added (:notoc:) in footer - 14 mar. 2005
  • V0.7 Added the Tom patch to remove styling - 6 dec. 2006

Discussion

Is there any way to make it so if my second header is longer than one line it will indent that line as well? Right now my second header is indented on the first line, but it spills over to a second line in the TOC that is not indented. Looks very sloppy, any ideas? Thanks, Bryan.

I am trying to include a TOC on every page, I have put the TOC code in Main.GlobalHeader and inserted thise file in my theme. However unless I use the TOC code in the page itself it does not show up, and then of course I have two :) How might I get a TOC on top of every page?

Take a look at Cookbook.AllGroupHeader

I would like to see a option for horizontal line before each header (level 1). I doesn't work with indent, because the line starts at the last subheader indent. I have tried noindent, ---- and then indent but after some headers there are strange effects.

I've increased the maximum level of headings from 4 to 6 (the maximum recognized by PmWiki). You can download it here: numtoc_max.zipΔ if you are interested. //Aidin


Bugs

11.feb.2010 Jerome
To have numbered AND letters headers, i've set the directive (:num 1.A :) and the headers will not be marked with letters after the directive setting. I use the last pmwiki 2.2.10 and trying to use the PHP option global on without success. Thanks for your help. JB

!!general header (not numbered)
(:num 1.a.1.a. :)
!!Header numbered
!!!Subheader numbered
!!!Subheader...
!!Another Header
!!!Subheader
(:nonum:)

general header (not numbered)

3. Header numbered

3.1. Subheader numbered

3.2. Subheader...

4. Another Header

4.1. Subheader

Which previous PmWiki version worked with this recipe? (So that we could investigate what core changes broke this feature.) --Petko February 11, 2010, at 08:13 AM

Thanks a lot Petko. In the NOTES & COMMENTS above, it's said that "This recipe was last tested on PmWiki version: 2.2.0.beta57". I never use pmwiki before, so i can't give feedback on older versions.

After some tests, it looks like the (:num 1.a. :) command doesn't work even in 2.2.0.beta57. But if you use this format in the whole site, you can add to config.php such a line
$DefNum ='1.a.1.a. ';
which seems to work. I suppose that the author could help you better -- maybe try to contact him by e-mail. --Petko February 16, 2010, at 06:56 PM

Good idea Petko, i'm going to send him an email, because of course i can't use an unique format $DefNum ='1.a.1.a. '; in the whole site. I hope he can help because i don't have find any solution for the moment.


2.feb.2008 Manne
When invoking the validator on this current page:
This page is not Valid XHTML 1.0 Transitional!
Result: Failed validation, 329 Errors
Perhaps this recipe should get some rework concerning validation. Like this recipe very much.

6.jan.2008, Petr
still the bug where headers containing an anchor (eg [[#anchor]] ) don't display in the toc at all.

31. May 2007, Markus
Every header in my whole Wiki align is left when using this cookbook. %'center'% doesn't work anymore!?

24.May 2007, Lars:
Would it somehow be possible to limit the levels of subheadings displayed? I (on only one page) want the TOC to only contain ! and !!-headings, but not !!!.

A second issue is that special characters (e.g. á) appear in their markup in the TOC (as á), not as the special character. In the heading/subheading they are displayed correctly.

Thanks for your help.

7.Apr.2006 Is it possible to add number restarting? so it's possible to start from number other than 1. Very useful for pages included in other pages, to keep virtual numbering.

You can define a numbering style like (: num 2.1.1.1 :) and it will start numbering at 2, instead of 1.

Joshua Kugler

9.feb.2006, a.l.e:

  • The patch by tom should fix a bug when using this module with SectionEdit
  • I've also added
    $title = preg_replace("/(.*?)/","<kbd>\\1</kbd>", $title);
    in order to allow preformatted text in the toc!
    i guess that a similar patch could be usefull for italic text.

27.jan.2006, Tom: I dunno how my configuration is set, but I was getting "%block margin-top=0px%" prepended to all of my titles in the TOC. So I added a small fix in my version of numtoc.php below the line that eats the anchors and extracts the text of links.

 
$title = preg_replace ("/(%.*?%)([^%]*)/", "\\2", $title);

This may not be the most elegant solution, but it works for me, and I think it behaves correctly (did some minor testing). If you have any suggestions for improvement, I'd be happy to acquiesce.

As soon styles are used for the heading e.g. this is displayed in the toc-list. Klonk August 31, 2005, at 06:39 AM

Ok, tom patch added on V0.7 - I was willing to use section edit, so discovering the problem... PRZ

See also

Cookbook /
Accordion  lightweight Accordion javascript requiring no framework (stable)
AutoTOC  Unobtrusive Automatic Table of Contents links (stable)
HandyTableOfContents  Handy Client-side Table of Contents (stable)
NumberedSections  Add section numbers on a page (stable)
PageTableOfContents  Adds a clickable table of contents to a page (Stable)
QuickPageTableOfContents  Adds a dropdown clickable table of contents to a page - client side processing (Stable)
SlimTableOfContents  Simple or Numbered Table of Contents, Compatible with SectionEdit Recipe (working)
TableOfContentsPortion  Inserts a portion of external table of contents into the page (Alpha)

Contributors

User notes? : If you use, used or reviewed this recipe, you can add your name. These statistics appear in the Cookbook listings and will help newcomers browsing through the wiki.

Edit - History - Print - Recent Changes - Search
Page last modified on February 05, 2014, at 12:22 PM