Differences

This shows you the differences between two versions of the page.

--- plugin:autolink4 [2018-12-17 17:53] – zioth
+++ plugin:autolink4 [2024-03-03 12:32] (current) – [Discussion] 43.239.85.173
@@ Line 1: / Line 1: @@
 ====== AutoLink 4 Plugin ======
 ---- plugin ----
-description: Automatically link text in your wiki to pages.
+description: Automatically link text in your wiki to pages
 author     : Eli Fenton
 email      : elifenton@this_is_not_a_real_email.fake
 type       : syntax
-lastupdate : 2018-12-17
+lastupdate : 2024-02-10
-compatible : greebo
+compatible : Greebo, Hogfather, Igor, Jack Jackrum, Kaos
 depends    :
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : links
-downloadurl: http://github.com/zioth/dokuwiki-autolink4/zipball/master
+downloadurl: https://github.com/zioth/dokuwiki-autolink4/zipball/master
-bugtracker : http://github.com/zioth/dokuwiki-autolink4/issues
+bugtracker : https://github.com/zioth/dokuwiki-autolink4/issues
-sourcerepo : http://github.com/zioth/dokuwiki-autolink4/
+sourcerepo : https://github.com/zioth/dokuwiki-autolink4
 donationurl:
@@ Line 21: / Line 21: @@
 ----
-This plugin automatically links text on your page to other pages of your wiki. There are already two other plugins that do this. Which one should you choose?
+This plugin automatically links text on your page to other pages of your wiki. There are already two other plugins that do this. What makes this one different?
   * It's easy to configure.
   * It's up to date, and works with the latest version of DokuWiki.
-  * It doesn't modify the original copies of the page; links are created on demand. This could result in reduced performance, but I tested with 100 links, and there was no noticeable negative effect.
+  * It doesn't modify the original copies of the page, so if you uninstall the plugin, the links are gone.
+  * It integrates with [[autotooltip]] to automatically generate tooltips for each link.
 More information: [[plugin:autolink4:differences|Choosing an autolink plugin]].
@@ Line 33: / Line 34: @@
 Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
-===== Examples/Usage =====
+===== Examples / Usage =====
 This plugin is configured with a list of links in the DokuWiki admin interface. Each line of the configuration consist of three fields separated by commas:
-  * Text to find. This can include certain regular expression characters, like square brackets and question marks. Pipe (|) and parentheses are not allowed. This plugin always links whole words and phrases. It will never link just part of a word.
+  * Text to find. This can include certain regular expression characters, like square brackets and question marks. Pipe (|) and parentheses are not allowed. This plugin always links whole words and phrases. It will never link just part of a word. See note below on non-English language support.
   * The link for the text.
   * The namespace where the replacement is done. Omit this field to replace everywhere.
+  * Flags. These can include:
+    * tt: If the [[plugin:autotooltip|Auto-Tooltip plugin]] is installed, the link will be displayed with a tooltip, including the page title and abstract.
+    * once: Only link the first occurrence of this tooltip on a page.
+    * inword: Replace partial words. DokuWiki defines a word as characters surrounded by spaces or punctuation, so this is required for languages that do not require space between words.
+== Simple examples ==
-== Simple example ==
   Things, mywiki:thing
 This links the word "Things" to mywiki:thing, everywhere on your wiki. It only links it when capitalized.
+  Things, mywiki:thing#heading
+This links to the section of the mywiki:thing page with the section header "heading."
 == Limiting replacement to a namespace ==
   Things, mywiki:thing, mywiki
 The word "Things" will only be replaced inside the "mywiki" namespace.
+== Tooltips ==
+  Things, mywiki:thing, , tt
+The link will include a tooltip, which is drawn from the title and abstract of mywiki:thing. This feature requires [[autotooltip]].
+Links to specific sections will base the tooltip on the page, not the section. This is due to a limitation of DokuWiki and autotooltip (the tooltip comes from the abstract, and sections do not have abstracts).
+== Search inside of words ==
+  Things, mywiki:thing, , inword
+== Combining flags ==
+  Things, mywiki:thing, , once|tt
+The link will include a tooltip, and only the first occurrence of this match will be linked.
 == Regular expressions ==
   [Tt]hings?, mywiki:thing
-This links the words "Thing," "thing," "Things" and "things" to mywiki:thing. Remember that some regular expression characters are not allowed.
+This links the words "Thing," "thing," "Things" and "things" to mywiki:thing. Some of the more useful regular expression tools include:
+  * Square brackets([]): Matches every character between the brackets.
+  * Question mark (?): The previous character is optional.
+  * Period (.): Match any character.
+  * Asterisk (*): Match zero or more of the previous character.
+  * Plus (+): Match one or more of the previous character.
+  * \s: Match a space.
+  * \S: Match a non-space.
+  * \b: Match the start or end of a word.
+Not supported:
+  * DokuWiki forbids the use of pipe (|) or parentheses. Using these will fail, and break other plugins.
 == Proper ordering ==
   Incredible Things, mywiki:thing
   Things, mywiki:thing
-Replacements are made in the order in which they occur in the configuration. So if you have a short replacement which is contained within a longer one, list the longer one first:
+Replacements are made in the order in which they occur in the configuration. So if you have a short replacement which is contained within a longer one, list the longer one first.
+===== Non-English language support =====
+Due to [[issue>856|limited non-Latin support in DokuWiki]], this plugin cannot work with certain characters in regular expressions. To fix it, you will have to edit some core DokuWiki code. Open ''/inc/Parsing/Lexer/ParallelRegex.php'', and change the ''getPerlMatchingFlags'' function to:
+  protected function getPerlMatchingFlags()
+  {
+    return ($this->case ? "umsS" : "umsSi");
+  }
 ===== Development =====
+=== Performance ===
+I tested with 500 regular expression matches, with no noticeable impact on performance. If you scale to several thousand, I recommend limiting the number of regular expression links.
+==Nerd speak==
+The asymptotic complexity of this plugin is O(r*u + s), where r is the total number of configured links with regular expression characters, s is the number of configured links without regular expression characters, and u is the number of unique matched text strings on the page. This means that performance is only minimally impacted by non-regex entries, and becomes worse the more regex entries you have, and the more times those entries appear on the page.
 === Change Log ===
 {{rss>https://github.com/zioth/dokuwiki-autolink4/commits/master.atom date}}
 === ToDo/Wish List ===
-  * Optionally only link the first occurrence on the page.
+  * If you have more than 500 or so configured links, you reach the maximum number of hooks DokuWiki can handle. This can be fixed by turning this into an action plugin, or by modifying DokuWiki's code to chunk the regex.
-  * Instead of the link opening up the page, open a pop-up containing the abstract. From there, the user can click to the page.
+===== Discussion =====
+**[APPLAUSE]** This implementation for auto-linking is handy to use. I may not be a heavy user since I haven't come up so many strings to be auto-linked to relative pages, but this plugin indeed suits my need in a most elegant way. --- [[user>MilchFlasche|milchflasche]] //2020-10-26 02:56//
+howto: eg. #number, http://www.example.com/number   - rick.