Changes between Version 6 and Version 7 of TracInterfaceCustomization


Ignore:
Timestamp:
03/07/18 16:17:30 (17 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v6 v7  
    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'')
    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.''
     4[[PageOutline(2-5,Contents,pullout)]]
     5
     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
     9
     10The 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].
     11
     12The 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''.
     13
     14'''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.
    1315
    1416Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    1517
    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 {{{
     18=== Logo
     19
     20Change 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'.
     21
     22{{{#!ini
    2023[header_logo]
    2124src = site/my_logo.gif
     
    2528}}}
    2629
    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.
    29 
    30 {{{
     30=== Icon
     31
     32Icons 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:
     33
     34{{{#!ini
    3135[project]
    3236icon = site/my_icon.ico
    3337}}}
    3438
    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:
    36 
    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 {{{
     39== Custom Navigation Entries
     40
     41The 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.
     42
     43In 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:
     44{{{#!ini
    4745[mainnav]
    4846wiki.label = Home
     
    5553See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
    5654
    57 == Site Appearance == #SiteAppearance
    58 
    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.
    60 
    61 Say you want to add a link to a custom stylesheet, and then your own
    62 header 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. {{{
    63 /path/to/env/templates/site.html
    64 }}}:
    65 
    66 {{{
    67 #!xml
     55== Site Appearance #SiteAppearance
     56
     57Trac 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`:
     58
     59{{{#!xml
    6860<html xmlns="http://www.w3.org/1999/xhtml"
    6961      xmlns:py="http://genshi.edgewall.org/"
     
    7365  <head py:match="head" py:attrs="select('@*')">
    7466    ${select('*|comment()|text()')}
    75     <link rel="stylesheet" type="text/css"
    76           href="${href.chrome('site/style.css')}" />
     67    <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
    7768  </head>
    7869
     
    9384}}}
    9485
    95 Those 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 template placed into environment's ''htdocs/''  In a similar fashion '''${chrome.htdocs_location}''' is used to specify common ''htdocs/'' directory from Trac installation.
    96 
    97 site.html is one file to contain all your modifications. It usually works by the py:match (element of 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
    98 and modify them. A site.html can contain any number of such py:match sections for whatever you need to modify. This is all [http://genshi.edgewall.org/ Genshi], so the docs on the exact syntax can be found there.
    99 
    100 
    101 Example snippet of adding introduction text to the new ticket form (hide when preview):
    102 
    103 {{{
    104 #!xml
     86Notice 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.
     87
     88`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.
     89See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
     90A `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.
     91
     92Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     93
     94{{{#!xml
    10595<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
    106   <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     96  <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)">
    10797    <p>Please make sure to search for existing tickets before reporting a new one!</p>
    10898  </py:if>
     
    111101}}}
    112102
    113 This 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.
    114 
    115 If 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:
    116 {{{
    117 #!xml
     103This 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'` condition in `<py:if>` test.
     104
     105More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     106
     107Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
     108
     109If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can be loaded using a workaround, provided it contains no [trac:ClearSilver] processing. In addition, as only one element can be imported, the content needs a 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:
     110{{{#!xml
    118111<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
    119112        xmlns:xi="http://www.w3.org/2001/XInclude">
    120   <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
     113  <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)">
    121114    <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
    122115  </py:if>
     
    125118}}}
    126119
    127 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.
    128 
    129 == Project List == #ProjectList
    130 
    131 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
    132 
    133 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.
    134 
    135 {{{
    136 #!text/html
     120Also 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 maintenance (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.
     121
     122== Project List #ProjectList
     123
     124You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.
     125
     126The 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:
     127
     128{{{#!text/html
    137129<!DOCTYPE html
    138130    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     
    159151}}}
    160152
    161 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):
     153Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located:
     154
     155For [wiki:TracModWSGI mod_wsgi]:
     156{{{#!python
     157os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     158}}}
    162159
    163160For [wiki:TracFastCgi FastCGI]:
    164 {{{
     161{{{#!apache
    165162FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    166163              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     
    168165
    169166For [wiki:TracModPython mod_python]:
    170 {{{
     167{{{#!apache
    171168PythonOption TracEnvParentDir /parent/dir/of/projects
    172169PythonOption TracEnvIndexTemplate /path/to/template
     
    174171
    175172For [wiki:TracCgi CGI]:
    176 {{{
     173{{{#!apache
    177174SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    178175}}}
    179176
    180177For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    181  - Unix
    182    {{{
    183 #!sh
     178 - Unix:
     179   {{{#!sh
    184180$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    185    
    186 }}}
    187  - Windows
    188    {{{
    189 #!sh
     181   }}}
     182 - Windows:
     183   {{{#!sh
    190184$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    191    
    192 }}}
    193 
    194 == Project Templates ==
    195 
    196 The 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.
    197 
    198 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.
    199 
    200 However, 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:
     185   }}}
     186
     187== Project Templates
     188
     189The 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.
     190
     191With that word of caution, any Trac template may be copied and customized. The default Trac templates are located inside the installed Trac egg, 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 `trac/htdocs` directory.
     192
     193However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
    201194 * For a modification to one project only, copy the template to project `templates` directory.
    202  * 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.
     195 * 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.
    203196
    204197Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    205198
    206 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.
     199Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
     200
    207201----
    208202See also TracGuide, TracIni
    209