4 | | == Description == |
5 | | |
6 | | This plugin simplifies the process of distributing and deploying themes and styles. |
7 | | |
8 | | In the 0.10 version, the WebAdmin plugin is required. |
9 | | |
10 | | === Options === |
11 | | All of these are under `[theme]`. |
12 | | theme:: |
13 | | Specify which theme to use. |
14 | | override_logo:: |
15 | | If set to true, the theme can override your `header_logo` settings with its own logo. (Note: This is true by default) |
16 | | |
17 | | == API Basics == |
18 | | Most themes should simply subclass `ThemeBase` (in `themeengine.api`). This works similarly |
19 | | to `WikiMacroBase`, use your theme name followed by "Theme" as the class name, and put the |
20 | | description as the class's docstring. There are a number of class variable you can define to affect |
21 | | how your theme will be loaded, if any is set to `True`, it will take on a default value (see below): |
22 | | header:: |
23 | | The path to the header template. (Defaults to `templates/header.cs`) |
24 | | footer:: |
25 | | The path to the footer template. (Defaults to `templates/footer.cs`) |
26 | | css:: |
27 | | The path to the CSS template. (Defaults to `templates/css.cs`) |
28 | | htdocs:: |
29 | | The folder containing the static content. (Defaults to `htdocs`) |
30 | | screenshot:: |
31 | | The path to the screenshot file. (Defaults to `htdocs/screenshot.png`) |
32 | | header_logo:: |
33 | | A dict containing the data normally in `[header_logo]` in trac.ini. (Defaults to `{}`) |
| 4 | [[Include(source:/themeengineplugin/0.11/README)]] |