DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:autolink4:differences

Choosing an Auto-Link plugin

Disclaimer: I am the author of autolink4, so I'm biased towards that one. Feel free to correct any inaccuracies, or add additional information.

What is auto-linking

DokuWiki already automatically links camel-cased words. It will find a page with the same name, and turn your text into a link. The Autolink plugins take that a step further, allowing you to add links to specific pieces of text. For example, you could make it so that the word “Things” will link to mywiki:things, no matter where it's found on your wiki.

What do the names mean?

You might think there are four versions of the autolink plugin. That is not the case. They're just created by different authors, who couldn't think of a better name. A higher number does not mean the plugin is inherently superior.

The first autolink is a script which searches your wiki, and replaces text strings with links.

Features
  • Difficult to use: You have to run the script manually or with a cron job.
  • Extremely high performance: Since there's no plugin involved, there's no impact on page rendering time.
  • Permanent: There's no way to undo it. The data files are permanently changed.

autolink2

Autolink 2 uses per-page set-up to make linking extremely precise, if a bit tedious.

Features
  • Explicit: Each page you want to link to requires individual autolink set-up on that page. Each page that replaces links requires set-up too. This is a lot of work, but has the advantage that you can decide exactly which pages should auto-link, or even link parts of pages.
  • Not error-prone: Other autolink plugins have a risk of linking text you didn't mean to link – for example, text inside of other plugins. Since autolink2 makes you choose exactly what text has replacements, that risk is gone.
  • Moderate performance: Data has to be gathered from many pages to do linking.
  • Temporary: Because pages are not modified, you can undo linking just by removing the plugin markup from your pages.

autolink3

Autolink 3, like Autolink, permanently replaces strings, but it does it with admin configuration, instead of a script.

Features
  • Easy to use: The admin interface makes it easy to add new links, though if you want to add a lot of links at once, you're better off modifying the config file directly.
  • High performance: Some extra work is done when saving pages, but there's no impact on rendering performance, since links are added permanently.
  • Namespace scoping: Replacements can be limited to a given namespace.
  • Permanent: There's no way to undo it. The data files are permanently changed.

autolink4

Autolink 4 replaces strings dynamically, so there's no permanent change to your pages.

Features
  • Easy to use: The admin interface makes it easy to add new links, though you have to be careful to type everything correctly, since it's just a plain text field. It uses CSV, so you can import data from a spreadsheet.
  • Flexible: Regular expression characters are supported, so a variety of text can be easily linked. For example, you can link a singular and plural word with the same entry.
  • Moderate performance: Because pages are modified dynamically, it takes longer to render a page than without this plugin. Up to 500 links have been tested with no performance degradation.
  • Namespace scoping: Replacements can be limited to a given namespace.
  • Temporary: Because pages are not modified, you can undo linking just by removing links from the admin interface.
  • Tooltip support: Using the Auto-Tooltip plugin, you can display tooltips including the title and abstract of the linked page.
plugin/autolink4/differences.txt · Last modified: 2018-12-20 05:43 by zioth