Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

[ikiwiki.git] / doc / plugins / contrib / headinganchors.mdwn

diff --git a/doc/plugins/contrib/headinganchors.mdwn b/doc/plugins/contrib/headinganchors.mdwn
index ef2fa122abf57057b6e2df71129bcfaf6c965837..becbf89a518daf924e38d102f60a9ce299c85dd8 100644 (file)
--- a/doc/plugins/contrib/headinganchors.mdwn
+++ b/doc/plugins/contrib/headinganchors.mdwn
@@ -1,6 +1,6 @@
 [[!template id=plugin name=headinganchors author="[[PaulWise]]"]]
 
-This is a simple plugin to add ids to all headings, based on their text. It
+This is a simple plugin to add ids (which will serve as [[anchor]]s) to all headings, based on their text. It
 works as a postprocessing filter, allowing it to work on mdwn, wiki, html,
 rst and any other format that produces html. The code is available here:
 
@@ -12,9 +12,9 @@ rst and any other format that produces html. The code is available here:
        use strict;
        use IkiWiki 2.00;
 
-       sub import { #{{{
+       sub import {
                hook(type => "sanitize", id => "headinganchors", call => \&headinganchors);
-       } # }}}
+       }
 
        sub text_to_anchor {
                my $str = shift;
@@ -26,11 +26,11 @@ rst and any other format that produces html. The code is available here:
                return $str;
        }
 
-       sub headinganchors (@) { #{{{
+       sub headinganchors (@) {
                my %params=@_;
                my $content=$params{content};
                $content=~s{<h([0-9])>([^>]*)</h([0-9])>}{'<h'.$1.' id="'.text_to_anchor($2).'">'.$2.'</h'.$3.'>'}gie;
                return $content;
-       } # }}}
+       }
 
        1