DokuCMS Template

DokuCMS Template

General Description

This template (templates in Dokuwiki are equivalent to skins in other wiki systems) can be of value if you use Dokuwiki as a lightweight CMS. It is best suited for a wiki with read access for everybody and restricted write access. It is not suited for a totally closed wiki. From version 0.1.1 onward it can be used for a totally open wiki.

The template offers a sidebar with either an index or content from a wiki page. It is based on the “Arctic” and the default template.

License

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

Special Thanks

Thanks to Andreas Gohr and fellow programmers for creating such a wonderful tool.
Thanks to Michael Klier for the Arctic template
Thanks to the users of this template for hints and ideas how to make this template more usable.

Installation

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

In the configuration plugin chose dokucms as your template:

Basic configuration

Suggested Dokuwiki Configuration

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

Turning “Use first heading for pagenames” on results in a nicer index.

Configuration

Configuration

Two general looks are included and may be switched by editing the style.ini.

;dokucms special variables
;---------------------------------------------------------------------------
__content_width__ = 80em;
; red look
; activate either these four lines or the four lines below
;__text__           = "#300"
;__yourlogo__ = flower_red.png
;__background_alt__ = "#911"

; blue look
; activate either these four lines or the four lines above
__text__           = "#003"
__yourlogo__ = flower_blue.png
__background_alt__ = "#119"

By commenting either the “red” or “blue” lines (with a semicolon!) you can switch the looks:

Blue look Red look

From version 0.4.4 you can define the maximum width (__content_width__) of the page. All CSS distance units apply. The smallest possible value is 950 pixel (70em). The maximum value can be as high as you like. High values result in long lines on large monitors which can be hard to read.

If you want to use another logo, prepare a picture with max dimension of 230 pixel width and 92 pixel height. Copy this picture into the image folder of the template. Edit the (activated) __yourlogo__ line in the style.ini accordingly.

The template has six configuration options:

configuration options

  • sidebar content can be either “file” or “index”. This option controls the content of the sidebar. The default option is “index”.
    • file: Displays the content of a file in the sidebar. The file has to be named sidebar. You can define a sidebar for every namespace in your wiki. If a namespace contains no sidebar, the file from the namespace above will be used. If the file option is chosen and no sidebar file exists, the sidebar will remain empty.
    • index: The sidebar contains the index of all pages in your wiki, alphabetically sorted. Namespaces are displayed as closed sublist that open if you open a page in the namespace. Sidebar pages are always excluded from the index.
  • clean index will remove the standard dokuwiki namespaces ('wiki' and 'playground') from the index if switched on (default: off) [for “index” sidebar content].
  • clean index of further namespaces comma separated list of namespaces to be removed from the index if “clean index” is switched on (default: empty) [for “index” sidebar content].
  • show edit button in sidebar: will show an edit button in the sidebar if you may edit the contents of the sidebar (default: on) [for “file” sidebar content]
  • 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)

Update

Backup your DOKUWIKI_ROOT/lib/tpl/dokucms/style.ini. Unpack the file in DOKUWIKI_ROOT/lib/tpl/. This will overwrite the current template with the new version. Overwrite the delivered style.ini with your backup copy, if there were no changes to style.ini content. I will explicitly list style.ini changes in the changelog.
Otherwise you will have to check for differences between your backup copy and the default style.ini. I recommend meld for that purpose.

Recommendation

Clean the cache (DOKUWIKI_ROOT/data/cache) after installation or update of this template.

Browser compatibility

This template works well with current Opera, Firefox, Google Chrome and Internet Explorer (from Version 8 upwards). Safari has a problem displaying the color blend in the page header correctly, but works otherwise. With IE6 all functions work, but there are some display faults.

Dokuwiki compatibility

Version 0.11 is made for DokuWiki Release 2015-08-10 (Detritus). It also works with version 2014-09-29 (Hrun), 2014-05-05 (Ponder Stibbons) and version 2013-12-08 (Binky).

Version History

0.1 from 2008-01-05
- initial release

