Changes between Version 5 and Version 6 of TracInterfaceCustomization


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v5 v6  
    1 = Customizing the Trac Interface
    2 
     1= Customizing the Trac Interface =
    32[[TracGuideToc]]
    43[[PageOutline]]
    54
    6 == Introduction
    7 
    8 This 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 
    12 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].
    13 
    14 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''.
    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.
     5== Introduction ==
     6This 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.
     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.''
    1714
    1815Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    1916
    20 === Logo
    21 
    22 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 `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
     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 actual prefix that should be used (literally). 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{{{
    2521[header_logo]
    2622src = site/my_logo.gif
     
    3026}}}
    3127
    32 === Icon
    33 
    34 Icons 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
     28=== Icon ===
     29Icons should be a 32x32 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.
     30
     31{{{
    3732[project]
    3833icon = site/my_icon.ico
    3934}}}
    4035
    41 == Custom Navigation Entries
    42 
    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 {{{#!ini
     36Note 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:
     37
     38{{{
     39[project]
     40icon = /favicon.ico
     41}}}
     42
     43Should your browser have issues with your favicon showing up in the address bar, you may put a "?" (less the quotation marks) after your favicon 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{{{
    4755[mainnav]
    4856wiki.label = Home
     
    5765== Site Appearance == #SiteAppearance
    5866
    59 Trac 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
     67Trac 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.
     68
     69Say you want to add a link to a custom stylesheet, and then your own
     70header and footer. Save the following content as `site.html` inside your projects `templates/` directory (each Trac project can have their own `site.html`), e.g. {{{/path/to/env/templates/site.html}}}:
     71
     72{{{
     73#!xml
    6274<html xmlns="http://www.w3.org/1999/xhtml"
    6375      xmlns:py="http://genshi.edgewall.org/"
     
    6779  <head py:match="head" py:attrs="select('@*')">
    6880    ${select('*|comment()|text()')}
    69     <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
     81    <link rel="stylesheet" type="text/css"
     82          href="${href.chrome('site/style.css')}" />
    7083  </head>
    7184
     
    8699}}}
    87100
    88 Notice 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.
     101Those who are familiar with XSLT may notice that Genshi templates bear some similarities. However, there are some Trac specific features - for example `${href.chrome('site/style.css')}` attribute references a CSS file placed into 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-config|[trac] htdocs_location]] configuration setting.
     102
     103`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
     104and modify them.
    91105See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
    92106A `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.
     107
    93108
    94109Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     
    109124Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
    110125
    111 If 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
     126If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can actually be loaded by using a workaround - 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:
     127{{{
     128#!xml
    113129<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
    114130        xmlns:xi="http://www.w3.org/2001/XInclude">
     
    120136}}}
    121137
    122 Also 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.
     138Also note that the `site.html` (despite its name) can be put in a common 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.
    123139
    124140== Project List == #ProjectList
     
    126142You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
    127143
    128 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:
    129 
    130 {{{#!text/html
     144The 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.
     145
     146{{{
     147#!text/html
    131148<!DOCTYPE html
    132149    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     
    156173
    157174For [wiki:TracModWSGI mod_wsgi]:
    158 {{{#!python
     175{{{
    159176os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
    160177}}}
    161178
    162179For [wiki:TracFastCgi FastCGI]:
    163 {{{#!apache
     180{{{
    164181FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    165182              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     
    167184
    168185For [wiki:TracModPython mod_python]:
    169 {{{#!apache
     186{{{
    170187PythonOption TracEnvParentDir /parent/dir/of/projects
    171188PythonOption TracEnvIndexTemplate /path/to/template
     
    173190
    174191For [wiki:TracCgi CGI]:
    175 {{{#!apache
     192{{{
    176193SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    177194}}}
     
    179196For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    180197 - Unix
    181    {{{#!sh
     198   {{{
     199#!sh
    182200$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    183201   }}}
    184202 - Windows
    185    {{{#!sh
     203   {{{
     204#!sh
    186205$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    187206   }}}
    188207
    189 == Project Templates
    190 
    191 The 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 
    193 With 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 
    195 However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
     208== Project Templates ==
     209
     210The appearance of each individual Trac environment (that is, instance of a project) can be customized independently of other projects, even those hosted by 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.
     211
     212With 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.
     213
     214However, do not edit templates or site resources inside the Trac egg - installing Trac again can completely delete your modifications. Instead use one of two alternatives:
    196215 * 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.
     216 * 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.
    198217
    199218Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    200219
    201 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
     220Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.
    202221
    203222----