Example image

ExplicitNumberingPlugin

Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Also support numbered headings.

Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text.

Use ---#, ---##, etc., to generate numbered headings.

Use ##5., ##., ##. to start a numbering sequence at 5

Syntax Rules

Numbered sequences

Numbered headings

General comments

Examples

If you have the plugin installed, the Rendered and Expected columns should be identical. If you do not have the plugin installed, the Rendered column will be the same as the Source column.

Source Rendered Expected
##. 1 1
##.. 1.1 1.1
##... 1.1.1 1.1.1
##.... 1.1.1.1 1.1.1.1
##..... 1.1.1.1.1 1.1.1.1.1
##...... 1.1.1.1.1.1 1.1.1.1.1.1
##....... 1.1.1.1.1.2 1.1.1.1.1.2
Chapter ##a#. Chapter 1 Chapter 1
Section ##a#.. Section 1.1 Section 1.1
Subsection ##a#... Subsection 1.1.1 Subsection 1.1.1
Req ##a#....: Req 1.1.1.1: Req 1.1.1.1:
Req ##a#....: Req 1.1.1.2: Req 1.1.1.2:
Subsection ##a#... Subsection 1.1.2 Subsection 1.1.2
Req ##a#....: Req 1.1.2.1: Req 1.1.2.1:
Req ##a#....: Req 1.1.2.2: Req 1.1.2.2:
##a#....a) a) a)
##a#....a) b) b)
##a#....a) c) c)
##A#....A) A) A)
##A#....A) B) B)
##A#....A) C) C)
Req ##a#....: Req 1.1.2.3: Req 1.1.2.3:
Section ##a#.. Section 1.2 Section 1.2
Chapter ##a#. Chapter 2 Chapter 2
Section ##a#.. Section 2.1 Section 2.1
Section ##a#.. Section 2.2 Section 2.2

Numbered heading examples

Reset anonymous numbering to 0 using =##0.

Write If Installed You should see
---# Heading level 1

1 Heading

1 Heading

---## Next level

1.1 Next level

1.1 Next level

---### And another

1.1.1 And another

1.1.1 And another

---++# Single numbered

2 Single numbered

2 Single numbered

ExplicitNumberingPlugin Global Settings

Plugin settings are stored as preferences settings. To retrieve a preference setting write it as a Foswiki Macro: %<plugin>_ <setting>%, i.e. %EXPLICITNUMBERINGPLUGIN_SHORTDESCRIPTION%

Note: This plugin does not obtain preference settings from this topic. Settings should be entered in the SitePreferences or Web Preferences topic. The following settings can be used.

      * #Set EXPLICITNUMBERINGPLUGIN_BOLD = 1
      * #Set EXPLICITNUMBERINGPLUGIN_ALPHASEQ = a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z
      * #Set EXPLICITNUMBERINGPLUGIN_ALPHASEQ = z,y,x,w,v,u,t,s,r,q,p,o,n,m,l,k,j,i,h,g,f,e,d,c,b,a
      * #Set EXPLICITNUMBERINGPLUGIN_ALPHASEQ = &#945;,&#946;,&#947;,&#948;,&#949;,&#950;,&#951;,&#952;,&#953;,&#954;,&#955;,&#956;
      * #Set EXPLICITNUMBERINGPLUGIN_DEBUG = 1

See also

The Foswiki:Extensions.TocPlugin provides a more complete table of contents and cross-reference management.

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Plugin Info

Plugin Author: TWiki:Main.MartinVlach, Foswiki:Main.ThomasWeigert (21 Nov 2006)
Copyright: © 2003, Lynguent, Inc. © 2006, ProjectContributor
License: GPL (GNU General Public License)
Plugin Version: 6482 (2010-02-23)
Plugin Release: 1.6
Change History:
22 Feb 2010: Foswikitask:Item2654 - internal changes compatible with trunk, Foswikitask:Item2665: various enhancements - added alpahbet setting for alpha sequence, Foswikitask:Item8493 - documentation enhancements
4 Jun 2009: Added a bold preference option; Foswikitask:Item8167 (Foswiki:Main.SallyHoughton)
3 Mar 2009: Exclude textareas from rendering to improve compatibility with Foswiki:Extensions.EditChapterPlugin. Completed rename to Foswiki namespace (Foswiki:Main.GeorgeClark); Foswikitask:Item1038
12 Feb 2009: Fixed regular expression to parse enumerated headings (Foswiki:Main.MichaelDaum); Added support for upper-case alphabetic enumerations (TWiki:Main.DarrenElkerton)
21 Nov 2006: Added reset to specific number based on suggestion by TWiki:Main.SteveWampler. Added support of numbered headers. Proper handling in table of content.
17 Sep 2003: Added alpha-labeled lists.
12 Aug 2003: Initialize sequences in startRenderingHandler. Thank you TWiki:Main.IngoKarkat.
29 Jul 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.8.0
Plugin Home: http://foswiki.org/Extensions/ExplicitNumberingPlugin

Related Topics: DefaultPreferences, SitePreferences, Plugins

-- Foswiki:Main.ThomasWeigert - 21 Nov 2006
spacer