====== Backlinks Plugin ======

---- plugin ----
description: Lists all pages that link back to a given page using the first headline as link title
author     : Mark C. Prins
email      : mprins@users.sf.net
type       : syntax
lastupdate : 2023-06-27
compatible : Hogfather, Igor, Jack Jackrum
depends    : 
conflicts  : backlinks-old
similar    : 
tags       : listing, links, meta, include, backlinks
downloadurl: https://github.com/mprins/dokuwiki-plugin-backlinks/archive/master.zip
bugtracker : https://github.com/mprins/dokuwiki-plugin-backlinks/issues
sourcerepo : https://github.com/mprins/dokuwiki-plugin-backlinks
donationurl: https://github.com/sponsors/mprins

----
===== Installation =====
Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

**Note** if you came here looking for the old, unmaintained and unspported plugin it is now available at [[plugin:backlinks-old|Backlinks-old Plugin]]

===== Configuration =====
The plugin uses the built-in [[doku>dokuwiki|DokuWiki]] functions to generate the backlinks list. You can use the config-variable [[config:hidepages|hidepages]] config option to suppress pages from being listed.

The plugin uses the wiki index, if you have to use nocache your index is out of date.
===== Syntax =====
The syntax is as follows:

<code>
{{backlinks>wiki:page}}
</code>

You can list the backlinks to the current page by using:

<code>
{{backlinks>.}}
</code>

You can include pages from and below a certain namespace only using:

<code>
{{backlinks>.#include}}
</code>

Where ''include'' is an absolute namespace.
You can exclude pages from and below a certain namespace only using:

<code>
{{backlinks>.#!exclude}}
</code>

===== FAQ =====
  * **Why are my pages not showing up?** Probably your wiki index is out of date, refresh the index.
  * **Are the links sortable ? (ie: alphabetically) ** No.
===== Demo =====
See https://wild-water.nl/dokuwiki/beschrijvingen/regio/jura for an example



===== Changelog =====

The [[https://github.com/mprins/dokuwiki-plugin-backlinks/commits/master|complete changelog is available]] on GitHub

{{rss>https://github.com/mprins/dokuwiki-plugin-backlinks/commits/master.atom date}}