Changes between Version 1 and Version 2 of TracInterfaceCustomization


Ignore:
Timestamp:
10/21/20 13:53:03 (8 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 
    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.''
    13 
    14 Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    15 
    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 {{{
     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
    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.
    29 
    30 {{{
     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
    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:
    36 
    37 {{{
    38 [project]
    39 icon = /favicon.ico
    40 }}}
    41 
    42 == Site Header & Footer ==
    43 
    44 In the environment folder for each Trac project there should be a directory called {{{templates}}}.  This folder contains files {{{site_header.cs}}} and {{{site_footer.cs}}}.  Users can customize their Trac site by adding the required HTML markup to these files.  The content of these two files will be placed immediately following the opening {{{<body>}}} tag and immediately preceding the closing {{{</body>}}} tag of each page in the site, respectively.
    45 
    46 These files may contain static HTML, though if users desire to have dynamically generated content they can make use of the [http://www.clearsilver.net/ ClearSilver] templating language from within the pages as well. When you need to see what variables are available to the template, append the query string `?hdfdump=1` to the URL of your Trac site. This will display a structured view of the template data.
    47 
    48 == Site CSS ==
    49 The primary means to adjust the layout of a Trac site is to add [http://www.w3.org/TR/REC-CSS2/ CSS] style rules that overlay the default rules. This is best done by editing the `site_css.cs` file in the enviroment's `templates` directory. The content of that template gets inserted into a `<style type="text/css"></style>` element on every HTML page generated by Trac.
    50 
    51 While you can add your custom style rules directly to the `site_css.cs` file, it is recommended that you simply reference an external style sheet, thereby enabling browsers to cache the CSS file instead of transmitting the rules with every response.
    52 
    53 The following example would import a style sheet located in the `style` root directory of your host:
    54 {{{
    55 @import url(/style/mytrac.css);
    56 }}}
    57 
    58 You can use a !ClearSilver variable to reference a style sheet stored in the project environment's `htdocs` directory:
    59 {{{
    60 @import url(<?cs var:chrome.href ?>/site/style.css);
    61 }}}
    62 
    63 == Project List ==
    64 You can use a custom ClearSilver template to display the list of projects if you are using Trac with multiple projects. 
    65 
    66 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.
    67 
    68 {{{
    69 #!text/html
    70 <html>
    71 <head><title>Available Projects</title></head>
    72 <body>
    73  <h1>Available Projects</h1>
    74  <ul><?cs
    75  each:project = projects ?><li><?cs
    76   if:project.href ?>
    77    <a href="<?cs var:project.href ?>" title="<?cs var:project.description ?>">
    78     <?cs var:project.name ?></a><?cs
    79   else ?>
    80    <small><?cs var:project.name ?>: <em>Error</em> <br />
    81    (<?cs var:project.description ?>)</small><?cs
    82   /if ?>
    83   </li><?cs
    84  /each ?>
    85  </ul>
    86 </body>
     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
     43[mainnav]
     44wiki.label = Home
     45tickets.href = /report/24
     46
     47[metanav]
     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 -->
     79    <div id="siteheader">
     80      ## Place your header content here...
     81    </div>
     82    <!-- /site_header.html -->
     83}}}
     84
     85`site_footer.html`:
     86{{{#!xml
     87    <!-- site_footer.html: Add site-specific footer -->
     88    <div id="sitefooter">
     89      ## Place your footer content here...
     90    </div>
     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.
     96
     97Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     98
     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].
     120
     121Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
     122
     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
     136<!DOCTYPE html
     137    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     138    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     139<html xmlns="http://www.w3.org/1999/xhtml"
     140      xmlns:py="http://genshi.edgewall.org/"
     141      xmlns:xi="http://www.w3.org/2001/XInclude">
     142  <head>
     143    <title>Available Projects</title>
     144  </head>
     145  <body>
     146    <h1>Available Projects</h1>
     147    <ul>
     148      <li py:for="project in projects" py:choose="">
     149        <a py:when="project.href" href="$project.href"
     150           title="$project.description">$project.name</a>
     151        <py:otherwise>
     152          <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
     153        </py:otherwise>
     154      </li>
     155    </ul>
     156  </body>
    87157</html>
    88158}}}
     
    90160Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located:
    91161
    92 For [wiki:TracFastCgi FastCGI]:
    93 {{{
     162For [wiki:TracModWSGI mod_wsgi]:
     163{{{#!python
     164os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     165}}}
     166
     167For [TracFastCgi FastCGI]:
     168{{{#!apache
    94169FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    95170              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    96171}}}
    97172
    98 For [wiki:TracModPython mod_python]:
    99 {{{
     173For [TracModPython mod_python]:
     174{{{#!apache
     175PythonOption TracEnvParentDir /parent/dir/of/projects
    100176PythonOption TracEnvIndexTemplate /path/to/template
    101177}}}
    102178
    103 For [wiki:TracCgi CGI]:
    104 {{{
     179For [TracCgi CGI]:
     180{{{#!apache
    105181SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    106182}}}
    107183
    108 
    109 == Main Templates ==
    110 
    111 It is also possible to use your own modified versions of the Trac [http://www.clearsilver.net/ ClearSilver] templates. Note though that this technique is not recommended because it makes upgrading Trac rather problematic: there are unfortunately several dependencies between the templates and the application code, such as the name of form fields and the structure of the template data, and these are likely to change between different versions of Trac.
    112 
    113 If you absolutely need to use modified templates, copy the template files from the default templates directory (usually in found in `$prefix/share/trac/templates`) into the `templates` directory of the project environment. Then modify those copies to get the desired results.
     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
     187$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     188   }}}
     189 - Windows:
     190   {{{#!sh
     191$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     192   }}}
     193
     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:
     201 * 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 [[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.
    114207
    115208----
    116 See also TracGuide, TracIni
     209See also TracIni, TracNavigation