0.1.1 from 2008-04-05
- compatibility release for Dokuwiki Release rc2008-03-31
- Date output adapted to new date format
- The edit button is shown when page is editable, whether you are logged in or not

0.1.2 from 2008-04-13
- Corrected overlooked date output on the detail page

0.2 from 2008-06-21
- Added options to control contents of sidebar
- Lots of small CSS changes
- Slightly changed colors

0.2.1 from 2008-09-01
- Corrected a CSS error which caused IE7 to cut off parts of the wiki name in the page header
- A few small CSS changes
- Changed colors blends in the page header so the wiki name becomes more readable

0.2.2 from 2008-12-28
- Namespace titles are now taken from the title of the namespace start page rather than the namespace name
  (index mode)
- Portuguese and Esperanto translation (by Felipe Castro [fefcas at gmail.com])
- As always few small CSS changes

0.3 from 2009-02-15
- Added licence information on every wiki page

0.3.1 from 2009-04-19
- Added configurable backlinks button
- A few small CSS changes

0.3.2 from 2009-08-23
- CSS changes to enhance plugin compatibility
- compatibility code for the 'blog and 'nspages' plugins

0.4 from 2009-12-05
- compatibility release for Dokuwiki Release rc2009-12-02
- changes in style.ini

0.4.1 from 2009-12-29
- compatibility release for Dokuwiki Release 2009-12-25
- A few CSS changes

0.4.2 from 2010-02-17
- restored IE6 support that somehow got lost with last updates
- removed superfluous code in tpl_functions.php
- A few CSS changes

0.4.3 from 2010-04-03
- corrected width of edit box

0.4.3.1 from 2010-04-25
- corrected an error in style.ini

0.4.4 from 2010-08-18
- made the column layout more robust for older browsers
- the white background was widended to 4000 pixel
- the maximum width of the document area is user defineable
  (changes suggested by Volker Pohlers [volker.pohlers at gmx.net])
- PHP code optimizations
- changes in style.ini

0.5 from 2010-10-20
- compatibility release for Dokuwiki Release rc2010-10-07

0.5.1 from 2010-11-07
- compatibility release for Dokuwiki Release 2010-11-07

0.6 from 2011-05-04
- compatibility release for Dokuwiki Release rc2011-04-22

0.6.1 from 2011-05-06
- corrected font size for code segments

0.7 from 2011-11-19
- compatibility release for Dokuwiki Release rc2011-11-10
- better print layout
- minor CSS changes
- changes in style.ini

0.7.1 from 2011-12-29
- media manager button may be switched off

0.7.2 from 2012-01-29
- compatibility release for Dokuwiki Release 2012-01-25

0.7.3 from 2012-09-18
- configurable namespaces may be excluded from the index
- better error handling when index file is missing

0.8 from 2012-09-27
- compatibility release for Dokuwiki Release rc2012-09-10 and 2012-10-13 (Adora Belle)

0.8.1 from 2013-03-16
- update of Portuguese and Esperanto translations (by Felipe Castro [fefcas at gmail.com])

0.9 from 2013-03-31
- compatibility release for Dokuwiki Release rc2013-03-06 and 2013-05-10 (Weatherwax)

0.9.1 from 2013-11-01
- CSS syntax fix

0.10 from 2013-11-20
- compatibility release for Dokuwiki Release rc2013-11-18 and 2013-12-08 (Binky)
- changes in style.ini

0.11 from 2015-10-11
- compatibility release for Dokuwiki Release 2015-08-10 (Detritus)
- centered content
- fixed 'show search box if logged in' option

0.11.1 from 2015-10-25
- added responsiveness
- restored and changed 'content-width' variable
- replaced header background images with CSS gradients
- changes in style.ini

0.11.2 from 2016-03-20
- a few CSS changes

Download

dokucms-0.11.2.tar.gz 81,341 Bytes
(for Dokuwiki release 2013-12-08, 2014-05-05, 2014-09-29 and 2015-08-10)

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

Example

Please see my 'courses' wiki (in German)

Contact

email

Last change: 2017-05-18 06:46pm by klaus