roundbox Template

====== roundbox Template ======

---- dataentry template ----

Author_mail: don@lynsoft.co.uk Don Bowman

Description: Rounded boxes that divide the page in a header, sidebar and main content area.

LastUpdate_dt: 2011-01-02

Compatible: 2010-11-07 "Anteater"

Template_tags: # comma separated tags

Screenshot_img: http://download.lynsoft.co.uk/Roundbox1.png

----

(Original author: Christopher Arndt)

Originally built by Christopher Arndt and based on the design of his homepage. Boxes that divide the page into a header, sidebar and main content area. In most browsers (not Internet Explorer up to IE8) the boxes can have round corners.

===== Original info =====

**Author:** [[don@lynsoft.co.uk|Don Bowman]] (was [[chris@chrisarndt.de|ChristopherArndt]])\\

**Date:** ''2011-01-02''

{{http://download.lynsoft.co.uk/Roundbox1.png?200 | Roundbox template Screenshot}} Roundbox is a [[:Template|template]] for DokuWiki, that was originally built by Christopher Arndt to match the style of his [[http://chrisarndt.de|homepage]], which is in turn based on a design from [[http://www.oswd.org/|Open Source Web Designs]]. It has a clear, tableless design build on boxes, which divide the page in three main sections: the header, a sidebar, and the main content area. The template is suitable for sites, that have read-only access for non-registered users, since all buttons can switched on/off, depending on [[:acl]] levels and group membership. It is also possible to restrict access only to registered users.

Click the image to the left to see a bigger screenshot!

With the latest release Roundbox is compatible with the 2010-11-07 "Anteater" release of DokuWiki. It incorporates changes discussed below and also some additional updates to make it easier to use.

Feel free to send your experiences with this template by email or write a comment [[#comments_suggestions|below]].

See what's new [[#Changes|here]]!

===== Download =====

| 2011-01-02 | zip | [[http://download.lynsoft.co.uk/template_roundbox_20110102.zip]] |

| 2011-01-02 | tgz | [[http://download.lynsoft.co.uk/template_roundbox_20110102.tgz]] |

| 2009-06-21 | zip | [[http://download.lynsoft.co.uk/template_roundbox_20090621.zip]] |

| 2009-06-21 | tgz | [[http://download.lynsoft.co.uk/template_roundbox_20090621.tgz]] |

| 2009-01-26 | zip | [[http://download.lynsoft.co.uk/template_roundbox_20090126.zip]] |

| 2009-01-26 | tgz | [[http://download.lynsoft.co.uk/template_roundbox_20090126.tgz]] |

| 2005 0.4.1b | zip | [[http://chrisarndt.de/en/software/dokuwiki/roundbox-template-0.4.1b.zip]] |

===== Installation =====

- Download the template archive.

- Extract it to ''<dokuwiki>/lib/tpl''. This will create a subfolder called ''roundbox''.

- Use the Admin Configuration Settings to select the template.

- Optional: configure some aspects of the template (see [[#Configuration]]).

- Optional: select a theme (see [[#Themes]]).

===== Themes =====

From the 2009-06-21 version the theme is a configuration option. The theme can be selected through Configuration Settings.

From the 2009-01-26 version it is possible to change the theme by modifying the file ''style.ini''. Some suggested themes have been included in the ''themes'' folder. To use these, simply copy and rename one of them to replace the existing ''style.ini''.

===== References =====

This template draws ideas and uses code from the following:

* The default template distributed with DokuWiki as of version 2010-11-07 "Anteater"

* The [[http://wiki.jalakai.co.uk/dokuwiki/doku.php/start | sidebar template]]

* The [[http://www.jandecaluwe.com/testwiki/doku.php/navigation:intro | Better navigation template]]

* <del>It also includes some CSS styles taken from different [[:plugins]] which I use at my site. These all went into the file ''plugins.css''.</del> The use of ''plugins.css'' has been dropped in the 2009-01-26 version. It may be re-instated later.

==== Sites using this template ====

* [[http://www.phppatterns.com/]]

* [[http://www.asif.dreamhosters.com/]]

* [[http://coldstonelabs.org/]]

* [[http://www.spamer.me.uk/wiki/]]

* [[http://www.scoutlink.it/it/]]

* [[http://trolug.de/]] Troisdorfer Linux User Group

* [[http://lynplex.org/]]

* [[http://lynsoft.co.uk/]]

* [[http://tollerporcorum.org.uk/]]

* [[http://www.paddlingabc.com]]

Feel free to add your own site here, if you are using this template!

===== Configuration =====

Some aspects of this template look and behaviour can be configured by changing the settings in ''<dokuwiki>/lib/tpl/roundbox/conf/default.php''. Most of them can now also be changed through Configuration Settings. The following settings are available:

==== rb_theme ====

Specifies the theme to be used.

* Type: String

* Values: <current list of themes>

* Default: ''evening''

==== rb_sidebar_orientation ====

Specifies on which side of the main page content block the sidebar is displayed.

* Type: String

* Values: ''left|right''

* Default: ''left''

==== rb_sitenav ====

Show the site navigation box in the sidebar. See the section [[#the sidebar]] for details.

* Type: Boolean

* Default: ''true''

==== rb_uselinks ====

Use links instead of buttons in the sidebar command box.

* Type: Boolean

* Default: ''true''

==== rb_tagline ====

Set the text for the subtitle of your wiki, which is shown below the wiki title.

* Type: String

* Default: <empty string>

==== rb_roundcorners ====

Enable rounded corners for the main layout boxes. Works in most browsers (not Internet Explorer up to IE8).

* Type: Boolean

* Default: ''true''

==== rb_youarehere ====

Replace [[:breadcrumbs]] with a hierarchical navigation path.

* Type: Boolean

* Default: ''true''

==== rb_crumbsep ====

Sets the text that separates each breadcrumb. This only has an effect if [[#rb_youarehere]] is ''true''.

* Type: String

* Default: ''" &rarr; "''

==== rb_index ====

Sets the name for the index page of namespaces. This only makes sense if [[#rb_youarehere]] is ''true''.

* Type: String

* Default: ''"start"''

==== rb_removeunderscore ====

Remove underscores from breadcrumb links. This only has an effect if [[#rb_youarehere]] is ''true''.

* Type: Boolean

* Default: ''true''

==== rb_showeditbtn ====

Show an edit button on the sidebar.