Changes between Initial Version and Version 1 of TracInterfaceCustomization


Ignore:
Timestamp:
08/07/15 22:11:27 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v1 v1  
     1= Customizing the Trac Interface =
     2[[TracGuideToc]]
     3[[PageOutline]]
     4
     5== Introduction ==
     6This 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.
     7
     8== Project Logo and Icon ==
     9The 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].
     10
     11The 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''.
     12
     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.''
     14
     15Now configure the appropriate section of your [wiki:TracIni trac.ini]:
     16
     17=== Logo ===
     18Change 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'.
     19
     20{{{
     21[header_logo]
     22src = site/my_logo.gif
     23alt = My Project
     24width = 300
     25height = 100
     26}}}
     27
     28=== Icon ===
     29Icons 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:
     30
     31{{{
     32[project]
     33icon = site/my_icon.ico
     34}}}
     35
     36Note 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]
     40icon = /favicon.ico
     41}}}
     42
     43If your browser does not show your favicon in the address bar, append a "?" to the file extension:
     44
     45{{{
     46[project]
     47icon = /favicon.ico?
     48}}}
     49
     50== Custom Navigation Entries ==
     51The 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.
     52
     53In 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{{{
     55[mainnav]
     56wiki.label = Home
     57tickets.href = /report/24
     58
     59[metanav]
     60help = disabled
     61}}}
     62
     63See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
     64
     65== Site Appearance == #SiteAppearance
     66
     67Trac 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}}}:
     68
     69{{{
     70#!xml
     71<html xmlns="http://www.w3.org/1999/xhtml"
     72      xmlns:py="http://genshi.edgewall.org/"
     73      py:strip="">
     74
     75  <!--! Add site-specific style sheet -->
     76  <head py:match="head" py:attrs="select('@*')">
     77    ${select('*|comment()|text()')}
     78    <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
     79  </head>
     80
     81  <body py:match="body" py:attrs="select('@*')">
     82    <!--! Add site-specific header -->
     83    <div id="siteheader">
     84      <!--! Place your header content here... -->
     85    </div>
     86
     87    ${select('*|text()')}
     88
     89    <!--! Add site-specific footer -->
     90    <div id="sitefooter">
     91      <!--! Place your footer content here... -->
     92    </div>
     93  </body>
     94</html>
     95}}}
     96
     97Notice 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.
     98
     99`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.
     100See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
     101A `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.
     102
     103Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     104
     105{{{#!xml
     106<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
     107  <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     108    <p>Please make sure to search for existing tickets before reporting a new one!</p>
     109  </py:if>
     110  ${select('*')}
     111</form>
     112}}}
     113
     114This 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.
     115
     116More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     117
     118Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
     119
     120If 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:
     121{{{
     122#!xml
     123<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
     124        xmlns:xi="http://www.w3.org/2001/XInclude">
     125  <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     126    <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
     127  </py:if>
     128  ${select('*')}
     129</form>
     130}}}
     131
     132Also 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.
     133
     134== Project List == #ProjectList
     135
     136You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
     137
     138The 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:
     139
     140{{{
     141#!text/html
     142<!DOCTYPE html
     143    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     144    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     145<html xmlns="http://www.w3.org/1999/xhtml"
     146      xmlns:py="http://genshi.edgewall.org/"
     147      xmlns:xi="http://www.w3.org/2001/XInclude">
     148  <head>
     149    <title>Available Projects</title>
     150  </head>
     151  <body>
     152    <h1>Available Projects</h1>
     153    <ul>
     154      <li py:for="project in projects" py:choose="">
     155        <a py:when="project.href" href="$project.href"
     156           title="$project.description">$project.name</a>
     157        <py:otherwise>
     158          <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
     159        </py:otherwise>
     160      </li>
     161    </ul>
     162  </body>
     163</html>
     164}}}
     165
     166Once 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):
     167
     168For [wiki:TracModWSGI mod_wsgi]:
     169{{{
     170os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     171}}}
     172
     173For [wiki:TracFastCgi FastCGI]:
     174{{{
     175FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
     176              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     177}}}
     178
     179For [wiki:TracModPython mod_python]:
     180{{{
     181PythonOption TracEnvParentDir /parent/dir/of/projects
     182PythonOption TracEnvIndexTemplate /path/to/template
     183}}}
     184
     185For [wiki:TracCgi CGI]:
     186{{{
     187SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
     188}}}
     189
     190For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
     191 - Unix
     192   {{{
     193#!sh
     194$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     195   }}}
     196 - Windows
     197   {{{
     198#!sh
     199$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     200   }}}
     201
     202== Project Templates ==
     203
     204The 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.
     205
     206With 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.
     207
     208However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
     209 * For a modification to one project only, copy the template to project `templates` directory.
     210 * 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.
     211
     212Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
     213
     214Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.
     215
     216----
     217See also TracGuide, TracIni