Changes between Version 5 and Version 6 of Trac Interface Customization


Ignore:
Timestamp:
Jun 10, 2015, 7:03:42 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Trac Interface Customization

    v5 v6  
    1 = Customizing the Trac Interface =
     1= Customizing the Trac Interface
    22[[TracGuideToc]]
    33[[PageOutline]]
    44
    5 == Introduction ==
     5== Introduction
    66This 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.
    77
    8 == Project Logo and Icon ==
     8== Project Logo and Icon
    99The 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].
    1010
    1111The 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''.
    1212
    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.''
     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.
    1414
    1515Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    1616
    17 === Logo ===
     17=== Logo
    1818Change 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'.
    1919
    20 {{{
     20{{{#!ini
    2121[header_logo]
    2222src = site/my_logo.gif
    … …  
    2626}}}
    2727
    28 === Icon ===
     28=== Icon
    2929Icons 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:
    3030
    31 {{{
     31{{{#!ini
    3232[project]
    3333icon = site/my_icon.ico
    3434}}}
    3535
    36 Note 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 IE as well as other browsers, you can store the icon in the document root of the host and then reference it from `trac.ini` as follows:
    37 
    38 {{{
    39 [project]
    40 icon = /favicon.ico
    41 }}}
    42 
    43 If your browser does not show your favicon in the address bar, append a "?" to the file extension:
    44 
    45 {{{
    46 [project]
    47 icon = /favicon.ico?
    48 }}}
    49 
    50 == Custom Navigation Entries ==
     36== Custom Navigation Entries
    5137The 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.
    5238
    5339In 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 {{{
     40{{{#!ini
    5541[mainnav]
    5642wiki.label = Home
    … …  
    6551== Site Appearance == #SiteAppearance
    6652
    67 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}}}:
     53Trac 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`:
    6854
    69 {{{
    70 #!xml
     55{{{#!xml
    7156<html xmlns="http://www.w3.org/1999/xhtml"
    7257      xmlns:py="http://genshi.edgewall.org/"
    … …  
    126111The 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:
    127112
    128 {{{
    129 #!text/html
     113{{{#!text/html
    130114<!DOCTYPE html
    131115    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    … …  
    155139
    156140For [wiki:TracModWSGI mod_wsgi]:
    157 {{{
     141{{{#!python
    158142os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
    159143}}}
    160144
    161145For [wiki:TracFastCgi FastCGI]:
    162 {{{
     146{{{#!apache
    163147FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    164148              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    … …  
    166150
    167151For [wiki:TracModPython mod_python]:
    168 {{{
     152{{{#!apache
    169153PythonOption TracEnvParentDir /parent/dir/of/projects
    170154PythonOption TracEnvIndexTemplate /path/to/template
    … …  
    172156
    173157For [wiki:TracCgi CGI]:
    174 {{{
     158{{{#!apache
    175159SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    176160}}}
    … …  
    178162For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    179163 - Unix
    180    {{{
    181 #!sh
     164   {{{#!sh
    182165$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    183166   }}}
    184167 - Windows
    185    {{{
    186 #!sh
     168   {{{#!sh
    187169$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    188170   }}}
    189171
    190 == Project Templates ==
     172== Project Templates
    191173
    192174The 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.
    193175
    194 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.
     176With 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.
    195177
    196178However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
    197179 * For a modification to one project only, copy the template to project `templates` directory.
    198  * 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.
     180 * 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.
    199181
    200182Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    201183
    202 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.
     184Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
    203185
    204186----