Changes between Initial Version and Version 1 of Trac Interface Customization


Ignore:
Timestamp:
Jan 31, 2019, 3:29:20 AM (5 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Trac Interface Customization

    v1 v1  
     1= Customizing the Trac Interface
     2[[TracGuideToc]]
     3[[PageOutline(2-5,Contents,pullout)]]
     4
     5This 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
     8The 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
     10The 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
     12Next, configure the appropriate section of your trac.ini:
     13
     14=== Logo
     15Change 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
     18[header_logo]
     19src = site/my_logo.gif
     20alt = My Project
     21width = 300
     22height = 100
     23}}}
     24
     25=== Icon
     26Icons 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:
     27
     28{{{#!ini
     29[project]
     30icon = site/my_icon.ico
     31}}}
     32
     33== Custom Navigation Entries
     34The `[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.
     35
     36In 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
     38[mainnav]
     39wiki.label = Home
     40tickets.href = /report/24
     41
     42[metanav]
     43help = disabled
     44}}}
     45
     46See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation.
     47
     48== Site Appearance #SiteAppearance
     49
     50Trac 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`:
     51
     52{{{#!xml
     53<html xmlns="http://www.w3.org/1999/xhtml"
     54      xmlns:py="http://genshi.edgewall.org/"
     55      py:strip="">
     56
     57  <!--! Add site-specific style sheet -->
     58  <head py:match="head" py:attrs="select('@*')">
     59    ${select('*|comment()|text()')}
     60    <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
     61  </head>
     62
     63  <body py:match="body" py:attrs="select('@*')">
     64    <!--! Add site-specific header -->
     65    <div id="siteheader">
     66      <!--! Place your header content here... -->
     67    </div>
     68
     69    ${select('*|text()')}
     70
     71    <!--! Add site-specific footer -->
     72    <div id="sitefooter">
     73      <!--! Place your footer content here... -->
     74    </div>
     75  </body>
     76</html>
     77}}}
     78
     79Notice 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.
     80
     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`.
     82A `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.
     83
     84Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     85
     86{{{#!xml
     87<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
     88  <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)">
     89    <p>Please make sure to search for existing tickets before reporting a new one!</p>
     90  </py:if>
     91  ${select('*')}
     92</form>
     93}}}
     94
     95This 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.
     96
     97More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     98
     99Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
     100
     101Note 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.
     102
     103== Project List #ProjectList
     104
     105You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.
     106
     107The 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:
     108
     109{{{#!text/html
     110<!DOCTYPE html
     111    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     112    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     113<html xmlns="http://www.w3.org/1999/xhtml"
     114      xmlns:py="http://genshi.edgewall.org/"
     115      xmlns:xi="http://www.w3.org/2001/XInclude">
     116  <head>
     117    <title>Available Projects</title>
     118  </head>
     119  <body>
     120    <h1>Available Projects</h1>
     121    <ul>
     122      <li py:for="project in projects" py:choose="">
     123        <a py:when="project.href" href="$project.href"
     124           title="$project.description">$project.name</a>
     125        <py:otherwise>
     126          <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
     127        </py:otherwise>
     128      </li>
     129    </ul>
     130  </body>
     131</html>
     132}}}
     133
     134Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located:
     135
     136For [wiki:TracModWSGI mod_wsgi]:
     137{{{#!python
     138os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     139}}}
     140
     141For [TracFastCgi FastCGI]:
     142{{{#!apache
     143FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
     144              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     145}}}
     146
     147For [TracModPython mod_python]:
     148{{{#!apache
     149PythonOption TracEnvParentDir /parent/dir/of/projects
     150PythonOption TracEnvIndexTemplate /path/to/template
     151}}}
     152
     153For [TracCgi CGI]:
     154{{{#!apache
     155SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
     156}}}
     157
     158For 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
     161$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     162   }}}
     163 - Windows:
     164   {{{#!sh
     165$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     166   }}}
     167
     168== Project Templates
     169
     170The 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.
     171
     172With 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.
     173
     174However, do not edit templates or site resources inside the Trac egg/wheel. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
     175 * For a modification to one project only, copy the template to project `templates` directory.
     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.
     177
     178Trac 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.
     179
     180Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
     181
     182----
     183See also TracIni, TracNavigation