source: trunk/CUSTOMISATION @ 1034

Last change on this file since 1034 was 966, checked in by kake, 15 years ago

Add support for custom template to add to page <head> (ticket #191).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.3 KB
Line 
1It is not recommended that you amend the supplied templates - they
2contain logic and therefore can have bugs, they may have new features
3added in the future and so on.
4
5From OpenGuides 0.41, some of the supplied templates will optionally
6call out to other template fragments that you can put in a custom template
7path (by default custom-templates/). If custom templates do not exist then
8sensible default wording will be used instead.
9
10The names of all custom templates will be prefixed with custom_.
11
12The custom templates currently supported are:
13
14 - custom_header.tt
15   Will be included at the very end of the <head> element on every page.
16
17 - custom_licence.tt
18   Will be included at the top of the page editing form.
19
20 - custom_footer_credits.tt
21   Will be included in a <div id="footer"> at the base of every page.
22   You may wish to take advantage of the supplied TT variables
23     - [% delete_link %]
24       Will supply a link to delete the page, if and only if your
25       wiki.conf has deletion turned on.
26     - [% openguides_version %]
27       Contains the version of OpenGuides that your site is running on.
28
29 - custom_banner.tt
30   Will be included in a <div id="banner"> at the top of every page.
31   You may wish to take advantage of the supplied TT variables
32    - [% site_name %]
33      Contains the value supplied in wiki.conf as the name of the site.
34
35 - custom_node.tt
36   Will be included just below the main wiki content in node.tt.
37
38 - custom_autocreate_content.tt
39   You can control the text that gets put into the content field of any
40   autocreated category/locale nodes by putting it in this template.
41   The following TT variables will be available to the template:
42     - [% index_type %]
43       e.g. "Category" - note that the first letter is capitalised
44     - [% index_value %]
45       e.g. "Vegan-friendly" - capitalisation just as typed in the edit form
46     - [% node_name %]
47       e.g. "Category Vegan-Friendly" - the full, "official" name of the
48       autocreated node
49
50Requests for further custom inserts are welcomed.
51
52If you include your own versions of other (non custom_) templates in
53custom-templates they will override the installed files, and this may
54cause you problems. We would much rather that you let us know what we could
55do to make your customisations possible within custom_ templates.
Note: See TracBrowser for help on using the repository browser.