README.markdown
1Starter Bootstrap Dokuwiki Template
2======
3
4[Bootstrap](http://twitter.github.io/bootstrap/) [Dokuwiki](https://www.dokuwiki.org/dokuwiki) template
5based on the [starter template](https://www.dokuwiki.org/template:starter).
6
7[Demo](http://dokuwiki.camlittle.com)
8
9This template is designed to be responsive on all modern devices, accessible,
10and good looking. It aims to replace most of the default Dokuwiki styling with
11equivalents from available Bootstrap styles.
12
13Created by [Cameron Little](http://camlittle.com) for [WWU ResTek](http://restek.wwu.edu).
14
15Features
16----
17
18 * Insert table toolbar button.
19 * Viewing, editing, and detail pages styled with bootstrap.
20 * Auto generating wiki sidebar (use "automatic" in sidebar configurationt).
21 * Collapsible sidebar bootstrap menu.
22 * Collapsible table of contents.
23 * Bootstrappy support for acronyms, quicksearch, and more.
24 * [Sorttable](http://www.kryogenix.org/code/browser/sorttable/) built in.
25 * Built in layout configuration.
26 * Image/Logo support in navigation/header.
27
28Logo Support
29----
30
31The theme looks for a ``brand.png`` or ``brand.jpg`` file in the root of the
32dokuwiki install and displays it if found. You can override this in the
33``header_img`` template setting. The template settings contain fields for
34setting the vertical padding and height of the logo image. By default, the
35theme displays both the logo and title of the wiki. The ``header_title`` option
36can be used to display only the logo.
37
38Javascript
39----
40
41Since dokuwiki (Rincewind) uses jQuery 1.6 and bootstrap uses jQuery 1.9, this
42theme has to use both. ``jQuery`` should be used instead of ``$`` when
43referencing jQuery 1.6 and ``jQNew`` should be used when referencing 1.9. This
44is enabled using ``$.noConflict(true)``.
45
46CSS
47----
48
49The css for this file is included, but to really hack and change it, you'll want
50to check out how it's generated.
51
52I've [forked bootstrap](https://github.com/apexskier/bootstrap/tree/starterbootstrap)
53in order to more efficiently integrate bootstrap with dokuwiki. Unfortunately,
54dokuwiki's support for modifying html in templates is very poor, so I can't add
55the proper css classes where I want them. Instead, I've added the proper
56selectors directly into bootstrap's less. For most stuff, see the
57[`less/dokuwiki`](https://github.com/apexskier/bootstrap/tree/starterbootstrap/less/dokuwiki)
58folder. For everything, [compare my branch to the main
59repo](https://github.com/apexskier/bootstrap/compare/starterbootstrap).
60
61If you do decide to work on the less, you can still run grunt, and should still
62be able to build everything. The Gruntfile has been modified to build into
63starterbootstrap's js and css directories and use jQNew.
64
65Examples
66--------
67
68The following list contains sites using this template or a fork of it. Raise an issue or
69contact me if you'd like to be added to this list.
70
71 * http://piratebox.cc/start
72 * http://www.tributieimposte.it/portaleiuc
73 * http://elgitar.com/
74 * http://www.animint.net/
75
