Changes between Version 4 and Version 5 of TracInterfaceCustomization


Ignore:
Timestamp:
04/07/2021 11:15:20 PM (6 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v4 v5  
    1 = Customizing the Trac Interface =
     1= Customizing the Trac Interface
    22[[TracGuideToc]]
    3 [[PageOutline]]
    4 
    5 == Introduction ==
    6 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.
    7 
    8 == Project Logo and Icon ==
    9 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].
    10 
    11 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'')
    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 
    15 Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    16 
    17 === Logo ===
    18 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 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 {{{
     3[[PageOutline(2-5,Contents,pullout)]]
     4
     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.
     6
     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].
     9
     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.
     11
     12Next, configure the appropriate section of your trac.ini:
     13
     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`.
     16
     17{{{#!ini
    2118[header_logo]
    2219src = site/my_logo.gif
     
    2623}}}
    2724
    28 === Icon ===
    29 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.  Icons will typically be displayed by your web browser next to the site's URL and in the `Bookmarks` menu.
    30 
    31 {{{
     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:
     27
     28{{{#!ini
    3229[project]
    3330icon = site/my_icon.ico
    3431}}}
    3532
    36 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:
    37 
    38 {{{
    39 [project]
    40 icon = /favicon.ico
    41 }}}
    42 
    43 Should 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]
    47 icon = /favicon.ico?
    48 }}}
    49 
    50 == Custom Navigation Entries ==
    51 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).
    52 
    53 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 .
    54 {{{
     33== Custom Navigation Entries
     34The `[mainnav]` and `[metanav]` sections of trac.ini be used to customize the navigation entries, disable them and even add new ones.
     35
     36In the following example, we:
     37* rename the link to WikiStart to be //Home//
     38* hide the ''About'' entry
     39* make the //View Tickets// entry link to a specific report
     40* add a //Builds// entry that links to an external build system
     41* move the //Admin// entry to the meta navigation bar
     42{{{#!ini
    5543[mainnav]
    5644wiki.label = Home
     
    5846
    5947[metanav]
    60 help = disabled
    61 }}}
    62 
    63 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
    64 
    65 == Site Appearance == #SiteAppearance
    66 
    67 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.
    68 
    69 Say you want to add a link to a custom stylesheet, and then your own
    70 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. {{{/path/to/env/templates/site.html}}}:
    71 
    72 {{{
    73 #!xml
    74 <html xmlns="http://www.w3.org/1999/xhtml"
    75       xmlns:py="http://genshi.edgewall.org/"
    76       py:strip="">
    77 
    78   <!--! Add site-specific style sheet -->
    79   <head py:match="head" py:attrs="select('@*')">
    80     ${select('*|comment()|text()')}
    81     <link rel="stylesheet" type="text/css"
    82           href="${href.chrome('site/style.css')}" />
    83   </head>
    84 
    85   <body py:match="body" py:attrs="select('@*')">
    86     <!--! Add site-specific header -->
     48about = disabled
     49builds = enabled
     50builds.href = https://travis-ci.org/edgewall/trac
     51admin = enabled
     52}}}
     53
     54See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation.
     55
     56== Site Appearance
     57
     58Trac is using [http://jinja.pocoo.org/ Jinja2] as the templating engine.
     59
     60We have put in place a number of "placeholder" in the form of "include" directives. These files don't need to exist, but if they do, their content will be processed by Jinja2 as well. As such, they can make use of other "include" directives, or any other feature of Jinja2 to generate dynamic content.
     61
     62There are three such placeholder templates:
     63 - `site_head.html`, which can be used to add content inside the generated `<head>` element
     64 - `site_header.html`, which can be used to **prepend** content inside the generated `<body>` element, before the standard content generated by Trac
     65 - `site_footer.html`, which can be used to **append** content inside the generated `<body>` element, after the standard content generated by Trac
     66
     67Say you want to add a link to a custom stylesheet, and then your own header and footer. Save the following content as `site_head.html`, `site_header.html` and `site_footer.html` inside your projects `templates/` directory (each Trac project can have their own "placeholder" files) e.g. `/path/to/env/templates/site_head.html`:
     68
     69`site_head.html`:
     70{{{#!xml
     71  <!-- site_head.html: Add site-specific style sheet -->
     72  <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
     73  <!-- /site_head.html -->
     74}}}
     75
     76`site_header.html`:
     77{{{#!xml
     78    <!-- site_header.html: Add site-specific header -->
    8779    <div id="siteheader">
    88       <!--! Place your header content here... -->
     80      ## Place your header content here...
    8981    </div>
    90 
    91     ${select('*|text()')}
    92 
    93     <!--! Add site-specific footer -->
     82    <!-- /site_header.html -->
     83}}}
     84
     85`site_footer.html`:
     86{{{#!xml
     87    <!-- site_footer.html: Add site-specific footer -->
    9488    <div id="sitefooter">
    95       <!--! Place your footer content here... -->
     89      ## Place your footer content here...
    9690    </div>
    97   </body>
    98 </html>
    99 }}}
    100 
    101 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 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
    104 and modify them.
    105 See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
    106 A `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 
     91    <!-- /site_footer.html -->
     92}}}
     93
     94Notice that as Jinja2 is mostly content agnostic, you are free to open some `<div>` element in the `site_header.html` file and only close it in `site_footer.html` file.
     95Besides, as in any other Trac Jinja2 template, you can use 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.
    10896
    10997Example snippet of adding introduction text to the new ticket form (but not shown during preview):
    11098
    111 {{{#!xml
    112 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
    113   <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
    114     <p>Please make sure to search for existing tickets before reporting a new one!</p>
    115   </py:if>
    116   ${select('*')}
    117 </form>
    118 }}}
    119 
    120 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.
    121 
    122 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     99 - first we need to introduce the extra "content" of this notice, if it's appropriate for the request. For that, we add this snippet in the `site_footer.html` placeholder file:
     100  {{{#!xml
     101  # if req.path_info == '/newticket' and 'preview' not in req.args:
     102    <p id="ntg">Please make sure to search for existing tickets before reporting a new one!</p>
     103  # endif
     104  }}}
     105 - second, we need to dynamically alter the rest of the content in order to position that notice at the desired location. For that, we add this snippet to the `site_head.html` placeholder file:
     106
     107{{{#!xml
     108<script>
     109  jQuery(function($) {
     110    var $ntg = $("#newticketguide");
     111    if ($ntg.length)
     112      $("#propertyform").prepend($ntg.detach());
     113  });
     114</script>
     115}}}
     116
     117This example illustrates a technique of using `req.path_info` to limit scope of changes to one view only. For instance, to make changes only for timeline and avoid modifying other sections, use `req.path_info == '/timeline'` as the condition in a `# if` test.
     118
     119More examples snippets for placeholder files can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
    123120
    124121Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
    125122
    126 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:
    127 {{{
    128 #!xml
    129 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
    130         xmlns:xi="http://www.w3.org/2001/XInclude">
    131   <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
    132     <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
    133   </py:if>
    134   ${select('*')}
    135 </form>
    136 }}}
    137 
    138 Also 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.
    139 
    140 == Project List == #ProjectList
    141 
    142 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
    143 
    144 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.
    145 
    146 {{{
    147 #!text/html
     123=== Sharing Templates in Multiple Environments
     124
     125The `site_*.html` templates, despite their name, can be put in a shared templates directory, see the [[TracIni#inherit-templates_dir-option|[inherit] templates_dir]] option. This could provide easier maintenance, as global `site_head.html`, `site_header.html` and `site_footer.html` files can be made to `# include` any other local existing header, footer and newticket snippets.
     126
     127== Project List #ProjectList
     128
     129You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.
     130
     131The 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:
     132
     133FIXME
     134
     135{{{#!text/html
    148136<!DOCTYPE html
    149137    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     
    170158}}}
    171159
    172 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):
     160Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located:
    173161
    174162For [wiki:TracModWSGI mod_wsgi]:
    175 {{{
     163{{{#!python
    176164os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
    177165}}}
    178166
    179 For [wiki:TracFastCgi FastCGI]:
    180 {{{
     167For [TracFastCgi FastCGI]:
     168{{{#!apache
    181169FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    182170              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    183171}}}
    184172
    185 For [wiki:TracModPython mod_python]:
    186 {{{
     173For [TracModPython mod_python]:
     174{{{#!apache
    187175PythonOption TracEnvParentDir /parent/dir/of/projects
    188176PythonOption TracEnvIndexTemplate /path/to/template
    189177}}}
    190178
    191 For [wiki:TracCgi CGI]:
    192 {{{
     179For [TracCgi CGI]:
     180{{{#!apache
    193181SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    194182}}}
    195183
    196 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    197  - Unix
    198    {{{
    199 #!sh
     184For TracStandalone, you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
     185 - Unix:
     186   {{{#!sh
    200187$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    201188   }}}
    202  - Windows
    203    {{{
    204 #!sh
     189 - Windows:
     190   {{{#!sh
    205191$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    206192   }}}
    207193
    208 == Project Templates ==
    209 
    210 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.
    211 
    212 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.
    213 
    214 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:
     194== Project Templates
     195
     196The 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 `site_{head,header,footer}.html` templates whenever possible, see [#SiteAppearance]. Using `site_{head,header,footer}.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
     198With 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.
     199
     200However, do not edit templates or site resources inside the Trac egg/wheel. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
    215201 * For a modification to one project only, copy the template to project `templates` directory.
    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.
    217 
    218 Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    219 
    220 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.
     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 [[TracIni#inherit-templates_dir-option|[inherit] templates_dir]] option.
     203
     204Trac 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.
     205
     206Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
    221207
    222208----
    223 See also TracGuide, TracIni
     209See also TracIni, TracNavigation