• Author: Terence J. Grant
• License: GNU GPL v2
• Last Update: 2009-05-28
• Donate: Click here.

It's not required, but please consider linking to this page or the main page from your site if you like this product.

Before downloading or using this product, make sure you understand and accept the terms of the license.

After downloading, make sure to follow the install instructions or upgrading instructions below; trust me, they're worth reading.

• This is the latest version, compatible with The Latest DokuWiki:
  • Latest Version: cite-stable.tar.gz - July 30, 2008
  • Github URL: http://github.com/tatewake/dokuwiki-plugin-cite |

• Older downloads are available on request only.

Note: http://cloud.github.com/downloads/tatewake/dokuwiki-plugin-cite/cite-stable.tar.gz always points to the latest stable version!

Use the plugin manager to install, or…

1. download the tarball/zip-file
2. unpack it into <dokuwiki>/lib/plugins/
3. login as admin and change the plugin in the configuration manager

using git:

% cd <dokuwiki>/lib/plugins/
% git clone git://github.com/tatewake/dokuwiki-plugin-cite.git cite

Debian install (or probably any other distribution):

# cd /usr/share/dokuwiki/lib/plugins/
# wget http://cloud.github.com/downloads/tatewake/dokuwiki-plugin-cite/cite-stable.tar.gz
# tar -xvzf cite-stable.tar.gz
# chown -Rv 33 cite/

Note: http://cloud.github.com/downloads/tatewake/dokuwiki-plugin-cite/cite-stable.tar.gz always points to the latest stable version!

This plugin gives you the ability to let users cite your work. This is required quite often in academia and journalism.

The way this is done is by appending “&do=cite” to a wiki page's URL in addition to an optional revision number, for example “rev=123456789”.

The plugin also exports two functions for use with your template, with URLs for a permanent link (cite_getPermURL) to a page revision and a citation link(cite_getCiteURL) so that you can let others easily cite your work.

<note warning>If you do not add the following code to your template's main.php, no citation links will appear!</note>

In main.php, add the following at the top of the file:

<?php if (file_exists(DOKU_PLUGIN.'cite/code.php')) include_once(DOKU_PLUGIN.'cite/code.php'); ?>

To display a permanent link or citation link at any point in your document, use the following code as an example:

<?php if (function_exists('cite_getPermURL')) { ?><a href="<?php echo cite_getPermURL(); ?>" rel="nofollow">Permanent Link</a><?php } ?>
<?php if (function_exists('cite_getCiteURL')) { ?><a href="<?php echo cite_getCiteURL(); ?>" rel="nofollow">Cite this Page</a><?php } ?>

My advice is to keep the rel="nofollow" intact as this ensures search engines don't index citations.

Set the options for this plugin via the Configuration Settings menu from the DokuWiki admin menu. (It will be near the bottom of the page.)

To upgrade, remove the original lib/plugins/cite folder, and install the new version as instructed above.

• Initial release

List your site here if you wish!

Start all subtopics with H2.