Changes between Version 1 and Version 2 of TracInterfaceCustomization
- Timestamp:
- 2017-02-06T16:24:15-04:00 (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v1 v2 1 1 = Customizing the Trac Interface 2 3 2 [[TracGuideToc]] 4 [[PageOutline]] 5 6 == Introduction 3 [[PageOutline(2-5,Contents,pullout)]] 7 4 8 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. 9 6 10 7 == Project Logo and Icon 11 12 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]. 13 9 14 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''. 15 11 16 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. 17 13 18 14 Now configure the appropriate section of your [wiki:TracIni trac.ini]: 19 15 20 16 === 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'. 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'. 23 18 24 19 {{{#!ini … … 31 26 32 27 === Icon 33 34 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: 35 29 … … 40 34 41 35 == Custom Navigation Entries 42 43 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. 44 37 … … 55 48 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms. 56 49 57 == Site Appearance ==#SiteAppearance50 == Site Appearance #SiteAppearance 58 51 59 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`: … … 96 89 {{{#!xml 97 90 <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)">91 <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)"> 99 92 <p>Please make sure to search for existing tickets before reporting a new one!</p> 100 93 </py:if> … … 103 96 }}} 104 97 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.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. 106 99 107 100 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. … … 109 102 Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss]. 110 103 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 113 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')" 114 xmlns:xi="http://www.w3.org/2001/XInclude"> 115 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> 116 <xi:include href="site_newticket.cs"><xi:fallback /></xi:include> 117 </py:if> 118 ${select('*')} 119 </form> 120 }}} 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. 121 105 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. 106 == Project List #ProjectList 123 107 124 == Project List == #ProjectList 125 126 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 108 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 127 109 128 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: … … 153 135 }}} 154 136 155 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: 156 138 157 139 For [wiki:TracModWSGI mod_wsgi]: … … 178 160 179 161 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd: 180 - Unix 162 - Unix: 181 163 {{{#!sh 182 164 $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 183 165 }}} 184 - Windows 166 - Windows: 185 167 {{{#!sh 186 168 $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template … … 189 171 == Project Templates 190 172 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.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. 192 174 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.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. 194 176 195 177 However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
