DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:uparrow

Uparrow Plugin

Compatible with DokuWiki

> 2009-02-14, 2008-05-05

plugin This simple plugin shows an arrow-image which links to the top of the current page

Last updated on
2009-02-21
Provides
Syntax, Action
Repository
Source

Tagged with links, navigation, section

Installation

Download the tarball and unpack it into <dokuwiki>lib/plugins. The folder will contain:

  • .tgz Plugin Manager

You can install the plugin via git.

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

Configuration

You can choose which image to use by putting it into <dokuwiki>lib/plugins/uparrow/images and changing the image name in the configuration manager. The plugin comes with 3 default images. You can also configure the plugin to automatically add an up link after each section (NOTE: this could take a while on really large pages, but it only happens when the instructions of a page are regenerated and cached again, normally after an edit occurs or you use &purge. If you activate this option you should invalidate the cache of the wiki to make the changes apply!).

image name
tango-big.png
tango-medium.png
tango-small.png

Syntax

~~UP~~

Demo

You can see the plugin in action here.FIXME

Changelog

A complete changelog is available here

Discussion

Kauê Silveira: for compatibility with s5 plugin:

    function render($mode, &$renderer, $data) {
        global $lang;
 
       	if(preg_match("/do=export_s5/", $_SERVER["REQUEST_URI"])) return false;
 
        if($mode == 'xhtml'){

If you don't want uparrow to be print, just create a print.css file in yourdokuwiki/lib/plugins/uparrow with these lines :

div.dokuwiki div.plugin_uparrow {
  display: none;
}

Thanks for this useful plugin. I have enabled uparrow globally via the configuration manager, but would like to disable it on certain page sections - here is what I mean (as at 30 July 2010). Say you have quite short sections near the top of a page - the uparrow is pointless in that case. Is there a way to do that? — Darryl Penny 2010/07/30 11:56


If plugin»uparrow»auto is enabled, is there any way to exclude it from certain pages? Say if I have a sidebar? Thank you!


kate : To fix incompatibility with farm plugin (uparrow picture is not correctly diplayed due to a path problem) : replace DOKU_URL variable with DOKU_BASE in action.php : replace

$image = $this->getConf('image');
        if(!@file_exists(DOKU_PLUGIN.'uparrow/images/' . $image)) {
            $image = DOKU_URL.'lib/plugins/uparrow/images/tango-big.png';
        } else {
            $image = DOKU_URL.'lib/plugins/uparrow/images/' . $image;
        }

with

$image = $this->getConf('image');
        if(!@file_exists(DOKU_PLUGIN.'uparrow/images/' . $image)) {
            $image = DOKU_BASE.'lib/plugins/uparrow/images/tango-big.png';
        } else {
            $image = DOKU_BASE.'lib/plugins/uparrow/images/' . $image;
        }
plugin/uparrow.txt · Last modified: 2013/08/29 16:56 by Aleksandr