History of ThemeTutorial

Comparing versions
Version 28Current version
This page is supposed to provide some information on how to create a theme for bitweaver.

there are some detailed informations on how the CssSchema is set up and how to use it without getting frustrated, cos "so many things change every time i change only one class".

tips, hints and tricks

browser

personally i use opera as the browser of choice due to it's state-of-the-art css and XHTML compliancy and the possibility to customise everything yourself. if you want to use opera, please visit Literary Moose's Opera Pages for information on how to turn your opera into an incredible designers tool.

for beginners, however, i recommend firefox and the webdeveloper extension. both of these browsers are cross plattform.

pick an appropriate starting theme

if you want to customise a theme according to your needs, you should pick a theme that more or less has a layout you wish to use. if you are a complete beginner, it might be useful to start with a theme that uses a table based layout as these are much more forgiving and much easier to set up. such themes include: basic, bitweaver, july4.

most other themes use a div based layout system, which is more sophisticated to set up. if your changes, however, are minor, such as modifying the colours or the font-size, you should be able to pick one of these themes as well.

source code

we use the smarty templating engine and we apply the {strip} tag to most templates to remove any excess whitespace characters. this reduces the download size of the html pages but also results in an html code that is very difficult to read. to make the source code readable, i recommend you change the following in your bitweaver install:

/util/smarty/libs/Smarty_Compiler.class.php line 337
from
{code()}
$strip_tags_modified = preg_replace('~\r\n+~m', '', $strip_tags_modified);
{code}
to
{code()}
$strip_tags_modified = preg_replace('~\r\n+~m', "\n", $strip_tags_modified);
{code}

more to come...


the beginning

getting started

all themes that are available on your site are located in /themes/styles/
here you will find one theme called blank. this is a theme which contains all the most important classes and ids listed without any definitions.


to create a new theme follow these steps

copy the theme 'blank' (or whichever theme you would like to modify) and rename the folder to your new themename.
within <themename> rename the original css file to <themename>.css
hence we go from
/themes/styles/blank/blank.css
to
/themes/styles/<themename>/<themename>.css

