Translations of this page?:

DokuBook Template

Author:
Michael Klier
Description:
Takes the MediaWiki look as starting point but doesn't try to copy the look and feel of MediaWiki
LastUpdate:
2010-01-04
Compatible:
2009-12-25 (packages for older releases available)
Template:
mediawiki
Screenshot:
screenshot: 2007-10-20-dokubook-01.jpg

Support the ongoing development of DokuWiki Plugins and Templates and buy me a coffee ;-) (Suggested: 3€ for a regular or 5€ for big latte with caramel).

The Idea

The goal of this template is not to completely copy the look and feel of MediaWiki. If you're looking for a MediaWiki style DokuWiki template, have a look at the Monobook template. It provides some extra functionality not found in this one. This template merely uses the MediaWiki look as a starting point and doesn't include/add extra functionality like discussion and so forth.

Features

  • custom navigation per namespace build from a normal wikipage
  • custom footer per namespace build from a normal wikipage

Screenshots

Some screenshots can be found here.

Download

DokuWiki version download
2009-12-25 template-dokubook.tgz (:!: current stable version :!:)
2009-02-14 template-dokubook-2009-02-08.tgz
2008-05-05 template-dokubook-2008-10-15.tgz
Github URL http://github.com/chimeric/dokuwiki-template-dokubook

Installation

  1. download the tarball/zip-file
  2. unpack it into <dokuwiki>/lib/tpl/
  3. login as admin and change the template in the configuration manager

using git:

% cd <dokuwiki>/lib/tpl/
% git clone git://github.com/chimeric/dokuwiki-template-dokubook.git dokubook

Debian install (or probably any other distribution):

# cd /usr/share/dokuwiki/lib/tpl/
# wget http://www.chimeric.de/_src/template-dokubook.tgz
# tar -xvzf template-dokubook.tgz
# chown -Rv 33 dokubook/

For openSUSE change owner and group als follows:

# chown -Rv wwwrun dokubook/
# chgrp -Rv www dokubook/

Note: http://chimeric.de/_src/template-dokubook.tgz always points to the latest stable version!

Configuration

You can change the following settings via the DokuWiki “Configuration Settings” Dialog.

Option Value(s)
Pagename Name of wikipages which should be treated as “navigation/footer”.
Closed Wiki If you activate this option the navigation will only show up to logged in users.

First Steps

Creating the Navigation

The template looks for a wiki page called navigation, or whatever you've defined in the configuration, in the current namespace to include it as the sidebar. If this file doesn't exist it looks in the upper namespace and so forth. If it can't find a proper file the sidebar will show the index instead.

Example navigation:

  * [[link1]]
  * [[link2]]
  * [[link3]]

Creating the Footer

Like with the navigation the template also includes a wiki page called footer, or whatever you've defined in the configuration, as the footer.

The template looks for a file called logo.[jpg|jpeg|png] in <dokuwki>/lib/tpl/dokubook/images/. If this file exists it will be shown as your logo. The dimension should be at 128×128. If the file doesn't exists the DokuWiki logo will be displayed instead.

Browser Compatibility

The template was tested with the following Browsers.

If you've seen it working with other browsers feel free to add them to the list :-)!

  • Firefox (Win 2.0.0.9, Linux 2.0, Mac OS X 2.0.0.1)
  • Opera (Win / Linux 8.5, 9.01, 9.24)
  • IE (Win 6.0, 7.0)
  • AvantBrowser (Win / IE 6.0)
  • Konqueror (Linux 3.5.1)
  • Safari (Mac OS X 2.04)
  • Shiira 2.2 (MAC OS X 10.4.10)
  • Safari 3 Beta2 (MAC OS X 10.4.10)
  • Safari 3.2.1 (MAC OS X 10.5.5)
  • Camino 1.5.4 (Mac OS X 10.4.11)
  • SeaMonkey 1.1.9 (Windows Vista SP1)
  • Google Chrome 0.2.149.27 (XP sp2)
  • Firefox (Ubuntu/8.04 hardy 3.0.3)

Bugs / Feature Requests

To report bugs and feature requests please use the bug tracker.

Changelog

Sites using this Template

FAQ

Can I hide the labels of the navigation boxes?

The IMHO cleanest solution for, instead of removing them from the tpl_fuctions.php file is hiding them via CSS, that's what CSS is good for namely modifying the appearance without the need to modify the content itself. Adding the following to your <dokuwiki>/conf/userstyle.css (if it doesn't exist, create it) should solve your issue ;-).

div.dokuwiki span.sb_label { display: none; }

Is it possible to make the sidebar/navigationbar a bit wider?

When I have multiple subfolders in there, the text is overlapping the main page.

Change dokubook_design.css

/* presume sidebar is left */
div.dokuwiki div#sidebar_left { width: 160px; }
/* change the 160px to the required width */
div.dokuwiki div#dokubook_container_left { left: 170px;}
/* change the 170px to the required width + 10 */

Is there any way for the Search function to show at the top of the sidebar rather than after the Navigation / Index area?

Edit the tpl_functions.php file located inside the template directory - search for:

// generate the searchbox

And move this line including the 4 following lines above:

// main navigation

Is there a way to change the font in your template to the default one's?

Edit <dokuwiki>/conf/userstyle.css:

body {
  font-family: <yourfont>;
}

Discussion

Q: I use your template in combination with the translation plugin. Because I didn't define navigation files so far, the language namespaces appear in the navigation window. Now, I tried to define navigation files to prevent the display of language namespaces but I did not succeed to display such nice collapsible contents like in the default case without navigation file. — Rolf Fankhauser 2009/08/11

Checkout one of the many available index plugins. — chi 2010/01/08 10:17

Q: Could you please move the logo configuration to dokuwiki_design.css ? In the present scheme, it cannot be changed in a farm, where modifications can be done in userstyle.css . — Thadeu Penna 2010/03/15 20:21

Why souldn't this be possible? Can you elaborate a bit? — chi 2010/03/16 10:39
The personal logo is a file placed in /lib/tpl/dokubook/images, as coded in tpl_functions.php. So, if you have a farm, it is not possible to have personal logos for each animal, as my users asked me. I did a small hack, where the file is to be put in media directory. IMHO ,the right solution would be having the logo as a configuration option rather than being hardcoded. An intermediate solution would be placing the logo file configuration into dokuwiki_design.css, that can be customized in each animal. — Thadeu Penna 2010/03/17 13:42
Hmm, I see, could you please open a feature request at the bug tracker linked on this page? Thank you!
 
template/dokubook.txt · Last modified: 2010/03/17 15:37 by 85.10.211.169
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Imprint Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki
WikiForumIRCBugsGitXRefTranslate