====== structautolink Plugin ======

---- plugin ----
description: Automatic page linking based on struct data
author     : Andreas Gohr 
email      : gohr@cosmocode.de
type       : renderer
lastupdate : 2023-02-15
compatible : Igor
depends    : struct
conflicts  : 
similar    : autolink2, autolink3, autolink4
tags       : links, glossary

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-structautolink/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-structautolink/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-structautolink/
donationurl: 

screenshot_img : 
----

This plugin works similar to the other autolinking plugins in that it will add links to other pages automatically. However this is a [[struct]] plugin and uses it to configure the terms that should be linked to a page.


===== Installation =====

:!: This plugin requires the [[struct]] plugin to work. You should be familiar with struct before using this plugin.

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.

===== Configuration and Usage =====

The plugin needs to be configured with a ''schema'' and ''field'' in that schema. The field should be a text field and support multiple entries.

Once configured, every page that has the configured schema assigned will automatically be linked when one of the keywords in the configured field is found in the text of a page.

Note: only the first occurrence of one of the page keywords will be linked.

You can optionally restrict the autolinking by configuring an appropriate Regular Expression in the ''match'' config.