Differences

This shows you the differences between two versions of the page.

--- plugin:cite [2009-10-07 14:05] – tag cleanup laynee
+++ plugin:cite [2020-09-22 23:01] (current) – [About] tjgrant@tatewake.com
@@ Line 6: / Line 6: @@
 email      : tjgrant@tatewake.com
 type       : action
-lastupdate : 2009-05-28
+lastupdate : 2020-09-22
-compatible : (current version)
+compatible : 2020-07-29 "Hogfather", 2018-04-22 "Greebo", 2017-02-19 "Frusterick Manners", 2016-06-26 "Elenor Of Tsort"
 depends    :
 conflicts  :
 similar    : bibtex, harvcite
 tags       : quotes, references, bibtex, latex
+downloadurl: https://github.com/tatewake/dokuwiki-plugin-cite/archive/master.zip
+sourcerepo : https://github.com/tatewake/dokuwiki-plugin-cite
+bugtracker : https://github.com/tatewake/dokuwiki-plugin-cite/issues
+donationurl: https://www.paypal.com/xclick/business=tjgrant%40tatewake.com&item_name=Citations%20for%20DokuWiki%20Donation&no_shipping=1&no_note=1&tax=0&currency_code=USD&lc=US
 ----
+===== License =====
+  * **Author:** [[tjgrant@tatewake.com|Terence J. Grant]]
+  * **License:** [[http://www.opensource.org/licenses/gpl-license.php|GNU GPL v2]]
+  * **Donate:** [[https://www.paypal.com/xclick/business=tjgrant%40tatewake.com&item_name=Citations%20for%20DokuWiki%20Donation&no_shipping=1&no_note=1&tax=0&currency_code=USD&lc=US|Click here.]]
+It's not required, but please consider linking to [[cite|this 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; trust me, they're worth reading.
+  * This is the **latest version**, compatible with **The Latest DokuWiki**:
+    * Latest Version: {{http://cloud.github.com/downloads/tatewake/dokuwiki-plugin-cite/cite-stable.tar.gz}}
+    * Github URL:  [[https://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!**
+===== Installation =====
+Use the plugin manager to install, or...
+  - [[#download]] the tarball/zip-file
+  - unpack it into ''<dokuwiki>/lib/plugins/''
+  - login as admin and change the plugin in the configuration manager
+**using git:**\\
+<code>
+% cd <dokuwiki>/lib/plugins/
+% git clone git://github.com/tatewake/dokuwiki-plugin-cite.git cite
+</code>
+**Debian install (or probably any other distribution):**
+<code>
+# 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/
+</code>
+**Note: http://cloud.github.com/downloads/tatewake/dokuwiki-plugin-cite/cite-stable.tar.gz always points to the latest stable version!**
+===== 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.
+<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:
+<code php><?php if (file_exists(DOKU_PLUGIN.'cite/code.php')) include_once(DOKU_PLUGIN.'cite/code.php'); ?></code>
+To display a permanent link or citation link at any point in your document, use the following code as an example:
+<code php><?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 } ?></code>
+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.)
+===== Upgrading =====
+To upgrade, remove the original lib/plugins/cite folder, and install the new version as instructed above.
-[[http://tatewake.com/wiki/projects:citations_for_dokuwiki|Details and Download]]
 ===== Discussion =====
-Please use the [[http://tatewake.com/wiki/talk:projects:citations_for_dokuwiki|discussion page]] for this plugin.
+**Start all subtopics with H2.**
+===== Author and Publisher =====
+It would be great to have options on the author and Publisher settings. We just can set it globally. It would be useful to retrieve the page author automatically (Dokuwiki @NAME@) and also to have a way to set a Publisher name by namespace.
+The [[plugin:meta|meta plugin]] could be of great use to this if we can retrieve meta value to set author and publisher on a page basis.
+ --- [[user>typometre|typometre]] //2019-04-01 02:10//