Changes between Version 12 and Version 13 of NumberedHeadlinesPlugin

Timestamp:

Oct 26, 2009, 3:51:40 AM (15 years ago)

Author:

Martin Scharrer

Comment:

--

NumberedHeadlinesPlugin

@@ -36 +36 @@
 The following options can be added to select if
  * headlines in outlines (`PageOutline`, TocMacro) should be numbered (#4521, #5241)
- * CSS should be used for the numbering
  * numbering should start at the second level (`##`/`h2`) not at the first level (#4907)
 
@@ -43 +42 @@
 [numberedheadlines]
 numbered_outline      = true
-use_css_for_numbering = true
 numbering_starts_at_level_two = false
 }}}
@@ -64 +62 @@
 
 == Example ==
+
+=== Normal Usage ===
+
 The following wiki text:
 {{{
@@ -106 +107 @@
 }}}
 
+However with the config options `numbering_starts_at_level_two = true` it will be displayed without the first level numbers:
+
+{{{
+#!html
+<div style="border: thin solid ; padding-left: 1cm; width: 30em">
+<h1>Introduction</h1>
+<h1>Chapter 1</h1>
+<h2>1. Section 1.1</h2>
+<h3>1.1. Subsection 1.1.1</h3>
+<h4>1.2. Subsection 1.1.2</h3>
+<h2>2. Section 1.2</h2>
+<h3>2.1. Subsection 1.2.1</h3>
+<h3>Unnumbered</h3>
+<h3>2.2. Subsection 1.2.2</h3>
+<h1>Chapter 2</h1>
+<h2>1. Section 2.1</h2>
+<h3>1.1. SubSubsection 2.1.1</h3>
+<h4>1.1.1. SubSubsection 2.1.1.1</h3>
+<h5>1.1.1.1. Paragraph 2.1.1.1.1</h4>
+<h6>1.1.1.1. Subparagraph 2.1.1.1.1</h5>
+</div>
+}}}
+
+=== User Specified Numbers ===
+Since v0.2.1 leading zeros are ignored, which allows the use of numbered sections under an unnumbered chapter.
+
+This feature relates to ticket #4907.
+
+{{{
+= Title =
+## Section ##
+## Section ##
+}}}
+is now displayed as:
+{{{
+#!html
+<div style="border: thin solid ; padding-left: 1cm; width: 30em">
+<h1> Title </h1>
+<h2> 1. Section </h2>
+<h2> 2. Section </h2>
+</div>
+}}}
+
+=== User Specified Numbers ===
+Since v0.3 the numbers can be provided by the user to set or reset the counting.
+The number are simply written before the headline text followed by a space.
+
+Single numbers set the value of the current level, while multiple numbers ('`1.2.3.`') set the values from the current level upwards.
+Leading numbers as part of the headline text can be protected by using a dot followed by a space ('`. `') before them, e.g. '`## . 99 Red Balloons ##`'.
+
+This feature relates to ticket #4907.
+
+{{{
+# First Chapter #
+## First Section ##
+## 5. Now Section Five  ##
+## Next Section ##
+## 2.5. Now Section Five in Chapter 2 ##
+## Next Section ##
+
+# Next Chapter #
+## Section ##
+}}}
+
+will lead to the following numbering:
+
+{{{
+1. First Chapter
+1.1. First Section
+1.5. Now Section Five
+1.6. Next Section
+2.5. Now Section Five in Chapter 2
+2.6. Next Section
+
+3. Next Chapter
+3.1 Section
+}}}
+
+Headlines without an text but with a number will be not displayed at all (no HTML code generated), but the number is used as normal. This gives the user the possibility to change higher level heading numbers for following lower level headline without inserting empty headlines. Please note that for technical reasons there needs to be a space after the number and another one before the leading `#`, which makes two leading spaces.
+
+{{{
+# 1.  #
+## Section ##
+# 2.  #
+## Section ##
+}}}
+will produce:
+{{{
+1.1 Section
+2.1 Section
+}}}
 
 == Recent Changes ==