Wallpaper Template for Dokuwiki

This template offers a semi transparent body over a background image. Its main feature is a static dropdown menu. The Menu supports up to three menu levels (that means three levels of namespaces).

The name was inspired by photo wallpapers popular in the seventies

License

This template is published under the GNU General Public Licence (GPL) V2.

Special Thanks

This template uses code from the default template and from Michael Klier’s Arctic template.

The CSS-code used in the dropdown menu was inspired by http://www.lwis.net/free-css-drop-down-menu/

The resizable fake background image was inspired by Chris Coyier (http://css-tricks.com/how-to-resizeable-background-image/)

Installation

Unpack the file in the /lib/tpl directory of your Dokuwiki installation. It will create a directory named wallpaper there.

In the configuration plugin chose wallpaper as your template:

Base Configuration

Configuration

The basic configuration is done via style.ini. In addition to general dokuwiki style options there are two template specific options (under normal circumstances you will not have to change these):

;wallpaper special variables
;---------------------------------------------------------------------------
; width of menu items
__menuwidth__= "15em"
; text color inactive buttons
__color_disabled__="#ccc"

Here you can set the width of the submenus __menuwidth__ (CSS width units apply). The text color of inactive buttons __color_disabled__ should only be changed if your reconfigure the whole color scheme.

Further configuration can be done via the configuration dialog in the admin functions:

Configuration options

  • clean index: this option will remove the standard dokuwiki namespaces (‚wiki‘ and ‚playground‘) from the menu (default: off).
  • clean index of further namespaces comma separated list of namespaces to be removed from the index if “clean index” is switched on (default: empty).
  • show backlink button: will show a backlink button in the bottom bar (default: off).
  • show search box if logged in: will show a search box, if you are logged in (default: off).
  • create a submenu for pages in the root namespace: this option will put all pages in the top level namespace into a sub menu instead of listing each in the topmost menu level (default: off).
  • the menu is based on a user-supplied file: this option will switch off the automatically generated menu and look for a menu file (the name can be configured in the next option) for the menu. For syntax of this file see below. (default: off).
  • menu file name: configure the file name for the menu file (without .txt extension) (default: menu).

Menu file syntax

Prepare a wiki file with a structure of unordered list of links. This structure may be three levels deep. These links will be used to construct the menu. The file must be saved in the root namepsace of your wiki.

Example:

=====My menu=====
  * [[first level item]]
  * [[first level item]]
    * [[second level item]]
    * [[second level item]]
      * [[third level item]]
  * [[first level item]]

Non-list lines (like the heading in the example) will be ignored. List lines without wikilinks will be ignored too. Links that do not point to existing files will be eliminated from the menu.

If a linked page is a start page of a namespace it will be always be shown in the menu as if this page has sub-entries in the menu even if that is not the case.

Suggested Dokuwiki Configuration

This template works best with “Hierarchical breadcrumbs” switched on and the corresponding “Number of breadcrumbs” set to “0”.

Suggested Configuration 1

Switching “Use first heading for pagenames” to “Always” or “Navigation” results in a nicer menu.

Suggested Configuration 2

Background Image

The background image can be changed if you drop a JPG-image named bg.jpg into the ‚images‘ directory inside the template directory.

The background image should be at least as wide as the biggest possible window width. The image should have a color gradient fading into black in the bottom.

To keep the size of the template small I have included only one example background image. Here you can download a few more example pictures:

Sunset Fishes Lotos flower Sunset at the sea

Browser compatibility

This template works well with current Firefox and Google-Chrome. I have not tested other browsers yet. As this template uses PNG transparency it should look awful in Internet Explorer 6.

Dokuwiki compatibility

Version 0.6 of this template was made for DokuWiki Release 2012-10-13 (Adora Belle).

Version 0.7 of this template was made for DokuWiki Release 2013-05-10 (Weatherwax).

Version 0.8 of this template was made for DokuWiki Release 2013-12-08 (Binky).

Version History

0.1
- initial release

0.2
- switched to a resizing pseudo background image

0.3
- compatibility release for Dokuwiki rc2010-10-07

0.3.1
- compatibility release for Dokuwiki 2010-11-07

0.3.2
- Fix for black on black footnote pop-ups

0.4
- compatibility release for Dokuwiki rc2011-04-22

0.4.1
- corrected font size for code segments

0.4.2
- adds the possibility to configure the contents of the menu
- redesign of the print layout

0.5
- compatibility release for Dokuwiki rc2011-11-10
- small CSS changes

0.5.1
- bugfix for menu file mode: wikilinks are now interpreted correctly including link title
- media manager button can be switched off

0.5.2
- compatibility release for Dokuwiki 2012-01-25

0.5.3
- Menu CSS fix suggested by Gleb Kozyrev (gleb [at] gkoz dot com)

0.5.4
- configurable namespaces may be excluded from the index

0.6
- compatibility release for Dokuwiki rc2012-09-10 and 2012-10-13 (Adora Belle)

0.7
- compatibility release for Dokuwiki rc2013-03-06 and 2013-05-10 (Weatherwax)

0.7.1
- fix for dw2pdf button

0.7.2
- CSS syntax fix

0.8
- compatibility release for Dokuwiki rc2013-11-18 and 2013-12-08 (Binky)

Download

wallpaper-0.6.0.tar.gz 159,656 Bytes (for Dokuwiki release 2012-10-13)

wallpaper-0.7.2.tar.gz 161,585 Bytes (for Dokuwiki release 2013-05-10)

wallpaper-0.8.tar.gz 161,517 Bytes (for Dokuwiki release 2013-12-08)

The source code is also available from a GitHub repository https://github.com/kvormweg/wallpaper

Experimental Version with Multi-Language Support

Due to demand I have made an experimental version of this template with multi-language support available. Please try wallpaper-0.7.2a.tar.gz (162,918 Bytes). I do not have any multi-language wikis myself, so the testing must be done by the commnunity. This version is made for Dokuwiki release 2013-05-10, but should also work with 2012-10-13.

Example

Please see my 'courses' wiki (in German). Use the template switcher provided by the excellent “loadskin” plugin at the top of the page.

Contact

Last change: 2014-04-09 09:40pm