Edgewall Software

Changes between Version 1 and Version 2 of Trac Interface Customization


Ignore:
Timestamp:
Dec 10, 2015 6:49:23 AM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Trac Interface Customization

    v1 v2  
    1 = Customizing the Trac Interface =
     1= Customizing the Trac Interface
     2
    23[[TracGuideToc]]
    3 
    4 == Introduction ==
    5 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.
    6 
    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 [wiki:TracIni trac.ini].
    9 
    10 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'')
     4[[PageOutline]]
     5
     6== Introduction
     7
     8This 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.
     9
     10== Project Logo and Icon
     11
     12The 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].
     13
     14The 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''.
     15
     16 '''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.
    1117
    1218Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    1319
    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.
    16 
    17 {{{
     20=== Logo
     21
     22Change 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'.
     23
     24{{{#!ini
    1825[header_logo]
    1926src = site/my_logo.gif
     
    2330}}}
    2431
    25 === Icon ===
    26 Icons 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.
    27 
    28 {{{
     32=== Icon
     33
     34Icons 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:
     35
     36{{{#!ini
    2937[project]
    3038icon = site/my_icon.ico
    3139}}}
    3240
    33 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:
    34 
    35 {{{
    36 [project]
    37 icon = /favicon.ico
    38 }}}
    39 
    40 == Site Header & Footer ==
    41 In the environment folder for each Trac project there should be a directory called {{{templates}}}.  This folder contains files {{{site_header.cs}}} and {{{site_footer.cs}}}.  Users can customize their Trac site by adding the required HTML markup to these files.  The content of these two files will be placed immediately following the opening {{{<body>}}} tag and immediately preceding the closing {{{</body>}}} tag of each page in the site, respectively.
    42 
    43 These files may contain static HTML, though if users desire to have dynamically generated content they can make use of the [http://www.clearsilver.net/ ClearSilver] templating language from within the pages as well. When you need to see what variables are available to the template, append the query string `?hdfdump=1` to the URL of your Trac site. This will display a structured view of the template data.
    44 
    45 == Site CSS ==
    46 The primary means to adjust the layout of a Trac site is by add [http://www.w3.org/TR/REC-CSS2/ CSS] style rules that overlay the default rules. This is best done by editing the `site_css.cs` file in the enviroment's `templates` directory. The content of that template gets inserted into a `<style type="text/css></style>` element on every HTML page generated by Trac.
    47 
    48 While you can add your custom style rules directory to the `site_css.cs` file, it is recommended that you simply reference an external style sheet, thereby enabling browsers to cache the CSS file instead of transmitting the rules with every response.
    49 
    50 The following example would import a style sheet located in the `style` root directory of your host:
    51 {{{
    52 @import url(/style/mytrac.css);
    53 }}}
    54 
    55 You can use a !ClearSilver variable to reference a style sheet stored in the project environment's `htdocs` directory:
    56 {{{
    57 @import url(<?cs var:chrome.href ?>/site/style.css);
    58 }}}
    59 
    60 == Main Templates ==
    61 
    62 It is also possible to use your own modified versions of the Trac [http://www.clearsilver.net/ ClearSilver] templates. Note though that this technique is not recommended because it makes upgrading Trac rather problematic: there are unfortunately several dependencies between the templates and the application code, such as the name of form fields and the structure of the template data, and these are likely to change between different versions of Trac.
    63 
    64 If you absolutely need to use modified templates, copy the template files from the default templates directory (usually in found in `$prefix/share/trac/templates`) into the `templates` directory of the project environment. Then modify those copies to get the desired results.
    65 
     41== Custom Navigation Entries
     42
     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, but not for adding new ones.
     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{{{#!ini
     47[mainnav]
     48wiki.label = Home
     49tickets.href = /report/24
     50
     51[metanav]
     52help = disabled
     53}}}
     54
     55See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
     56
     57== Site Appearance == #SiteAppearance
     58
     59Trac 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`:
     60
     61{{{#!xml
     62<html xmlns="http://www.w3.org/1999/xhtml"
     63      xmlns:py="http://genshi.edgewall.org/"
     64      py:strip="">
     65
     66  <!--! Add site-specific style sheet -->
     67  <head py:match="head" py:attrs="select('@*')">
     68    ${select('*|comment()|text()')}
     69    <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
     70  </head>
     71
     72  <body py:match="body" py:attrs="select('@*')">
     73    <!--! Add site-specific header -->
     74    <div id="siteheader">
     75      <!--! Place your header content here... -->
     76    </div>
     77
     78    ${select('*|text()')}
     79
     80    <!--! Add site-specific footer -->
     81    <div id="sitefooter">
     82      <!--! Place your footer content here... -->
     83    </div>
     84  </body>
     85</html>
     86}}}
     87
     88Notice 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-section|[trac] htdocs_location]] configuration setting.
     89
     90`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 and modify them.
     91See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
     92A `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.
     93
     94Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     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
     105This 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.
     106
     107More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     108
     109Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
     110
     111If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can be loaded using a workaround - providing it contains no [trac: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:
     112{{{#!xml
     113<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
     114        xmlns:xi="http://www.w3.org/2001/XInclude">
     115  <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     116    <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
     117  </py:if>
     118  ${select('*')}
     119</form>
     120}}}
     121
     122Also note that the `site.html`, despite its name, can be put in a shared 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.
     123
     124== Project List == #ProjectList
     125
     126You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
     127
     128The 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:
     129
     130{{{#!text/html
     131<!DOCTYPE html
     132    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     133    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     134<html xmlns="http://www.w3.org/1999/xhtml"
     135      xmlns:py="http://genshi.edgewall.org/"
     136      xmlns:xi="http://www.w3.org/2001/XInclude">
     137  <head>
     138    <title>Available Projects</title>
     139  </head>
     140  <body>
     141    <h1>Available Projects</h1>
     142    <ul>
     143      <li py:for="project in projects" py:choose="">
     144        <a py:when="project.href" href="$project.href"
     145           title="$project.description">$project.name</a>
     146        <py:otherwise>
     147          <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
     148        </py:otherwise>
     149      </li>
     150    </ul>
     151  </body>
     152</html>
     153}}}
     154
     155Once 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):
     156
     157For [wiki:TracModWSGI mod_wsgi]:
     158{{{#!python
     159os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     160}}}
     161
     162For [wiki:TracFastCgi FastCGI]:
     163{{{#!apache
     164FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
     165              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     166}}}
     167
     168For [wiki:TracModPython mod_python]:
     169{{{#!apache
     170PythonOption TracEnvParentDir /parent/dir/of/projects
     171PythonOption TracEnvIndexTemplate /path/to/template
     172}}}
     173
     174For [wiki:TracCgi CGI]:
     175{{{#!apache
     176SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
     177}}}
     178
     179For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
     180 - Unix
     181   {{{#!sh
     182$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     183   }}}
     184 - Windows
     185   {{{#!sh
     186$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     187   }}}
     188
     189== Project Templates
     190
     191The 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.
     192
     193With 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.
     194
     195However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
     196 * For a modification to one project only, copy the template to project `templates` directory.
     197 * 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.
     198
     199Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
     200
     201Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
    66202
    67203----