Changes between Version 1 and Version 2 of TracInterfaceCustomization
- Timestamp:
- Apr 24, 2020, 9:10:26 AM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v1 v2 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. Both of these can be configured with settings in [wiki:TracInitrac.ini].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]. 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 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. 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 Next, configure the appropriate section of your trac.ini: 14 13 15 Now configure the appropriate section of your [wiki:TracIni trac.ini]: 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 16 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'. 19 20 {{{ 17 {{{#!ini 21 18 [header_logo] 22 19 src = site/my_logo.gif … … 26 23 }}} 27 24 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.25 === Icon 26 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 27 31 {{{ 28 {{{#!ini 32 29 [project] 33 30 icon = site/my_icon.ico 34 31 }}} 35 32 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: 33 == Custom Navigation Entries 34 The `[mainnav]` and `[metanav]` sections of trac.ini be used to customize the navigation items' text and link, or even disable them, but not for adding new ones. 37 35 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 {{{ 36 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: 37 {{{#!ini 55 38 [mainnav] 56 39 wiki.label = Home … … 61 44 }}} 62 45 63 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.46 See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation. 64 47 65 == Site Appearance ==#SiteAppearance48 == Site Appearance #SiteAppearance 66 49 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.50 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 51 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 52 {{{#!xml 74 53 <html xmlns="http://www.w3.org/1999/xhtml" 75 54 xmlns:py="http://genshi.edgewall.org/" … … 79 58 <head py:match="head" py:attrs="select('@*')"> 80 59 ${select('*|comment()|text()')} 81 <link rel="stylesheet" type="text/css" 82 href="${href.chrome('site/style.css')}" /> 60 <link rel="stylesheet" href="${href.chrome('site/style.css')}" /> 83 61 </head> 84 62 … … 99 77 }}} 100 78 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 into 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-config|[trac] htdocs_location]] configurationsetting.79 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-htdocs_location-option "[trac] htdocs_location"] setting. 102 80 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. 105 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 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 81 `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 into specific sections. See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`. 82 A `site.html` can contain any number of `py:match` sections. This is all Genshi, so the [http://genshi.edgewall.org/wiki/Documentation/xml-templates.html docs on the exact syntax] can be found there. 108 83 109 84 Example snippet of adding introduction text to the new ticket form (but not shown during preview): … … 111 86 {{{#!xml 112 87 <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)">88 <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)"> 114 89 <p>Please make sure to search for existing tickets before reporting a new one!</p> 115 90 </py:if> … … 118 93 }}} 119 94 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.95 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'` as the condition in a `<py:if>` test. 121 96 122 97 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. … … 124 99 Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss]. 125 100 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 }}} 101 Note that the `site.html`, despite its name, can be put in a shared templates directory, see the [[TracIni#inherit-templates_dir-option|[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 102 138 Also note that the `site.html` (despite its name) can be put in a common 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. 103 == Project List #ProjectList 139 104 140 == Project List == #ProjectList 105 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 141 106 142 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 107 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 108 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 109 {{{#!text/html 148 110 <!DOCTYPE html 149 111 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" … … 170 132 }}} 171 133 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):134 Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located: 173 135 174 136 For [wiki:TracModWSGI mod_wsgi]: 175 {{{ 176 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template '137 {{{#!python 138 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html' 177 139 }}} 178 140 179 For [ wiki:TracFastCgi FastCGI]:180 {{{ 141 For [TracFastCgi FastCGI]: 142 {{{#!apache 181 143 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \ 182 144 -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template 183 145 }}} 184 146 185 For [ wiki:TracModPython mod_python]:186 {{{ 147 For [TracModPython mod_python]: 148 {{{#!apache 187 149 PythonOption TracEnvParentDir /parent/dir/of/projects 188 150 PythonOption TracEnvIndexTemplate /path/to/template 189 151 }}} 190 152 191 For [ wiki:TracCgi CGI]:192 {{{ 153 For [TracCgi CGI]: 154 {{{#!apache 193 155 SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template 194 156 }}} 195 157 196 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 158 For TracStandalone, you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd: 159 - Unix: 160 {{{#!sh 200 161 $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 201 162 }}} 202 - Windows 203 {{{ 204 #!sh 163 - Windows: 164 {{{#!sh 205 165 $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template 206 166 }}} 207 167 208 == Project Templates ==168 == Project Templates 209 169 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.170 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 171 212 With that word of caution, any Trac template may be copied and customized. The default Trac templates are located in side 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.172 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. 213 173 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:174 However, do not edit templates or site resources inside the Trac egg/wheel. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives: 215 175 * 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.inioption.176 * 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. 217 177 218 Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg .178 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. 219 179 220 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.180 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server. 221 181 222 182 ---- 223 See also Trac Guide, TracIni183 See also TracIni, TracNavigation