| 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.'' |
| 13 | | |
| 14 | | Now configure the appropriate section of your [wiki:TracIni trac.ini]: |
| 15 | | |
| 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). |
| 18 | | |
| 19 | | {{{ |
| | 3 | [[PageOutline(2-5,Contents,pullout)]] |
| | 4 | |
| | 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. |
| | 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 [TracIni#project-section trac.ini]. |
| | 9 | |
| | 10 | The logo or icon image should be put your environment's `htdocs` directory. 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. |
| | 11 | |
| | 12 | Next, configure the appropriate section of your trac.ini: |
| | 13 | |
| | 14 | === Logo |
| | 15 | 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. 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 | |
| | 17 | {{{#!ini |
| 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 | | == Custom Navigation Entries == |
| 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. |
| 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 | | {{{ |
| | 33 | == Custom Navigation Entries |
| | 34 | The `[mainnav]` and `[metanav]` sections of trac.ini be used to customize the navigation entries, disable them and even add new ones. |
| | 35 | |
| | 36 | In the following example, we: |
| | 37 | * rename the link to WikiStart to be //Home// |
| | 38 | * hide the ''About'' entry |
| | 39 | * make the //View Tickets// entry link to a specific report |
| | 40 | * add a //Builds// entry that links to an external build system |
| | 41 | * move the //Admin// entry to the meta navigation bar |
| | 42 | {{{#!ini |
| 52 | | help = disabled |
| 53 | | }}} |
| 54 | | |
| 55 | | |
| 56 | | == Site Appearance == |
| 57 | | |
| 58 | | 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. |
| 59 | | |
| 60 | | Say you want to add a link to a custom stylesheet, and then your own |
| 61 | | header and footer. Create a file {{{/path/to/env/templates/site.html}}} or {{{/path/to/inherit/option/templates_dir/site.html}}}, with contents like this: |
| 62 | | |
| 63 | | {{{ |
| 64 | | #!xml |
| 65 | | <html xmlns="http://www.w3.org/1999/xhtml" |
| 66 | | xmlns:py="http://genshi.edgewall.org/" |
| 67 | | py:strip=""> |
| 68 | | |
| 69 | | <!--! Add site-specific style sheet --> |
| 70 | | <head py:match="head" py:attrs="select('@*')"> |
| 71 | | ${select('*')} |
| 72 | | <link rel="stylesheet" type="text/css" |
| 73 | | href="${href.chrome('site/style.css')}" /> |
| 74 | | </head> |
| 75 | | |
| 76 | | <body py:match="body" py:attrs="select('@*')"> |
| 77 | | <!--! Add site-specific header --> |
| | 48 | about = disabled |
| | 49 | builds = enabled |
| | 50 | builds.href = https://travis-ci.org/edgewall/trac |
| | 51 | admin = enabled |
| | 52 | }}} |
| | 53 | |
| | 54 | See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation. |
| | 55 | |
| | 56 | == Site Appearance |
| | 57 | |
| | 58 | Trac is using [http://jinja.pocoo.org/ Jinja2] as the templating engine. |
| | 59 | |
| | 60 | We have put in place a number of "placeholder" in the form of "include" directives. These files don't need to exist, but if they do, their content will be processed by Jinja2 as well. As such, they can make use of other "include" directives, or any other feature of Jinja2 to generate dynamic content. |
| | 61 | |
| | 62 | There are three such placeholder templates: |
| | 63 | - `site_head.html`, which can be used to add content inside the generated `<head>` element |
| | 64 | - `site_header.html`, which can be used to **prepend** content inside the generated `<body>` element, before the standard content generated by Trac |
| | 65 | - `site_footer.html`, which can be used to **append** content inside the generated `<body>` element, after the standard content generated by Trac |
| | 66 | |
| | 67 | Say you want to add a link to a custom stylesheet, and then your own header and footer. Save the following content as `site_head.html`, `site_header.html` and `site_footer.html` inside your projects `templates/` directory (each Trac project can have their own "placeholder" files) e.g. `/path/to/env/templates/site_head.html`: |
| | 68 | |
| | 69 | `site_head.html`: |
| | 70 | {{{#!xml |
| | 71 | <!-- site_head.html: Add site-specific style sheet --> |
| | 72 | <link rel="stylesheet" href="${href.chrome('site/style.css')}" /> |
| | 73 | <!-- /site_head.html --> |
| | 74 | }}} |
| | 75 | |
| | 76 | `site_header.html`: |
| | 77 | {{{#!xml |
| | 78 | <!-- site_header.html: Add site-specific header --> |
| 88 | | </body> |
| 89 | | </html> |
| 90 | | }}} |
| 91 | | Note that this references your environment's `htdocs/style.css`. |
| 92 | | |
| 93 | | Example snippet of adding introduction text to the new ticket form (hide when preview): |
| 94 | | |
| 95 | | {{{ |
| 96 | | #!xml |
| 97 | | <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"> |
| 98 | | <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> |
| 99 | | <p>Please make sure to search for existing tickets before reporting a new one!</p> |
| 100 | | </py:if> |
| 101 | | ${select('*')} |
| 102 | | </form> |
| 103 | | }}} |
| 104 | | |
| 105 | | If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can actually be loaded by using a workaroud - 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: |
| 106 | | {{{ |
| 107 | | #!xml |
| 108 | | <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')" |
| 109 | | xmlns:xi="http://www.w3.org/2001/XInclude"> |
| 110 | | <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> |
| 111 | | <xi:include href="site_newticket.cs"><xi:fallback /></xi:include> |
| 112 | | </py:if> |
| 113 | | ${select('*')} |
| 114 | | </form> |
| 115 | | }}} |
| 116 | | |
| 117 | | 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. |
| 118 | | |
| 119 | | == Project List == |
| 120 | | You can use a custom ClearSilver template to display the list of projects if you are using Trac with multiple projects. |
| 121 | | |
| 122 | | 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. |
| 123 | | |
| 124 | | {{{ |
| 125 | | #!text/html |
| | 91 | <!-- /site_footer.html --> |
| | 92 | }}} |
| | 93 | |
| | 94 | Notice that as Jinja2 is mostly content agnostic, you are free to open some `<div>` element in the `site_header.html` file and only close it in `site_footer.html` file. |
| | 95 | Besides, as in any other Trac Jinja2 template, you can use 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 overridden using the [TracIni#trac-htdocs_location-option "[trac] htdocs_location"] setting. |
| | 96 | |
| | 97 | Example snippet of adding introduction text to the new ticket form (but not shown during preview): |
| | 98 | |
| | 99 | - first we need to introduce the extra "content" of this notice, if it's appropriate for the request. For that, we add this snippet in the `site_footer.html` placeholder file: |
| | 100 | {{{#!xml |
| | 101 | # if req.path_info == '/newticket' and 'preview' not in req.args: |
| | 102 | <p id="ntg">Please make sure to search for existing tickets before reporting a new one!</p> |
| | 103 | # endif |
| | 104 | }}} |
| | 105 | - second, we need to dynamically alter the rest of the content in order to position that notice at the desired location. For that, we add this snippet to the `site_head.html` placeholder file: |
| | 106 | |
| | 107 | {{{#!xml |
| | 108 | <script> |
| | 109 | jQuery(function($) { |
| | 110 | var $ntg = $("#newticketguide"); |
| | 111 | if ($ntg.length) |
| | 112 | $("#propertyform").prepend($ntg.detach()); |
| | 113 | }); |
| | 114 | </script> |
| | 115 | }}} |
| | 116 | |
| | 117 | This example illustrates a technique of using `req.path_info` to limit scope of changes to one view only. For instance, to make changes only for timeline and avoid modifying other sections, use `req.path_info == '/timeline'` as the condition in a `# if` test. |
| | 118 | |
| | 119 | More examples snippets for placeholder files can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. |
| | 120 | |
| | 121 | Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss]. |
| | 122 | |
| | 123 | === Sharing Templates in Multiple Environments |
| | 124 | |
| | 125 | The `site_*.html` templates, despite their name, can be put in a shared templates directory, see the [[TracIni#inherit-templates_dir-option|[inherit] templates_dir]] option. This could provide easier maintenance, as global `site_head.html`, `site_header.html` and `site_footer.html` files can be made to `# include` any other local existing header, footer and newticket snippets. |
| | 126 | |
| | 127 | == Project List #ProjectList |
| | 128 | |
| | 129 | You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. |
| | 130 | |
| | 131 | 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: |
| | 132 | |
| | 133 | FIXME |
| | 134 | |
| | 135 | {{{#!text/html |
| | 194 | == Project Templates |
| | 195 | |
| | 196 | 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 `site_{head,header,footer}.html` templates whenever possible, see [#SiteAppearance]. Using `site_{head,header,footer}.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 modifications to the newer version. If not, new Trac features or bug fixes may not work as expected. |
| | 197 | |
| | 198 | With that word of caution, any Trac template may be copied and customized. The default Trac templates are located in the Trac egg or wheel, 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 or wheel's `trac/htdocs` directory. |
| | 199 | |
| | 200 | However, do not edit templates or site resources inside the Trac egg/wheel. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives: |
| | 201 | * For a modification to one project only, copy the template to project `templates` directory. |
| | 202 | * For a modification shared by several projects, copy the template to a shared location and have each project point to this location using the [[TracIni#inherit-templates_dir-option|[inherit] templates_dir]] option. |
| | 203 | |
| | 204 | Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg or wheel. |
| | 205 | |
| | 206 | Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server. |
| | 207 | |
