# Citations for DokuWiki

## License

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

## Download

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.

## About

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.

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

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.)

## Install

As a plugin all you need to do is unpack the file into the lib/plugins/ directory (you should end up with a lib/plugins/cite folder.)

Make sure to follow the instructions under About for citation links to actually appear.

## Upgrading

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

## What's New

May 28, 2009

• Initial release