source: wiki/pages/TracInterfaceCustomization @ 40542

Last change on this file since 40542 was 40542, checked in by obi, 2 years ago

reset wiki files

File size: 10.0 KB
Line 
1= Customizing the Trac Interface
2[[TracGuideToc]]
3[[PageOutline]]
4
5== Introduction
6This page gives suggestions on how to customize the look of Trac. Topics include editing the HTML templates and CSS files, but not the program code itself. The topics show users how they can modify the look of Trac to meet their specific needs. Suggestions for changes to Trac's interface applicable to all users should be filed as tickets, not listed on this page.
7
8== Project Logo and Icon
9The easiest parts of the Trac interface to customize are the logo and the site icon. Both of these can be configured with settings in [wiki:TracIni trac.ini].
10
11The logo or icon image should be put in a folder named "htdocs" in your project's environment folder. ''Note: in projects created with a Trac version prior to 0.9 you will need to create this folder''.
12
13 '''Note''': you can actually put the logo and icon anywhere on your server (as long as it's accessible through the web server), and use their absolute or server-relative URLs in the configuration.
14
15Now configure the appropriate section of your [wiki:TracIni trac.ini]:
16
17=== Logo
18Change the `src` setting to `site/` followed by the name of your image file. The `width` and `height` settings should be modified to match your image's dimensions. The Trac chrome handler uses "`site/`" for files within the project directory `htdocs`, and "`common/`" for the common `htdocs` directory belonging to a Trac installation. Note that 'site/' is not a placeholder for your project name, it is the literal prefix that should be used. For example, if your project is named 'sandbox', and the image file is 'red_logo.gif' then the 'src' setting would be 'site/red_logo.gif', not 'sandbox/red_logo.gif'.
19
20{{{#!ini
21[header_logo]
22src = site/my_logo.gif
23alt = My Project
24width = 300
25height = 100
26}}}
27
28=== Icon
29Icons are small images displayed by your web browser next to the site's URL and in the `Bookmarks` menu. Icons should be a 32x32 image in `.gif` or `.ico` format. Change the `icon` setting to `site/` followed by the name of your icon file:
30
31{{{#!ini
32[project]
33icon = site/my_icon.ico
34}}}
35
36== Custom Navigation Entries
37The new [mainnav] and [metanav] can now be used to customize the text and link used for the navigation items, or even to disable them, but not for adding new ones.
38
39In the following example, we rename the link to the Wiki start "Home", and hide the "!Help/Guide". We also make the "View Tickets" entry link to a specific report:
40{{{#!ini
41[mainnav]
42wiki.label = Home
43tickets.href = /report/24
44
45[metanav]
46help = disabled
47}}}
48
49See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
50
51== Site Appearance == #SiteAppearance
52
53Trac is using [http://genshi.edgewall.org Genshi] as the templating engine. Say you want to add a link to a custom stylesheet, and then your own header and footer. Save the following content as `site.html` inside your projects `templates/` directory (each Trac project can have their own `site.html`), eg `/path/to/env/templates/site.html`:
54
55{{{#!xml
56<html xmlns="http://www.w3.org/1999/xhtml"
57      xmlns:py="http://genshi.edgewall.org/"
58      py:strip="">
59
60  <!--! Add site-specific style sheet -->
61  <head py:match="head" py:attrs="select('@*')">
62    ${select('*|comment()|text()')}
63    <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
64  </head>
65
66  <body py:match="body" py:attrs="select('@*')">
67    <!--! Add site-specific header -->
68    <div id="siteheader">
69      <!--! Place your header content here... -->
70    </div>
71
72    ${select('*|text()')}
73
74    <!--! Add site-specific footer -->
75    <div id="sitefooter">
76      <!--! Place your footer content here... -->
77    </div>
78  </body>
79</html>
80}}}
81
82Notice that XSLT bears some similarities with Genshi templates. However, there are some Trac specific features, for example the `${href.chrome('site/style.css')}` attribute references `style.css` in the environment's `htdocs/` directory. In a similar fashion `${chrome.htdocs_location}` is used to specify the common `htdocs/` directory belonging to a Trac installation. That latter location can however be overriden using the [[TracIni#trac-section|[trac] htdocs_location]] configuration setting.
83
84`site.html` is one file to contain all your modifications. It usually works using the `py:match` directive (element or attribute), and it allows you to modify the page as it renders. The matches hook onto specific sections depending on what it tries to find and modify them.
85See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
86A `site.html` can contain any number of such `py:match` sections for whatever you need to modify. This is all Genshi, so the [http://genshi.edgewall.org/wiki/Documentation/xml-templates.html docs on the exact syntax] can be found there.
87
88Example snippet of adding introduction text to the new ticket form (but not shown during preview):
89
90{{{#!xml
91<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
92  <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
93    <p>Please make sure to search for existing tickets before reporting a new one!</p>
94  </py:if>
95  ${select('*')}
96</form>
97}}}
98
99This example illustrates a technique of using `req.environ['PATH_INFO']` to limit scope of changes to one view only. For instance, to make changes in `site.html` only for timeline and avoid modifying other sections - use  `req.environ['PATH_INFO'] == '/timeline'` condition in `<py:if>` test.
100
101More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
102
103Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
104
105Note that the `site.html`, despite its name, can be put in a shared templates directory, see the [[TracIni#inherit-section|[inherit] templates_dir]] option. This could provide easier maintainence (and a migration path from 0.10 for larger installations) as one new global `site.html` file can be made to include any existing header, footer and newticket snippets.
106
107== Project List == #ProjectList
108
109You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
110
111The following is the basic template used by Trac to display a list of links to the projects. For projects that could not be loaded, it displays an error message. You can use this as a starting point for your own index template:
112
113{{{#!text/html
114<!DOCTYPE html
115    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
116    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
117<html xmlns="http://www.w3.org/1999/xhtml"
118      xmlns:py="http://genshi.edgewall.org/"
119      xmlns:xi="http://www.w3.org/2001/XInclude">
120  <head>
121    <title>Available Projects</title>
122  </head>
123  <body>
124    <h1>Available Projects</h1>
125    <ul>
126      <li py:for="project in projects" py:choose="">
127        <a py:when="project.href" href="$project.href"
128           title="$project.description">$project.name</a>
129        <py:otherwise>
130          <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
131        </py:otherwise>
132      </li>
133    </ul>
134  </body>
135</html>
136}}}
137
138Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located (pls verify ... not yet changed to 0.11):
139
140For [wiki:TracModWSGI mod_wsgi]:
141{{{#!python
142os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
143}}}
144
145For [wiki:TracFastCgi FastCGI]:
146{{{#!apache
147FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
148              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
149}}}
150
151For [wiki:TracModPython mod_python]:
152{{{#!apache
153PythonOption TracEnvParentDir /parent/dir/of/projects
154PythonOption TracEnvIndexTemplate /path/to/template
155}}}
156
157For [wiki:TracCgi CGI]:
158{{{#!apache
159SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
160}}}
161
162For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
163 - Unix
164   {{{#!sh
165$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
166   }}}
167 - Windows
168   {{{#!sh
169$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
170   }}}
171
172== Project Templates
173
174The appearance of each individual Trac environment, ie instance of a project, can be customized independently of other projects, even those hosted on the same server. The recommended way is to use a `site.html` template (see [#SiteAppearance]) whenever possible. Using `site.html` means changes are made to the original templates as they are rendered, and you should not normally need to redo modifications whenever Trac is upgraded. If you do make a copy of `theme.html` or any other Trac template, you need to migrate your modifiations to the newer version. If not, new Trac features or bug fixes may not work as expected.
175
176With that word of caution, any Trac template may be copied and customized. The default Trac templates are located inside the installed Trac egg (`/usr/lib/pythonVERSION/site-packages/Trac-VERSION.egg/trac/templates, .../trac/ticket/templates, .../trac/wiki/templates, ...`). The [#ProjectList] template file is called `index.html`, while the template responsible for main layout is called `theme.html`. Page assets such as images and CSS style sheets are located in the egg's `trac/htdocs` directory.
177
178However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
179 * For a modification to one project only, copy the template to project `templates` directory.
180 * For a modification shared by several projects, copy the template to a shared location and have each project point to this location using the `[inherit] templates_dir` trac.ini option.
181
182Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
183
184Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
185
186----
187See also TracGuide, TracIni
Note: See TracBrowser for help on using the repository browser.