Changes between Version 11 and Version 12 of AutoWikifyPlugin

Timestamp:

Jul 28, 2012, 1:45:43 AM (12 years ago)

Author:

Ryan J Ollos

Comment:

Documentation improvements.

AutoWikifyPlugin

@@ -11 +11 @@
 == Configuration ==
 
-The AutoWikifyPlugin has three configurable options in TracIni, both in the `autowikify` section:
-
-||'''Option'''||'''Description'''||
-||`minimum_length=<int>`||Override the default minimum of 3 character long page names recognised.||
-||`explicitly_wikify=<name>[, <name> ...]`||Specify a list of names to explicitly wikify.||
-||`exclude=<name>[, <name> ...]`||A list of names to exclude from autowikification.||
-
-
-If you are installing this plugin 'globally', you will need to add the following entry to the {{{components}}} section of your {{{trac-ini}}} file:
+To install the plugin, you will need to add the following entry to the `components` section of your `trac.ini` file:
 
 {{{
+#!ini
 [components]
 tracautowikify.* = enabled
@@ -27 +20 @@
 }}}
 
-If you want to use the configuration options mentioned above, add the following section to that same file ('''NOTE:''' Use 'autowikify' for this section, not 'tracautowikify'):
+The AutoWikifyPlugin has three configurable options in TracIni, both in the `autowikify` section:
+
+|| '''Option''' || '''Description''' ||
+|| `minimum_length=<int>` || Override the default minimum of 3 character long page names recognised.||
+|| `explicitly_wikify=<name>[, <name> ...]` || Specify a list of names to explicitly wikify. ||
+|| `exclude=<name>[, <name> ...]` || A list of names to exclude from autowikification. ||
+
+If you want to use the configuration options mentioned above, add the following section to `trac.ini`:
 
 {{{
+#!ini
 [autowikify]
 minimum_length=<number>
-explicitly_wikify=<value(s)>
-exclude=<value(s)>
+explicitly_wikify=<comma-separated list of words>
+exclude=<comma-separated list of words>
 }}}
 
@@ -45 +46 @@
 
 
-== regex based wildcards in explicitly_wikify ==
-If like me ( [wiki:SvenDowideit] ) you want to link to an external wiki (TWiki) and need a large set of non-CamelCase words (in this case our bug tracking system (of the style of Bugs.Item1234) the you can modify autowikify.py to remove the escaping of regex strings - 
+== Regex based wildcards in explicitly_wikify ==
+If, like me, ([wiki:SvenDowideit]) you want to link to an external wiki (TWiki) and need a large set of non-CamelCase words (in this case our bug tracking system (of the style of Bugs.Item1234) the you can modify autowikify.py to remove the escaping of regex strings - 
 
 change 
 {{{
-        pattern = r'\b(?P<autowiki>' + '|'.join([re.escape(page) for page in pages]) + r')\b'
+#!python
+pattern = r'\b(?P<autowiki>' + '|'.join([re.escape(page) for page in pages]) + r')\b'
 }}}
 to 
 {{{
-        pattern = r'\b(?P<autowiki>' + '|'.join([page for page in pages]) + r')\b'
+#!python
+pattern = r'\b(?P<autowiki>' + '|'.join([page for page in pages]) + r')\b'
 }}}