![(please configure the [header_logo] section in trac.ini)](/p/clust/chrome/site/your_project_logo.png){kind=logo}
Changes between Version 3 and Version 4 of TracInterfaceCustomization
- Timestamp:
- Aug 13, 2018, 11:36:48 AM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v3 v4 1 = Customizing the Trac Interface =1 = Customizing the Trac Interface 2 2 [[TracGuideToc]] 3 [[PageOutline ]]3 [[PageOutline(2-5,Contents,pullout)]] 4 4 5 == Introduction == 6 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. 5 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 6 8 == Project Logo and Icon ==9 The easiest parts of the Trac interface to customize are the logo and the site icon. 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]. 10 9 11 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'')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''. 12 11 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.'' 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. 14 13 15 14 Now configure the appropriate section of your [wiki:TracIni trac.ini]: 16 15 17 === Logo ===18 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 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'.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 `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 18 20 {{{ 19 {{{#!ini 21 20 [header_logo] 22 21 src = site/my_logo.gif … … 26 25 }}} 27 26 28 === Icon ===29 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. Icons will typically be displayed by your web browser next to the site's URL and in the `Bookmarks` menu.27 === Icon 28 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 29 31 {{{ 30 {{{#!ini 32 31 [project] 33 32 icon = site/my_icon.ico 34 33 }}} 35 34 36 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: 35 == Custom Navigation Entries 36 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. 37 37 38 {{{ 39 [project] 40 icon = /favicon.ico 41 }}} 42 43 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. 44 45 {{{ 46 [project] 47 icon = /favicon.ico? 48 }}} 49 50 == Custom Navigation Entries == 51 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 53 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 {{{ 38 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: 39 {{{#!ini 55 40 [mainnav] 56 41 wiki.label = Home … … 63 48 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms. 64 49 65 == Site Appearance ==#SiteAppearance50 == Site Appearance #SiteAppearance 66 51 67 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.52 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 53 69 Say you want to add a link to a custom stylesheet, and then your own 70 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}}}: 71 72 {{{ 73 #!xml 54 {{{#!xml 74 55 <html xmlns="http://www.w3.org/1999/xhtml" 75 56 xmlns:py="http://genshi.edgewall.org/" … … 79 60 <head py:match="head" py:attrs="select('@*')"> 80 61 ${select('*|comment()|text()')} 81 <link rel="stylesheet" type="text/css" 82 href="${href.chrome('site/style.css')}" /> 62 <link rel="stylesheet" href="${href.chrome('site/style.css')}" /> 83 63 </head> 84 64 … … 99 79 }}} 100 80 101 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 a CSS file placed intoenvironment'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.81 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. 102 82 103 `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 104 and modify them. 83 `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. 105 84 See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`. 106 85 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. 107 108 86 109 87 Example snippet of adding introduction text to the new ticket form (but not shown during preview): … … 111 89 {{{#!xml 112 90 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"> 113 <py:if test="req. environ['PATH_INFO']== '/newticket' and (not 'preview' in req.args)">91 <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)"> 114 92 <p>Please make sure to search for existing tickets before reporting a new one!</p> 115 93 </py:if> … … 118 96 }}} 119 97 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.98 This example illustrates a technique of using `req.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.path_info == '/timeline'` condition in `<py:if>` test. 121 99 122 100 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. … … 124 102 Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss]. 125 103 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 129 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')" 130 xmlns:xi="http://www.w3.org/2001/XInclude"> 131 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> 132 <xi:include href="site_newticket.cs"><xi:fallback /></xi:include> 133 </py:if> 134 ${select('*')} 135 </form> 136 }}} 104 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 as one new global `site.html` file can be made to include any existing header, footer and newticket snippets. 137 105 138 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. 106 == Project List #ProjectList 139 107 140 == Project List == #ProjectList 108 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 141 109 142 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 110 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: 143 111 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 112 {{{#!text/html 148 113 <!DOCTYPE html 149 114 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" … … 170 135 }}} 171 136 172 Once 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):137 Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located: 173 138 174 139 For [wiki:TracModWSGI mod_wsgi]: 175 {{{ 140 {{{#!python 176 141 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html' 177 142 }}} 178 143 179 144 For [wiki:TracFastCgi FastCGI]: 180 {{{ 145 {{{#!apache 181 146 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \ 182 147 -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template … … 184 149 185 150 For [wiki:TracModPython mod_python]: 186 {{{ 151 {{{#!apache 187 152 PythonOption TracEnvParentDir /parent/dir/of/projects 188 153 PythonOption TracEnvIndexTemplate /path/to/template … … 190 155 191 156 For [wiki:TracCgi CGI]: 192 {{{ 157 {{{#!apache 193 158 SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template 194 159 }}} 195 160 196 161 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd: 197 - Unix 198 {{{ 199 #!sh 162 - Unix: 163 {{{#!sh 200 164 $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 201 165 }}} 202 - Windows 203 {{{ 204 #!sh 166 - Windows: 167 {{{#!sh 205 168 $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template 206 169 }}} 207 170 208 == Project Templates ==171 == Project Templates 209 172 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.173 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 whenever possible, see [#SiteAppearance]. 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 174 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.175 With that word of caution, any Trac template may be copied and customized. The default Trac templates are located inside the installed Trac egg, such as `/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 176 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:177 However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives: 215 178 * 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.179 * 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 180 218 181 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 182 220 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.183 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server. 221 184 222 185 ----
