Changes between Initial Version and Version 1 of TracInterfaceCustomization


Ignore:
Timestamp:
2008-03-10T03:35:16Z (17 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInterfaceCustomization

    v1 v1  
     1= Customizing the Trac Interface =
     2[[TracGuideToc]]
     3
     4== Introduction ==
     5This 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.
     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 [wiki:TracIni trac.ini].
     9
     10The 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'')
     11
     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.''
     13
     14Now configure the appropriate section of your [wiki:TracIni trac.ini]:
     15
     16=== Logo ===
     17Change 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
     19{{{
     20[header_logo]
     21src = site/my_logo.gif
     22alt = My Project
     23width = 300
     24height = 100
     25}}}
     26
     27=== Icon ===
     28Icons should be a 16x16 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{{{
     31[project]
     32icon = site/my_icon.ico
     33}}}
     34
     35Note 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{{{
     38[project]
     39icon = /favicon.ico
     40}}}
     41
     42== Custom Navigation Entries ==
     43The new [mainnav] and [metanav] can now be used to customize the text and link used for the navigation items, or even to disable them.
     44
     45In 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 .
     46{{{
     47[mainnav]
     48wiki.label = Home
     49tickets.href = /report/24
     50
     51[metanav]
     52help = disabled
     53}}}
     54
     55
     56== Site Appearance ==
     57
     58Trac 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.
     59
     60Say you want to add a link to a custom stylesheet, and then your own
     61header and footer.  Create a file {{{/path/to/env/templates/site.html}}} or {{{/path/to/inherit/option/templates_dir/site.html}}}, with contents like this:
     62
     63{{{
     64#!xml
     65<html xmlns="http://www.w3.org/1999/xhtml"
     66      xmlns:py="http://genshi.edgewall.org/"
     67      py:strip="">
     68
     69  <!--! Add site-specific style sheet -->
     70  <head py:match="head" py:attrs="select('@*')">
     71    ${select('*')}
     72    <link rel="stylesheet" type="text/css"
     73          href="${href.chrome('site/style.css')}" />
     74  </head>
     75
     76  <body py:match="body" py:attrs="select('@*')">
     77    <!--! Add site-specific header -->
     78    <div id="siteheader">
     79      <!--! Place your header content here... -->
     80    </div>
     81
     82    ${select('*|text()')}
     83
     84    <!--! Add site-specific footer -->
     85    <div id="sitefooter">
     86      <!--! Place your footer content here... -->
     87    </div>
     88  </body>
     89</html>
     90}}}
     91Note that this references your environment's `htdocs/style.css`.
     92
     93Example snippet of adding introduction text to the new ticket form (hide when preview):
     94
     95{{{
     96#!xml
     97<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)">
     99    <p>Please make sure to search for existing tickets before reporting a new one!</p>
     100  </py:if>
     101  ${select('*')}
     102</form>
     103}}}
     104
     105If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can actually be loaded by using a workaroud - 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:
     106{{{
     107#!xml
     108<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
     109        xmlns:xi="http://www.w3.org/2001/XInclude">
     110  <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     111    <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
     112  </py:if>
     113  ${select('*')}
     114</form>
     115}}}
     116
     117Also 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.
     118
     119== Project List ==
     120You can use a custom ClearSilver template to display the list of projects if you are using Trac with multiple projects. 
     121
     122The 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.
     123
     124{{{
     125#!text/html
     126<!DOCTYPE html
     127    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     128    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     129<html xmlns="http://www.w3.org/1999/xhtml"
     130      xmlns:py="http://genshi.edgewall.org/"
     131      xmlns:xi="http://www.w3.org/2001/XInclude">
     132  <head>
     133    <title>Available Projects</title>
     134  </head>
     135  <body>
     136    <h1>Available Projects</h1>
     137    <ul>
     138      <li py:for="project in projects" py:choose="">
     139        <a py:when="project.href" href="$project.href"
     140           title="$project.description">$project.name</a>
     141        <py:otherwise>
     142          <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
     143        </py:otherwise>
     144      </li>
     145    </ul>
     146  </body>
     147</html>
     148}}}
     149
     150Once 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):
     151
     152For [wiki:TracFastCgi FastCGI]:
     153{{{
     154FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
     155              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     156}}}
     157
     158For [wiki:TracModPython mod_python]:
     159{{{
     160PythonOption TracEnvIndexTemplate /path/to/template
     161}}}
     162
     163For [wiki:TracCgi CGI]:
     164{{{
     165SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
     166}}}
     167
     168For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
     169 - Unix
     170   {{{
     171#!sh
     172$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     173   }}}
     174 - Windows
     175   {{{
     176#!sh
     177$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     178   }}}
     179
     180----
     181See also TracGuide, TracIni