Changes between Version 3 and Version 4 of TracInterfaceCustomization
- Timestamp:
- Apr 28, 2017, 12:06:12 AM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v3 v4 1 1 = Customizing the Trac Interface = 2 2 [[TracGuideToc]] 3 [[PageOutline]] 3 4 4 5 == Introduction == … … 15 16 16 17 === 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 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'. 18 19 19 20 {{{ … … 26 27 27 28 === Icon === 28 Icons should be a 16x16image 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 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. 29 30 30 31 {{{ … … 33 34 }}} 34 35 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 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 37 38 {{{ … … 50 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). 51 52 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 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 54 {{{ 54 55 [mainnav] … … 67 68 68 69 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 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 71 72 {{{ … … 98 99 }}} 99 100 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 find101 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]] configuration setting. 102 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 103 104 and modify them. 104 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`. 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 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 108 109 Example snippet of adding introduction text to the new ticket form (but not shown during preview): 110 111 {{{#!xml 112 112 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"> 113 113 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> … … 118 118 }}} 119 119 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.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. 121 121 122 122 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. … … 136 136 }}} 137 137 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.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. 139 139 140 140 == Project List == #ProjectList … … 172 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): 173 173 174 For [wiki:TracModWSGI mod_wsgi]: 175 {{{ 176 os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template' 177 }}} 178 174 179 For [wiki:TracFastCgi FastCGI]: 175 180 {{{ … … 214 219 215 220 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server. 221 216 222 ---- 217 223 See also TracGuide, TracIni
