IkiWiki::Plugin::wikiurl

Plugin for outputting the path of IkiWiki [[WikiLinks]] as pure text.

Synopsis

Directive                    Example output
---------------------------  ---------------------------------------------
[[!wikiurl RecentChanges]]   ../recentchanges/
[[!wikiurl some_page]]       ../some_page/
[[!wikiurl url="Some page"]] ../some_page/
[[!wikiurl nothere]]         /ikiwiki.cgi?do=create&from=here&page=nothere

Note that the output is sensitive to the location of the page where the
directive is placed. In most cases, paths are relative. This may, however,
depend on the IkiWiki configuration and other factors.

Installation

1. Copy wikiurl.pm to your local IkiWiki plugin directory - normally
   ~/.ikwiki/IkiWiki/Plugin/.
2. Add it to the add_plugins setting of the *.setup file for your wiki.

Motivation

This plugin can for instance be used in conjunction with markup processors such
as ikiwiki-pandoc, where
accessing IkiWiki’s path resolution is essential for using internal
reference-style links effectively.

Backlinks

When you link normally between pages with [[WikiLinks]], IkiWiki places a
“Links” section at the bottom of the pages you link to, with links to the
pages you linked from. These are called backlinks.

Normally [[!wikiurl]] directives do not generate backlinks from the
referenced pages, since we’re not actually linking but simply outputting a
path. This behaviour can be changed with the backlink parameter, e.g.
[[!wikiurl "Some page" backlink=1]]

Note that any value provided to the backlink parameter will be interpreted as
true, except for the four special arguments 0, off, no and false. Thus
[[!wikiurl "Some page" backlink="off"]] will not create a backlink, but
[[!wikiurl "Some page" backlink="nonsense"]] will.

License

This software is copyright © 2016 by Baldur Kristinsson.

This is free software with a dual Artistic/GPL license. The terms for using,
copying, distributing and modifying it are the same as for Perl 5.