====== Cumulus plugin ====== ---- pluginnews ---- headline: Plugins by same author style: sameauthor ---- ---- plugin ---- description: Plugin for displaying Flash movie navigation clouds author : Håkan Sandell email : sandell.hakan@gmail.com type : Syntax lastupdate : 2010-07-14 compatible : 2009-02-14,Lemming,anteater,rincewind depends : conflicts : similar : cloud tags : listing, navigation, search, tags downloadurl: http://github.com/HåkanS/dokuwiki-plugin-cumulus/zipball/master bugtracker : http://github.com/HåkanS/dokuwiki-plugin-cumulus/issues sourcerepo : http://github.com/HåkanS/dokuwiki-plugin-cumulus/ ---- This plugin enables you to use a Flash movie to display a nice rotating 3D word/tag cloud, for example [[http://www.roytanck.com/2008/03/15/wp-cumulus-released/|Roy Tanck's]] movie. A special feature is the ability to display all root namespaces of your Wiki installation. ===== Download and Installation ===== Step 1. Download and install the plugin using the [[plugin:plugin|Plugin Manager]] using the URL given above. Refer to [[:Plugins]] on how to install plugins manually. Step 2. Find latest version of, for example [[http://www.roytanck.com/2008/03/15/wp-cumulus-released/|Roy Tanck's]] Flash movie, a file called "tagcloud.swf" and put it in the plugin folder. ..dokuwiki/lib/plugins/cumulus/ ^ :!: | The Flash movie is NOT included in the download ^ :!: ^ This inconvenience because the Roy's Flash movie is released under GPL v3 and I'm a little bit hesitant to include it in the download. This plugin just plays any file called "tagcloud.swf" in the plugin folder ;-). ===== Syntax ===== ~~CUMULUS[&flag=value]~~ * **flag** can be one or several (separated by & ) of: * //max// --- Maximum number of words displayed * //width// --- Width in pixels (500 or more is recommended) * //height// --- Height in pixels (ideally around 3/4 of the width) * //tcolor// --- Color of the tags (6 char HEX color value without the ‘#’ prefix) * //tcolor2// --- Optional second color for gradient between small and large font links (6 char HEX color value without the ‘#’ prefix) * //hicolor// --- Optional highlight color (6 char HEX color value without the ‘#’ prefix) * //bgcolor// --- Background color (6 char HEX color value without the ‘#’ prefix) * //trans// --- Background transparency (true|false) * //distr// --- Distribute tags evenly on sphere (true|false) * //speed// --- Rotation speed (percentage, default is 100) * //show// --- By default a word cloud is displayed. By using ''show=tag'' the plugin shows tags from the [[plugin:tag]] plugin instead. The alternative ''show=namespace'' displays all namespaces in the wiki root. **Example:** ~~CUMULUS&max=20&bgcolor=000000&distr=true&show=tags~~ {{http://cloud.github.com/downloads/HakanS/dokuwiki-plugin-cumulus/cumulus.png}} ===== Configuration ===== All properties described above can also be set in the [[plugin:config|configuration manager]]. **showtags** --- The plugin always includes all tags as standard HTML links in a hidden
for SEO purposes but this setting decides if it should be visible as a "standard" tag cloud if the users browser doesn't support Flash 9 movies. The cloud will have same CSS class as the [[plugin:cloud]]. ===== Development ===== The code itself is pretty straight forward. It's an example how to use DokuWiki core function [[xref>html_flashobject()]] to play a Flash movie. === Change Log === {{rss>http://github.com/feeds/HåkanS/commits/dokuwiki-plugin-cumulus/master 6 date}} === Internationalization === English is included. If you make a translation to another language I'm happy to include it, use Git, mail me or paste it on this page. ===== Credits ===== Thank you for inspiration Roy Tanck. Gina Häußge, Michael Klier and Esther Brunner has also contributed by making the [[plugin:Cloud]] plugin. ===== Troubleshooting ===== 1. There is a built-in check for the presence of the flash movie, if it's not in the correct location a message "The file **tagcloud.swf** is not found" will appear. This means it has wrong name or doesn't exist in the ''..lib/plugin/cumulus/'' directory. 2. If your browser can't load the Adobe flash player application there will be a message "Download Flash Player 9 or better for full experience". This can be caused by no or to old flash player, incompatible browser (Firefox 3.6 works) or other reasons. 3. If the plugin just creates a black box, the flash movie has started but was supplied with faulty parameters. Try displaying the basic word cloud with ~~CUMULUS~~ If you still have problems, please supply information about DokuWiki version/Browser type&version/Flash version etc. ===== Discussion ===== Hi, I installed the plugin manually and it is working good. I just wonder if there is a way to include subnamespaces in the cloud (for example - ns1:ns2). The syntax I'm using is as follows and it lists only the namespaces in the root (and I have several subnamespaces) ''~~CUMULUS&max=30&tcolor=000000&tcolor2=666666&hicolor=3333CC&distr=true&show=namespace~~'' Thanks, > I'll put it on the list for a rainy day --- [[user>HåkanS]] //2011/01/04 22:06// > ---- I've rewritten a number of comments from people experiencing trouble into a trouble shooting guide, but feel free to add more. ;-) --- [[user>HåkanS]] //2011/01/04 22:06// ---- Hi, while tags are correctly produced with diacritical signs (like à, é, ê...) there are not well handled by the cumulus plugin. For example, if I have a tage //actualité// then the link produced by cliking on the cumulus is ''tag:actualite?do=showtag&tag=actualite'' which is wrong since the correct tag is ''tag:actualite?do=showtag&tag=**actualité**''. Some kind of wiki-isation of the tagname should not be made... Thank you for your time and your very nice plugin! --- [[user>OlivierMichel|OlivierMichel]] //2011/03/09 15:22// ---- Hi,@OlivierMichel, I had the same problem with a tag like "base_de_données". I made 2 modifications on the syntax.php file : * the first one around line number 148 : $link = wl($id, array('do'=>'showtag', 'tag'=>noNS($word)), true); // $link = wl($id, array('do'=>'showtag', 'tag'=>noNS($id)), true); * the second one around line number 173 : $xmlCloude .= '' . str_replace('_',' ',$name) . '' . DOKU_LF; // $xmlCloude .= '' . $name . '' . DOKU_LF; [[user>Mathieu Bossaert|MathieuBossaert]] //2011/08/11 13:17//