[Patch] Don't force the trailing hashes to be added

[Ryan J Ollos]

As described in ​t:WikiFormatting#Headings, it is no longer required that trailing = be added (since 0.12.0, as far as I can tell). The same should be true for the hash symbols used by the NumberedHeadlinesPlugin.

I'm investigating whether a quick patch can be produced.

[Ryan J Ollos]

The patch below is based on ​formatter.py in 0.12.2. I'll also attach this as a patch file.

I'd propose making a 0.12 branch for the plugin. Let me know if I need to make any changes to the patch. I'll follow up quickly. In the meantime, I'll be using this on my production system and let you know if I find any issues.

0.11/tracnumberedheadlines/plugin.py

@@ -53 +53 @@
 
     NUM_HEADLINE = \
         r"(?P<nheading>^\s*(?P<nhdepth>#+)\s" \
-        r"(?P<nheadnum>\s*[0-9.]+\s)?.*\s(?P=nhdepth)\s*" \
+        r"(?P<nheadnum>\s*[0-9.]+\s)?.*\s*" \
         r"(?P<nhanchor>=%s)?(?:\s|$))" % XML_NAME
 
     outline_counters = WeakKeyDictionary()
@@ -69 +69 @@
         shorten = False
         match = match.strip()
 
+        hdepth = fullmatch.group('nhdepth')
         depth = min(len(fullmatch.group('nhdepth')), 6)
 
         try:
@@ -100 +101 @@
 
         num    = fullmatch.group('nheadnum') or ''
         anchor = fullmatch.group('nhanchor') or ''
-        heading_text = match[depth+1+len(num):-depth-1-len(anchor)].strip()
-
+        heading_text = match[depth+1+len(num):].strip()
+        if heading_text.endswith(hdepth):
+            heading_text = heading_text[:-depth]
+            
         num = num.strip()
         if num and num[-1] == '.':
           num = num[:-1]

[Ryan J Ollos]

Also, I have commit access to all of the repository, so if you approve of this change, I can push it to the repository to save you some time.

[Ryan J Ollos]

Here is a patch that includes the previous patch and also makes some additional changes to mirror the implementation in formatter.py.

• A level 7 heading ======= heading ======== isn't recognized by Trac. Previously, the NumberedHeadlinesPlugin would treat a level 7 numbered heading as a level 6 numbered heading. With the change below, it isn't recognized, which I think leads to more predicable behavior for the editor of a wiki page.
• A regular expression is used to capture the heading text.
• Renamed variable heading_text to htext.

0.11/tracnumberedheadlines/plugin.py

@@ -52 +52 @@
     XML_NAME = r"[\w:](?<!\d)[\w:.-]*?" # See http://www.w3.org/TR/REC-xml/#id 
 
     NUM_HEADLINE = \
-        r"(?P<nheading>^\s*(?P<nhdepth>#+)\s" \
-        r"(?P<nheadnum>\s*[0-9.]+\s)?.*\s(?P=nhdepth)\s*" \
-        r"(?P<nhanchor>=%s)?(?:\s|$))" % XML_NAME
+        r"(?P<nheading>^\s*(?P<nhdepth>#{1,6})\s" \
+        r"(?P<nheadnum>\s*[0-9.]+\s)?(?P<nhtext>.*?)" \
+        r"(?P<nhanchor>=%s)?\s*$)" % XML_NAME
 
     outline_counters = WeakKeyDictionary()
 
@@ -68 +68 @@
     def _parse_heading(self, formatter, match, fullmatch):
         shorten = False
         match = match.strip()
-
-        depth = min(len(fullmatch.group('nhdepth')), 6)
+        
+        hdepth = fullmatch.group('nhdepth')
+        depth = len(hdepth)
 
         try:
           formatter.close_table()
@@ -100 +101 @@
 
         num    = fullmatch.group('nheadnum') or ''
         anchor = fullmatch.group('nhanchor') or ''
-        heading_text = match[depth+1+len(num):-depth-1-len(anchor)].strip()
-
+        htext  = fullmatch.group('nhtext').strip()
+        if htext.endswith(hdepth):
+            htext = htext[:-depth]
+            
         num = num.strip()
         if num and num[-1] == '.':
           num = num[:-1]
@@ -117 +120 @@
               n = n + 1
             counters[depth-len(numbers[n:]):] = numbers[n:]
 
-        if not heading_text:
+        if not htext:
           return tag()
 
         heading = format_to_oneliner(formatter.env, formatter.context, 
-            heading_text, False)
+            htext, False)
 
         if anchor:
             anchor = anchor[1:]
@@ -144 +147 @@
         while s < len(counters) and counters[s] == 0:
           s = s + 1
 
-        oheading_text = heading_text
-        heading_text = '.'.join(map(str, counters[s:]) + [" "]) + heading_text
+        oheading_text = htext
+        htext = '.'.join(map(str, counters[s:]) + [" "]) + htext
 
         if self.number_outline:
-          oheading_text = heading_text
+          oheading_text = htext
 
         heading = format_to_oneliner(formatter.env, formatter.context, 
-            heading_text, False)
+            htext, False)
         oheading = format_to_oneliner(formatter.env, formatter.context, 
             oheading_text, False)

[Ryan J Ollos]

Just wanted to checkin and see if the author of the plugin is still around, and if there would be any objections to pushing this patch to the repository.