DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== AutoLink 4 Plugin ======

---- plugin ----
description: Automatically link text in your wiki to pages.
author     : Eli Fenton 
email      : elifenton@this_is_not_a_real_email.fake 
type       : syntax
lastupdate : 2019-09-02
compatible : greebo
depends    : 
conflicts  : 
similar    : autolink2, autolink3
tags       : links

downloadurl: http://github.com/zioth/dokuwiki-autolink4/zipball/master
bugtracker : http://github.com/zioth/dokuwiki-autolink4/issues
sourcerepo : http://github.com/zioth/dokuwiki-autolink4/
donationurl:

screenshot_img : 
----

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 makes it easy to undo changes.
  * It works with [[autotooltip]] to add tooltips to its links.

More information: [[plugin:autolink4:differences|Choosing an autolink plugin]].

===== Installation =====

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 =====

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.
  * 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.

== Simple example ==
  Things, mywiki:thing
This links the word "Things" to mywiki:thing, everywhere on your wiki. It only links it when capitalized.

== 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.

== Tooltip, and link first match ==
  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.

== 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:

===== 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 algorithmic 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.

=== Change Log ===

{{rss>https://github.com/zioth/dokuwiki-autolink4/commits/master.atom date}}

=== ToDo/Wish List ===

* 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.

===== Discussion =====

Please fill all the letters into the box to prove you're human. S᠎ R K S R Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International