====== tuxquote Plugin ======

---- plugin ----
description: Show a random image of Tux the Linux penguin with a random quote.
author     : Craig Douglas
email      : contact22@eldougo.net
type       : syntax
lastupdate : 2014-09-18
compatible : Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons
depends    : 
conflicts  : 
similar    : fortune, xfortune
tags       : tux, quotes, random, motd

downloadurl: https://github.com/eldougo/dokuwiki_plugin_tuxquote/archive/master.zip
bugtracker : https://github.com/eldougo/dokuwiki_plugin_tuxquote/issues
sourcerepo : https://github.com/eldougo/dokuwiki_plugin_tuxquote
donationurl:

screenshot_img : 
----

===== Installation =====

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

===== Examples/Usage =====

The following screenshots are static samples only.

{{http://www.missionrisk.com/TuxImage1.jpg |Tuxquote in action}} 
{{http://www.missionrisk.com/TuxImage2.jpg |Tuxquote in action}}

===== Syntax =====

After installation, insert the following code
<code>
[TUXQUOTE]
</code>

If you would like it to appear in the top right corner of the page, use the following code to hide the TOC and turn off caching to show a different image and quote every time the page is refreshed
<code>
~~NOCACHE~~
~~NOTOC~~
[TUXQUOTE]
</code>

===== Configuration and Settings =====

The following attributes can be changed from the Configuration Manager:

Title: Add title text above the Tuxquote image. \\
Width: Width in percentage or pixels of the page. Eg: 80% or 200px. \\
Align: Can be "left", "right" or "none".

You can add or remove images from <wiki>/lib/plugins/tuxquote/pics/ directory. All jpg, png and gif images will be randomly used from that directory.

Add or remove quotes from the <wiki>/lib/plugins/tuxquote/quotes.txt file. Quotes are line delimited and HTML formatting can be used, enabling you to use <BR /> for line breaks etc.

=== Change Log ===
  * **2014-09-18**
    * Added Title, Width and Alignment options controlled via the Configuration Manager.

  * **2014-09-15**
    * Replaced some deprecated HTML styling tags.

  * **2014-03-29**
    * Fixed issue #1: a bug in generating the image URL on some server/PHP version combinations. Thanks to [[https://github.com/Dual-Boot|Dual-Boot]] for pointing that out.

  * **2014-03-03**
    * Replaced the Tux images with images sourced from CrystalXP.net (http://www.crystalxp.net/) which are under the Creative Commons BY-NC-SA license
    * Added file images-readme.txt containing the Creative Commons BY-NC-SA license that applies to the images distributed with this plugin and added image attributions as required

  * **2014-02-22**
    * Initial release

=== Known Bugs and Issues ===

Report any issues on the [[https://github.com/eldougo/dokuwiki_plugin_tuxquote/issues|Issue Tracker]].