README
1Wallpaper Template for DokuWiki
2
3All documentation for the Template is available online at:
4http://www.tuhh.de/~psvkv/wallpaper/index.html
5
6(c) 2010-2015 by Klaus Vormweg <klaus.vormweg@gmx.de>
7
8This program is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 2 of the License, or
11(at your option) any later version.
12
13This program is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program; if not, write to the Free Software
20Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
22See COPYING for license info.
23
README.md
1# Wallpaper Template
2## General Description
3
4This 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).
5
6The name was inspired by photo wallpapers popular in the seventies
7
8## License
9
10This template is published under the GNU General Public Licence (GPL) V2.
11
12## Special Thanks
13
14This template uses code from the default template and from Michael Klier’s Arctic template.
15
16The CSS-code used in the dropdown menu was inspired by http://www.lwis.net/free-css-drop-down-menu/
17
18The resizable fake background image was inspired by Chris Coyier (http://css-tricks.com/how-to-resizeable-background-image/)
19
20Menu animation inspired by Brian Huisman (http://www.greywyvern.com/?post=337)
21
22Hamburger menu without javascript inspired by Austin Wulf (http://www.sitepoint.com/pure-css-off-screen-navigation-menu/)
23
24## Installation
25
26Unpack the file into the `/lib/tpl` directory of your Dokuwiki installation. It will create a directory named `wallpaper`. You can also use the bundled plugin installer.
27
28In the configuration plugin chose `wallpaper` as your template.
29
30## Configuration
31
32The 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):
33````
34;wallpaper special variables
35;---------------------------------------------------------------------------
36; width of menu items
37__menuwidth__= "15em"
38; text color inactive buttons
39__color_disabled__="#ccc"
40````
41Here 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.
42
43Further configuration can be done via the configuration dialog in the admin functions:
44
45## Configuration options
46
47* clean index: this option will remove the standard dokuwiki namespaces (‚wiki‘ and ‚playground‘) from the menu (default: off).
48* clean index of further namespaces comma separated list of namespaces to be removed from the index if “clean index” is switched on (default: empty).
49* show backlink button: will show a backlink button in the bottom bar (default: off).
50* show search box if logged in: will show a search box, if you are logged in (default: off).
51* 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).
52* submenu entry for the root namespace: menu entry text for the top level namepsace (default: "Start").
53* 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).
54* menu file name: configure the file name for the menu file (without .txt extension) (default: menu).
55
56## Menu file syntax
57
58Prepare 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.
59
60Example:
61````
62=====My menu=====
63 * [[first level item]]
64 * [[first level item]]
65 * [[second level item]]
66 * [[second level item]]
67 * [[third level item]]
68 * [[first level item]]
69````
70Non-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.
71
72If 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.
73
74## Suggested Dokuwiki Configuration
75
76This template works best with “Hierarchical breadcrumbs” switched on and the corresponding “Number of breadcrumbs” set to “0”.
77
78Switching “Use first heading for pagenames” to “Always” or “Navigation” results in a nicer menu.
79
80## Background Image
81
82The background image can be changed if you drop a JPG-image named `bg.jpg` into the `images` directory inside the template directory.
83
84The 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.
85
86The background for namespaces and/or individual pages may be changed by uploading JPG images. Picture files have to be named `(page name)_bg.jpg` or `(namespace name)_bg.jpg`. Replace `(page name)` or `(namespace name)` by the page name or namespace name the way it is converted by Dokuwiki (see the page URL). If you use namespaces background pictures must be uploaded into the corresponding folder for the namespace.
87
88## Browser compatibility
89
90This template should work well with all recent browsers that support HTML5 and CSS3.
91
