Changes between Version 1 and Version 2 of TracInterfaceCustomization


Ignore:
Timestamp:
Jul 2, 2017 12:39:40 PM (5 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v1 v2  
    1 = Customizing the Trac Interface =
     1= Customizing the Trac Interface
    22[[TracGuideToc]]
     3[[PageOutline(2-5,Contents,pullout)]]
    34
    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.
     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.
    66
    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].
     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].
    99
    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'')
     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.
    1111
    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.''
     12Next, configure the appropriate section of your trac.ini:
    1313
    14 Now configure the appropriate section of your [wiki:TracIni trac.ini]:
     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`.
    1516
    16 === Logo ===
    17 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 (the Trac chrome handler uses "`site/`" for files within the project directory `htdocs` and "`common/`" for the common ones).
    18 
    19 {{{
     17{{{#!ini
    2018[header_logo]
    2119src = site/my_logo.gif
     
    2523}}}
    2624
    27 === Icon ===
    28 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.
     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:
    2927
    30 {{{
     28{{{#!ini
    3129[project]
    3230icon = site/my_icon.ico
    3331}}}
    3432
    35 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:
     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.
    3635
    37 {{{
    38 [project]
    39 icon = /favicon.ico
    40 }}}
    41 
    42 == Custom Navigation Entries ==
    43 The 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 
    45 In 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 {{{
     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
    4738[mainnav]
    4839wiki.label = Home
     
    5344}}}
    5445
    55 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
     46See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation.
    5647
    57 == Site Appearance ==
     48== Site Appearance #SiteAppearance
    5849
    59 Trac 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.
     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`:
    6051
    61 Say you want to add a link to a custom stylesheet, and then your own
    62 header and footer.  Create a file {{{/path/to/env/templates/site.html}}} or {{{/path/to/inherit/option/templates_dir/site.html}}}, with contents like this:
    63 
    64 {{{
    65 #!xml
     52{{{#!xml
    6653<html xmlns="http://www.w3.org/1999/xhtml"
    6754      xmlns:py="http://genshi.edgewall.org/"
     
    7158  <head py:match="head" py:attrs="select('@*')">
    7259    ${select('*|comment()|text()')}
    73     <link rel="stylesheet" type="text/css"
    74           href="${href.chrome('site/style.css')}" />
     60    <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
    7561  </head>
    7662
     
    9076</html>
    9177}}}
    92 Note that this references your environment's `htdocs/style.css`.
    9378
    94 Example snippet of adding introduction text to the new ticket form (hide when preview):
     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.
    9580
    96 {{{
    97 #!xml
     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
    9887<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
    99   <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     88  <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)">
    10089    <p>Please make sure to search for existing tickets before reporting a new one!</p>
    10190  </py:if>
     
    10493}}}
    10594
    106 If 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:
    107 {{{
    108 #!xml
    109 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
    110         xmlns:xi="http://www.w3.org/2001/XInclude">
    111   <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
    112     <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
    113   </py:if>
    114   ${select('*')}
    115 </form>
    116 }}}
     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.
    11796
    118 Also 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.
     97More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
    11998
    120 == Project List ==
    121 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
     99Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
    122100
    123 The 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.
     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.
    124102
    125 {{{
    126 #!text/html
     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
    127110<!DOCTYPE html
    128111    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     
    149132}}}
    150133
    151 Once 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):
     134Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located:
    152135
    153 For [wiki:TracFastCgi FastCGI]:
    154 {{{
     136For [wiki:TracModWSGI mod_wsgi]:
     137{{{#!python
     138os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     139}}}
     140
     141For [TracFastCgi FastCGI]:
     142{{{#!apache
    155143FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    156144              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    157145}}}
    158146
    159 For [wiki:TracModPython mod_python]:
    160 {{{
     147For [TracModPython mod_python]:
     148{{{#!apache
     149PythonOption TracEnvParentDir /parent/dir/of/projects
    161150PythonOption TracEnvIndexTemplate /path/to/template
    162151}}}
    163152
    164 For [wiki:TracCgi CGI]:
    165 {{{
     153For [TracCgi CGI]:
     154{{{#!apache
    166155SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    167156}}}
    168157
    169 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    170  - Unix
    171    {{{
    172 #!sh
     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
    173161$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    174162   }}}
    175  - Windows
    176    {{{
    177 #!sh
     163 - Windows:
     164   {{{#!sh
    178165$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    179166   }}}
    180167
     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
    181182----
    182 See also TracGuide, TracIni
     183See also TracIni, TracNavigation