i will assume that you have copied /blank/ as a starting point
(if not, please copy all the contents of /blank/ (appart from blank.css and blank_commented.css) to your new theme folder to take full advantage of this tutorial

taken from /themes/styles/blank/readme.css

if you wish to create a theme from scratch here is a list of all css files present in /blank/ to aid you:
  • blank.css
    • main css file with all globally used classes and more
  • customisation.css
    • contains a list of classes that can be utilised to further customise the site
  • debugwithoutline.css
    • contains a set of classes and definitions that allow you to visualise all structures used on your site
  • showdiv.css
    • if included will visualise all divs used on the site including their classes and ids
    • (works well with debugwithoutline.css)
  • showstructure.css
    • like showdiv.css but it will show you all classes and structures appart from divs
    • (works well with showdiv.css and/or debugwithoutline.css
  • showsitelayout.css
    • visualises the layout of the main tiki ids used by surrounding them with coloured lines
  • showpagelayout.css
    • draws coloured borders on one side of certain elements
    • to allow you to view the classes used without messing with your layout

including css files in your main css file

to include one of these files in your theme for debugging purposes, you can insert a line at the top of your css file
@import url("include.css");

do this for as many css files as you wish but note:
  • @import only works when it's before any definitions
  • showstructure.css | showdiv.css don't work with MSIE
    • use opera or mozilla to utilise these files
    • debugwithoutline.css only works with opera

i have tested the above with the following browsers:
  • MSIE 6.02 (nothing works regarding structures)
  • Mozilla Firefox 0.8 (everything works appart from debugwithoutline.css)
  • Opera 7.5 (everything works)

now we are ready to start with the css files.


the css

introduction

if you are coming from TikiWiki, you will notice that the css is much smaller compared to that of TikiWiki and there are very much fewer classes used.

This, however has absolutely nothing to do with the flexibility and power of the css file over the design of bitweaver. in fact, it's much easier and quicker to create a site that has an overall feel throughout. moreover, it's easy to customise particular sections exactly the way you need them if you so desire.

a certain level of css knowlegde however is required to do this.

if you feel that you 'know' css you can use the 'blank' theme as a starting point for your new theme. please consult the readme in the 'blank' folder for further information.

please note:
there is a file called base.css which is called by most themes using @import at the top of the css file. this css contains some definitions which make theming easier due to it's generic settings that set a base for difficult settings such as the css dropdown menus.


however, if you believe that there is something to be learnt from this brief tutorial, carry on reading... first of all it's important that you have a look at CssSchema, which has a basic layout of the site in terms of classes used on all output pages.

a simple example

1.
text

2.
text

3.
text


if you define the following:
{code()}
.box { font-weight: bold; }
{code}

it will result in the following:
1. text
2. text
3. text

the text in all three cases will be bold, however, if you define it like this:
{code()}
.box { font-weight: bold; }
.module { color: red; }
.admin { color: blue; }
{code}

it will result in the following:
1. text
2. text
3. text

this allows you to create a general style, look, feel using very few classes such as .box above (all the above are bold) but then go on and customise and finetune particular sections or groups of items simply.

slightly more interesting

furthermore, it's easy to modify classes that are defined within other classes using the correct selectors.

consider the following 2 pages:



{code()}

pile of foo


this is more foo


{code}



{code()}

pile of foo


this is more foo


{code}



the above only differ in the first line - either wiki or articles. as above it's easy to aply general definitions to title, and content. however it's also possible to influence, say, the content section of articles without changing settings in the wiki by defining the following:

{code()}
.articles .content { background: silver; }
{code}

the nitty gritty

consider the following page



{code()}
zero plus two equals one



i can sing

some chickens have lips


{code}



if you wish to apply a definition to all boxes you use
{code()}
.box { text-decoration: underline; }
{code}

zero plus two equals one
i can sing
some chickens have lips


if you wish to apply settings only to the boxes within the foo section
{code()}
.box { text-decoration: underline; }
.foo .box { font-weight: bold; }
{code}

zero plus two equals one
i can sing
some chickens have lips


if you wish to apply settings only to the box that has foo associated with it
{code()}
.box { text-decoration: underline; }
.foo .box { font-weight: bold; }
.foo.box { color: red; }
{code}

the result of all three definitions would be
zero plus two equals one
i can sing
some chickens have lips


please note the lack of a space in the third case as compared to the second case.
'.foo .box' vs '.foo.box'


note for MSIE: MSIE only renders .foo.box {...} if this is the actual order in which they are mentioned. i.e. .foo.box {...}
only renders if the class is called:
class="foo box"
and not:
class="box foo"


obviously you can apply a setting to only the top box by setting definitions something like this
{code()}
.box { color: blue; }
.foo .box { color: black }
{code}

zero plus two equals one
i can sing
some chickens have lips

as you can see, you have an immense amount of power if you wish to use these features.


building the theme

Well the first thing you'll probably want to start with is font style and background.
{code()}
  • {
color: blue;
font-family: sans-serif;
font-size: normal;
font-style: normal;
font-weight: normal;
text-decoration: none;
}
body {
background-color: gray;
background-image: url("images/background.jpg");
}
{code}

Take a look at CssSchema and see how you want to layout your site. Lets say you wanted #tikitop to always be 120px high with a silver background, you'd set accordingly.
{code()}
  1. tikitop {
background-color: silver;
height: 120px;
}
{code}

Next, you'd like to set a border around #tikimain.
{code()}
  1. tikimain {
border: thin solid black;
}
{code}

more to come...


slideshows

slideshows are a feature of the wiki and allow you to display the wiki page in a particular way without any excess information such as columns or banner.

the slideshow pages are set up in a similar way as the wiki page and use the same classes. you can pick a theme that will be used when displaying wiki pages as a slideshow.

if you would like to use your own theme as the style for slideshows but would like something like 'larger text', you can create slideshow.css in your theme directory and add all your definitions in there. this file will be loaded in addition to your regular css and you can thus override any settings made above.

also, there is a folder called slideshows. this contains some sample slideshow.css files, which you can copy (and rename) to your theme dir, saving you some time.

so, the easiest method to enlarge your slideshow text, is to create a file called 'slideshow.css' in your theme directory and then copy and paste the content of 'slideshows/enlargetext.css' to that file and save - voila!

just to illustrate, here is the content of enlargetext.css:
{code()}
h1,.title {
font-size: 2.4em;
line-height: 120%;
}
.content {
font-size: 1.3em;
line-height: 120%;
}
{code}


the icons

in bitweaver it is possible to use your own set of icons to give the site the ultimate in customisation and theming flexibility.

currently it is possible to associate any icon with a given theme by creating an icon in the folder
/themes/styles/<style>/icons/<package>/

the extension of the icon is irrelevant. if a file with the same name as the original icon is found in the above location, it will override the original icon. this allows you to fully customise the feel of your site, even integrating icons in the mix, wihout you ever having to touch the source code.

Note: only available from version ReleaseOne onwards.


more to come...


The Templates

template files can be found in the directories <package>/templates. most of the templates have the same name as the php file, using .tpl as the extension. some specific .tpl files are only used as an inclusion and can't be used on their own. these are marked with an additional _inc at the end of the filename.

If you wish to edit any one of these templates, we recommend that you create a copy of the file in your theme folder and modify the copy there. The structure in the theme folder should be
/themes/styles/<style>/<package>/<template>.tpl
You can also simply copy the template into
/themes/styles/<style>/<template>.tpl
though there may be a risk of file name collision if two bitweaverPackages have the same name.

Use the Force

If you would like to force the use of a given template for all themes but don't want to edit the source files, you can create a directory called force. Any templates found here, will override any other templates unconditionally.
/themes/force/<template>.tpl

This is an excellent technique for creating a single top_bar for your site if you use multiple themes.

This will allow easy upgrading of your system if you should require this at some point.

more to come...


the css drop down menus

Tutorial - Native Theme

</style></themename></themename></themename></themename>
 

This page provides information on how to create a theme for Bitweaver. For details on classes and IDs, see Bitweaver's CSS Schema. About themes and styles: a theme is how Bitweaver looks and feels. A theme consists mainly of a style, located in /yourbitweaver/themes/styles/yourstyle/, and also of a layout, an icon set, modules, and other details. The style consists of CSS files and template files (which override Bitweaver's default template files). Although a style is part of a theme, a style tends to dominate the look of a Bitweaver install. That is why theme and style are often used synonymously.

Getting started


Picking a style

To customize Bitweaver, you should pick a style that already exists and more or less looks like the one your wish to end up with - considering its layout, module positions, menu placements and so on. Bitweaver's themes use DIV-based layouts (40 presets called Layout Gala). Details, however, are controlled in your customized CSS files and templates.

All styles that are available on your site are located in /themes/styles/. The style called blank (its CSS file lists off all the most important classes and IDs), and the style cascader (its CSS contains only the most important layout definitions) are good starting points for theme development.

Browser

Use a state-of-the-art CSS and XHTML compliant browser for development, and take care of backwards compatibility to old browsers later. Consider opera which has the possibility to customise everything yourself and can be turned into an incredible designers tool, or Mozilla Firefox, which can be extended with extremely useful plugins for development like Web Developer, https://addons.mozilla.org/de/firefox/addon/271|ColorZilla] and Firebug, among others.

Applying Changes

If your environment for theme development is set up correctly, ss soon as you've made changes in your style's CSS file, they will be visible in your browser after you have reloaded the page. If the changes don't appear
  • make sure you don't have any spelling mistakes (syntax highlighting helps)
  • make sure you are addressing the correct class or id (check the source of the page if the class or id exists)
  • make sure you are using the correct selectors (a.external is not the same as .external a)
  • use more specific selectors (a.external is better than .external for many reasons)
  • try using !important in your definition (e.g., border:1px solid #000 !important;) for testing

Readable source code

Bitweaver uses the Smarty templating engine. The {strip} tag is applied to most templates to remove excess whitespace characters. This reduces the download size of the HTML pages and, more importantly, makes sure that browsers don't interprete white space as extra pixels to add to the layout. As a result, the source code of any Bitweaver page is very difficult to read without applying some kind of clean up. Use plugins like View formatted source according to your browser.

To make the source code readable without any extra plugin, you can change the following in your Bitweaver install (and clear the system cache):

/util/smarty/libs/Smarty_Compiler.class.php


<?php
335
// from:
336$text_blocks[$j] = preg_replace('![\t ]*[\r\n]+[\t ]*!'''$text_blocks[$j]);
337// to:
338$text_blocks[$j] = preg_replace('![\t ]*[\r\n]+[\t ]*!'"\n"$text_blocks[$j]);
?>


Creating a new Style

Make a copy of the folder called blank (or any other) and rename the folder to the name of your new style. Within the newly named folder, find the original CSS file blank.css (foldername.css) and rename it to name of your new style as well:

copy and rename one style folder and one CSS file


<?php
// from:

/themes/styles/blank/
/
themes/styles/blank/blank.css
// to:
/themes/styles/yourstyle/
/
themes/styles/yourstyle/yourstyle.css
?>


Templates

Template hierarchy

The general process of modifying a template is to copy it from its location in bitweaver/package/templates/template.tpl to your style's directory: bitweaver/themes/styles/yourstyle/package/template.tpl. Now the upgrade process to new versions of Bitweaver is quick and easy. The following is the order in which locations are checked for a given template. If Bitweaver doesn't find the template wiki/templates/editpage.tpl in the first location, themes/force/wiki/editpage.tpl, it moves on to look for it in the second location, and so on:

order in which locations are checked for a given template


1. themes/force/package/
2. themes/force/
3. themes/styles/style/package/
4. themes/styles/style/
5. package/templates/


This means, placing a file in themes/force will override any template found in any style folder. For example, you can create a footer containing copyright information which will be applied to any style used on your site, without having to modify all the footer files of all available styles.

Most of the templates have the same name as "their" PHP file, only with .tpl as the extension. Some specific .tpl files are only used as an inclusion and can't be used on their own. These are marked with an additional _inc at the end of the filename.

Force templates

If you would like to force the use of a given template for all styles but don't want to edit all source files, you can create a directory called bitweaver/themes/force/. Any template found here, will override any other template unconditionally. This is an excellent technique for creating a single top_bar for your site if you use multiple themes.

The CSS

Because Bitweaver's CSS tree of classes and ID is so efficient, its CSS files are quite small and not many classes are used. This makes your styles flexible and powerful. Moreover, it's easy to customise particular sections exactly the way you need them.

Please Note: There is a file called base.css which is called by some styles using @import. This CSS contains some definitions which make theming easier due to it's generic settings for Javascript tabs, Suckerfush CSS dropdown menus, and others.

For details on actually editing CSS files, cascading selectors, and hacking around browser bugs, please consult the appropriate online guides or books.

Slideshows

Slideshows are a feature of Bitweaver's WikiPacakage and allow you to display a wiki page in a particular way without any excess information such as columns or banners. The slides are set up in a similar way as the wiki page and use the same classes. You can pick a theme that will be used when displaying wiki pages as a slideshow.

To use your own theme as the style for slideshows but would like something like 'larger text', you can create slideshow.css in your theme directory and add all your definitions in there. This file will be loaded in addition to your regular CSS and you can thus override any settings made above. Also, there is a folder called slideshows. It contains sample slideshow.css files, which you can copy (and rename) to your theme dir to use as blueprints.

So, the easiest method to enlarge your slideshow text, is to create a file called 'slideshow.css' in your theme directory and then copy and paste the content of 'slideshows/enlargetext.css' to that file and save - voila!

To illustrate, here is the content of enlargetext.css:

h1,.title {
  font-size: 2.4em;
  line-height: 120%;
}
.content {
  font-size: 1.3em;
  line-height: 120%;
}


Icons

In Bitweaver it is possible to use your own set of icons to give your site the ultimate in customisation and theming flexibility. Associate any icon with a given theme by creating an icon in the folder /themes/styles/style/icons/package/

The extension of the icon has to be: jpg, gif, png. Icons in the above location will override the original Bitweaver icon. This allows you to integrate icons without having to touch the source code.

Style Information

Create a folder called style_info in your style directory. In there, add a file called description.htm, which should contain a brief description of your theme in HTML format. Then, add a small preview thumbnail for the style named preview.ext (the extension doesn't matter).

This info is displayed to the admin of a Bitweaver install when he picks a style in Admin » Themes » Themes Manager'. It is also displayed then you upload your custom style to bitweaver.org so that others can download it.

Debugging help

If you create a style from scratch, here is a list of all CSS files present in /blank/ to aid you, see /themes/styles/blank/readme.css:
  • blank.css
    • main css file with all globally used classes and more
  • customisation.css
    • contains a list of classes that can be utilised to further customise the site
  • debugwithoutline.css
    • contains a set of classes and definitions that allow you to visualise all structures used on your site
  • showdiv.css
    • if included will visualise all divs used on the site including their classes and ids
    • (works well with debugwithoutline.css)
  • showstructure.css
    • like showdiv.css but it will show you all classes and structures appart from divs
    • (works well with showdiv.css and/or debugwithoutline.css
  • showsitelayout.css
    • visualises the layout of the main bit ids used by surrounding them with coloured lines
  • showpagelayout.css
    • draws coloured borders on one side of certain elements
    • to allow you to view the classes used without messing with your layout

To include one of these files in your own style for debugging purposes, insert
@import url("include.css"); at the top of your CSS file. Note that @import only works when it's before any definitions and that some more sophisticated debugging methods only work with advanced browsers.
Page History
Date/CommentUserIPVersion
30 Oct 2008 (17:12 UTC)
removed HTML before it's stripped out again, removed outdated CSS help, re-structured the whole page, less words
laetzer141.20.150.4345
Current • Source
charles75.160.109.23544
View • Compare • Difference • Source
laetzer85.178.10.6243
View • Compare • Difference • Source
xing194.152.164.4541
View • Compare • Difference • Source
Kozuch88.100.108.15940
View • Compare • Difference • Source
xing194.152.164.4535
View • Compare • Difference • Source
xing194.152.164.4534
View • Compare • Difference • Source
xing194.152.164.4533
View • Compare • Difference • Source
xing194.152.164.4532
View • Compare • Difference • Source
xing194.152.164.4531
View • Compare • Difference • Source
xing194.152.164.4530
View • Compare • Difference • Source
xing194.152.164.4529
View • Compare • Difference • Source
spiderr66.93.240.20428
View • Compare • Difference • Source
xing194.152.164.4527
View • Compare • Difference • Source
xing194.152.164.4526
View • Compare • Difference • Source
xing194.152.164.4525
View • Compare • Difference • Source
xing194.152.164.4524
View • Compare • Difference • Source
xing194.152.164.4523
View • Compare • Difference • Source
xing194.152.164.4522
View • Compare • Difference • Source
xing194.152.164.4521
View • Compare • Difference • Source
xing194.152.164.4520
View • Compare • Difference • Source
xing194.152.164.4519
View • Compare • Difference • Source
xing194.152.164.4518
View • Compare • Difference • Source
fire203.229.38.12417
View • Compare • Difference • Source
xing194.152.164.4516
View • Compare • Difference • Source
xing62.99.189.13015
View • Compare • Difference • Source