Changes between Version 23 and Version 24 of NumberedHeadlinesPlugin


Ignore:
Timestamp:
Oct 29, 2017, 8:14:41 AM (7 years ago)
Author:
figaro
Comment:

Moved example to description

Legend:

Unmodified
Added
Removed
Modified

  • NumberedHeadlinesPlugin

    v23 v24  
    2222You can mix both unnumbered and numbered headlines on the same wiki page. Headlines from first order (1x`#` on each side) to sixth order (6x`#` on each side) are supported. An own ID can be given by adding `=idname`, of which idname should be a valid XHTML name.
    2323
    24 == Bugs/Feature Requests
    25 
    26 Existing bugs and feature requests for NumberedHeadlinesPlugin are
    27 [report:9?COMPONENT=NumberedHeadlinesPlugin here].
    28 
    29 If you have any issues, create a
    30 [/newticket?component=NumberedHeadlinesPlugin new ticket].
    31 
    32 [[TicketQuery(component=NumberedHeadlinesPlugin&group=type,format=progress)]]
    33 
    34 == Download
    35 
    36 Download the zipped source from [export:numberedheadlinesplugin here].
    37 
    38 == Source
    39 
    40 You can check out NumberedHeadlinesPlugin from [/svn/numberedheadlinesplugin here] using Subversion, or [source:numberedheadlinesplugin browse the source] with Trac.
    41 
    42 == Installation
    43 
    44 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
    45 
    46 == Configuration
    47 
    48 To enable this plugin put the following into your `trac.ini` configuration file:
    49 {{{#!ini
    50 [components]
    51 tracnumberedheadlines.* = enabled
    52 }}}
    53 
    54 The following options can be added to select if:
    55  * headlines in outlines (`PageOutline`, `TocMacro`) should be numbered (#4521, #5241)
    56  * numbering should start at the second level (`##`/`h2`) not at the first level (#4907)
    57 
    58 Example where default values are shown:
    59 {{{#!ini
    60 [numberedheadlines]
    61 numbered_outline = true
    62 numbering_starts_at_level_two = false
    63 }}}
    64 
    65 == Example
    66 
    6724=== Normal Usage
    6825
    … …  
    7027{{{
    7128= Introduction =
     29
    7230# Chapter 1 #
    7331## Section 1.1 ##
    … …  
    7634## Section 1.2 ##
    7735### Subsection 1.2.1 ###
     36
    7837=== Unnumbered ===
     38
    7939### Subsection 1.2.2 ###
    8040# Chapter 2 #
    … …  
    8848will be displayed like this:
    8949
    90 {{{
    91 #!html
    92 <div style="border: thin solid ; padding-left: 1cm; width: 30em">
     50{{{#!html
     51<div style="border: 2px solid darkred; padding-left: 1cm; width: 30em">
    9352<h1>Introduction</h1>
    9453<h1>1. Chapter 1</h1>
    … …  
    11170However with the config options `numbering_starts_at_level_two = true` it will be displayed without the first level numbers:
    11271
    113 {{{
    114 #!html
    115 <div style="border: thin solid ; padding-left: 1cm; width: 30em">
     72{{{#!html
     73<div style="border: 2px solid darkred; padding-left: 1cm; width: 30em">
    11674<h1>Introduction</h1>
    11775<h1>Chapter 1</h1>
    … …  
    14199## Section ##
    142100}}}
     101
    143102is now displayed as:
    144 {{{
    145 #!html
    146 <div style="border: thin solid ; padding-left: 1cm; width: 30em">
     103{{{#!html
     104<div style="border: 2px solid darkred; padding-left: 1cm; width: 30em">
    147105<h1> Title </h1>
    148106<h2> 1. Section </h2>
    … …  
    172130will lead to the following:
    173131
    174 {{{
    175 #!html
    176 <div style="border: thin solid ; padding-left: 1cm; width: 30em">
     132{{{#!html
     133<div style="border: 2px solid darkred; padding-left: 1cm; width: 30em">
    177134
    178135<h1 id="FirstChapter">1. First Chapter</h1><p>
    … …  
    202159}}}
    203160
    204 Headlines without text but with a number will be not displayed at all, ie 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:
     161Headlines without text but with a number will not be displayed at all, ie 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:
    205162
    206163{{{
    … …  
    212169
    213170will be displayed as:
    214 {{{
    215 #!html
    216 <div style="border: thin solid ; padding-left: 1cm; width: 30em">
     171{{{#!html
     172<div style="border: 2px solid darkred; padding-left: 1cm; width: 30em">
    217173
    218174<h2 id="Section">1.1. Section</h2><p>
    … …  
    223179</div>
    224180}}}
     181
     182== Bugs/Feature Requests
     183
     184Existing bugs and feature requests for NumberedHeadlinesPlugin are
     185[report:9?COMPONENT=NumberedHeadlinesPlugin here].
     186
     187If you have any issues, create a
     188[/newticket?component=NumberedHeadlinesPlugin new ticket].
     189
     190[[TicketQuery(component=NumberedHeadlinesPlugin&group=type,format=progress)]]
     191
     192== Download
     193
     194Download the zipped source from [export:numberedheadlinesplugin here].
     195
     196== Source
     197
     198You can check out NumberedHeadlinesPlugin from [/svn/numberedheadlinesplugin here] using Subversion, or [source:numberedheadlinesplugin browse the source] with Trac.
     199
     200== Installation
     201
     202General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     203
     204== Configuration
     205
     206To enable this plugin put the following into your `trac.ini` configuration file:
     207{{{#!ini
     208[components]
     209tracnumberedheadlines.* = enabled
     210}}}
     211
     212The following options can be added to select if:
     213 * headlines in outlines (`PageOutline`, `TocMacro`) should be numbered (#4521, #5241)
     214 * numbering should start at the second level (`##`/`h2`) not at the first level (#4907)
     215
     216Example where default values are shown:
     217{{{#!ini
     218[numberedheadlines]
     219numbered_outline = true
     220numbering_starts_at_level_two = false
     221}}}
     222
    225223
    226224== Recent Changes