Changes between Version 3 and Version 4 of TracInterfaceCustomization
- Timestamp:
- Mar 23, 2016, 2:54:49 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v3 v4 1 = Customizing the Trac Interface = 1 = Customizing the Trac Interface 2 2 3 [[TracGuideToc]] 3 4 == Introduction == 5 This page is meant to give users suggestions on how they can customize the look of Trac. Topics on this page cover editing the HTML templates and CSS files, but not the program code itself. The topics are intended to 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. 6 7 == Project Logo and Icon == 8 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]. 9 10 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'') 11 12 ''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.'' 4 [[PageOutline]] 5 6 == Introduction 7 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. 9 10 == Project Logo and Icon 11 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]. 13 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''. 15 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. 13 17 14 18 Now configure the appropriate section of your [wiki:TracIni trac.ini]: 15 19 16 === Logo === 17 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 ones). Note that 'site/' is not a placeholder for your project name, it is the actual prefix that should be used (literally). 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'. 18 19 {{{ 20 === Logo 21 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'. 23 24 {{{#!ini 20 25 [header_logo] 21 26 src = site/my_logo.gif … … 25 30 }}} 26 31 27 === Icon === 28 Icons should be a 16x16 image in `.gif` or `.ico` format. Change the `icon` setting to `site/` followed by the name of your icon file. Icons will typically be displayed by your web browser next to the site's URL and in the `Bookmarks` menu. 29 30 {{{ 32 === Icon 33 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: 35 36 {{{#!ini 31 37 [project] 32 38 icon = site/my_icon.ico 33 39 }}} 34 40 35 Note though 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 both IE and other browsers, you can store the icon in the document root of the host, and reference it from ``trac.ini`` as follows: 36 37 {{{ 38 [project] 39 icon = /favicon.ico 40 }}} 41 42 Should your browser have issues with your favicon showing up in the address bar, you may put a "?" (less the quotation marks) after your favicon file extension. 43 44 {{{ 45 [project] 46 icon = /favicon.ico? 47 }}} 48 49 == Custom Navigation Entries == 50 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). 51 52 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 . 53 {{{ 41 == Custom Navigation Entries 42 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. 44 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: 46 {{{#!ini 54 47 [mainnav] 55 48 wiki.label = Home … … 64 57 == Site Appearance == #SiteAppearance 65 58 66 Trac is using [http://genshi.edgewall.org Genshi] as the templating engine. Documentation is yet to be written, in the meantime the following tip should work. 67 68 Say you want to add a link to a custom stylesheet, and then your own 69 header and footer. Save the following content as 'site.html' inside your projects templates directory (each Trac project can have their own site.html), e.g. {{{/path/to/env/templates/site.html}}}: 70 71 {{{ 72 #!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 73 62 <html xmlns="http://www.w3.org/1999/xhtml" 74 63 xmlns:py="http://genshi.edgewall.org/" … … 78 67 <head py:match="head" py:attrs="select('@*')"> 79 68 ${select('*|comment()|text()')} 80 <link rel="stylesheet" type="text/css" 81 href="${href.chrome('site/style.css')}" /> 69 <link rel="stylesheet" href="${href.chrome('site/style.css')}" /> 82 70 </head> 83 71 … … 98 86 }}} 99 87 100 Those who are familiar with XSLT may notice that Genshi templates bear some similarities. However, there are some Trac specific features - for example '''${href.chrome('site/style.css')}''' attribute references template placed into environment's ''htdocs/'' In a similar fashion '''${chrome.htdocs_location}''' is used to specify common ''htdocs/'' directory from Trac installation. 101 102 `site.html` is one file to contain all your modifications. It usually works by the py:match (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 103 and modify them. 88 Notice 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. 89 90 `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. 104 91 See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`. 105 A site.html can contain any number of such py:match sections for whatever you need to modify. This is all [http://genshi.edgewall.org/ Genshi], so the docs on the exact syntax can be found there. 106 107 108 Example snippet of adding introduction text to the new ticket form (hide when preview): 109 110 {{{ 111 #!xml 92 A `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. 93 94 Example snippet of adding introduction text to the new ticket form (but not shown during preview): 95 96 {{{#!xml 112 97 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"> 113 98 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> … … 118 103 }}} 119 104 120 This 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.105 This 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. 121 106 122 107 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. … … 124 109 Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss]. 125 110 126 If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can actually be loaded by using a workaround - providing it contains no 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: 127 {{{ 128 #!xml 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: 112 {{{#!xml 129 113 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')" 130 114 xmlns:xi="http://www.w3.org/2001/XInclude"> … … 136 120 }}} 137 121 138 Also note that the `site.html` (despite its name) can be put in a common templates directory - see the `[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.122 Also note 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. 139 123 140 124 == Project List == #ProjectList … … 142 126 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 143 127 144 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. 145 146 {{{ 147 #!text/html 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: 129 130 {{{#!text/html 148 131 <!DOCTYPE html 149 132 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" … … 173 156 174 157 For [wiki:TracModWSGI mod_wsgi]: 175 {{{ 176 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template '158 {{{#!python 159 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html' 177 160 }}} 178 161 179 162 For [wiki:TracFastCgi FastCGI]: 180 {{{ 163 {{{#!apache 181 164 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \ 182 165 -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template … … 184 167 185 168 For [wiki:TracModPython mod_python]: 186 {{{ 169 {{{#!apache 187 170 PythonOption TracEnvParentDir /parent/dir/of/projects 188 171 PythonOption TracEnvIndexTemplate /path/to/template … … 190 173 191 174 For [wiki:TracCgi CGI]: 192 {{{ 175 {{{#!apache 193 176 SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template 194 177 }}} … … 196 179 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd: 197 180 - Unix 198 {{{ 199 #!sh 181 {{{#!sh 200 182 $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 201 183 }}} 202 184 - Windows 203 {{{ 204 #!sh 185 {{{#!sh 205 186 $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template 206 187 }}} 207 188 208 == Project Templates ==209 210 The appearance of each individual Trac environment (that is, instance of a project) can be customized independently of other projects, even those hosted by 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.211 212 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.213 214 However, do not edit templates or site resources inside the Trac egg - installing Trac again can completely delete your modifications. Instead use one of twoalternatives:189 == Project Templates 190 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. 192 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. 194 195 However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives: 215 196 * For a modification to one project only, copy the template to project `templates` directory. 216 * 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. 217 198 218 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. 219 200 220 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. 221 202 222 203 ----