![(please configure [header_logo] section in trac.ini)](https://lpsc.in2p3.fr/trac/chrome/common/logo_LPSC.png){kind=logo}
Changes between Version 11 and Version 12 of TracInterfaceCustomization
- Timestamp:
- 17/07/2015 11:41:28 (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v11 v12 1 = Customizing the Trac Interface = 1 = Customizing the Trac Interface 2 2 3 [[TracGuideToc]] 3 4 [[PageOutline]] 4 5 5 == Introduction == 6 == Introduction 7 6 8 This 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 9 8 == Project Logo and Icon == 10 == Project Logo and Icon 11 9 12 The 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 13 11 14 The 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 15 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.''16 '''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 17 15 18 Now configure the appropriate section of your [wiki:TracIni trac.ini]: 16 19 17 === Logo === 20 === Logo 21 18 22 Change 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 23 20 {{{ 24 {{{#!ini 21 25 [header_logo] 22 26 src = site/my_logo.gif … … 26 30 }}} 27 31 28 === Icon === 32 === Icon 33 29 34 Icons 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 35 31 {{{ 36 {{{#!ini 32 37 [project] 33 38 icon = site/my_icon.ico 34 39 }}} 35 40 36 Note that this icon is ignored by Internet Explorer, which only accepts a file named `favicon.ico` at the root of the host. To make the project icon work in IE as well as other browsers, you can store the icon in the document root of the host and then reference it from `trac.ini` as follows: 37 38 {{{ 39 [project] 40 icon = /favicon.ico 41 }}} 42 43 If your browser does not show your favicon in the address bar, append a "?" to the file extension: 44 45 {{{ 46 [project] 47 icon = /favicon.ico? 48 }}} 49 50 == Custom Navigation Entries == 41 == Custom Navigation Entries 42 51 43 The 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. 52 44 53 45 In 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: 54 {{{ 46 {{{#!ini 55 47 [mainnav] 56 48 wiki.label = Home … … 65 57 == Site Appearance == #SiteAppearance 66 58 67 Trac 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}}}: 68 69 {{{ 70 #!xml 59 Trac 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`: 60 61 {{{#!xml 71 62 <html xmlns="http://www.w3.org/1999/xhtml" 72 63 xmlns:py="http://genshi.edgewall.org/" … … 119 110 120 111 If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can be loaded using a workaround - providing it contains no [trac:ClearSilver] processing. In addition, as only one element can be imported, the content needs some sort of wrapper such as a `<div>` block or other similar parent container. The XInclude namespace must be specified to allow includes, but that can be moved to document root along with the others: 121 {{{ 122 #!xml 112 {{{#!xml 123 113 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')" 124 114 xmlns:xi="http://www.w3.org/2001/XInclude"> … … 138 128 The 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: 139 129 140 {{{ 141 #!text/html 130 {{{#!text/html 142 131 <!DOCTYPE html 143 132 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" … … 167 156 168 157 For [wiki:TracModWSGI mod_wsgi]: 169 {{{ 158 {{{#!python 170 159 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html' 171 160 }}} 172 161 173 162 For [wiki:TracFastCgi FastCGI]: 174 {{{ 163 {{{#!apache 175 164 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \ 176 165 -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template … … 178 167 179 168 For [wiki:TracModPython mod_python]: 180 {{{ 169 {{{#!apache 181 170 PythonOption TracEnvParentDir /parent/dir/of/projects 182 171 PythonOption TracEnvIndexTemplate /path/to/template … … 184 173 185 174 For [wiki:TracCgi CGI]: 186 {{{ 175 {{{#!apache 187 176 SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template 188 177 }}} … … 190 179 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd: 191 180 - Unix 192 {{{ 193 #!sh 181 {{{#!sh 194 182 $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 195 183 }}} 196 184 - Windows 197 {{{ 198 #!sh 185 {{{#!sh 199 186 $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template 200 187 }}} 201 188 202 == Project Templates ==189 == Project Templates 203 190 204 191 The 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. 205 192 206 With 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.193 With 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. 207 194 208 195 However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives: 209 196 * For a modification to one project only, copy the template to project `templates` directory. 210 * 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.197 * 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. 211 198 212 199 Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg. 213 200 214 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.201 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server. 215 202 216 203 ----
