Changes between Initial Version and Version 1 of TracInterfaceCustomization

Jul 30, 2021, 7:40:25 AM (16 months ago)



  • TracInterfaceCustomization

    v1 v1  
     1= Customizing the Trac Interface
     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.
     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].
     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.
     12Next, configure the appropriate section of your 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`.
     19src = site/my_logo.gif
     20alt = My Project
     21width = 300
     22height = 100
     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:
     30icon = site/my_icon.ico
     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.
     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
     44wiki.label = Home
     45tickets.href = /report/24
     48about = disabled
     49builds = enabled
     50builds.href =
     51admin = enabled
     54See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation.
     56== Site Appearance
     58Trac is using [ Jinja2] as the templating engine.
     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.
     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
     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`:
     71  <!-- site_head.html: Add site-specific style sheet -->
     72  <link rel="stylesheet" href="${'site/style.css')}" />
     73  <!-- /site_head.html -->
     78    <!-- site_header.html: Add site-specific header -->
     79    <div id="siteheader">
     80      ## Place your header content here...
     81    </div>
     82    <!-- /site_header.html -->
     87    <!-- site_footer.html: Add site-specific footer -->
     88    <div id="sitefooter">
     89      ## Place your footer content here...
     90    </div>
     91    <!-- /site_footer.html -->
     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 `${'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.
     97Example snippet of adding introduction text to the new ticket form (but not shown during preview):
     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:
     109  jQuery(function($) {
     110    var $ntg = $("#newticketguide");
     111    if ($ntg.length)
     112      $("#propertyform").prepend($ntg.detach());
     113  });
     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.
     119More examples snippets for placeholder files can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     121Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
     123=== Sharing Templates in Multiple Environments
     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.
     127== Project List #ProjectList
     129You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.
     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:
     136<!DOCTYPE html
     137    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     138    "">
     139<html xmlns=""
     140      xmlns:py=""
     141      xmlns:xi="">
     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">$</a>
     151        <py:otherwise>
     152          <small>$ <em>Error</em> <br /> ($project.description)</small>
     153        </py:otherwise>
     154      </li>
     155    </ul>
     156  </body>
     160Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located:
     162For [wiki:TracModWSGI mod_wsgi]:
     164os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
     167For [TracFastCgi FastCGI]:
     169FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
     170              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     173For [TracModPython mod_python]:
     175PythonOption TracEnvParentDir /parent/dir/of/projects
     176PythonOption TracEnvIndexTemplate /path/to/template
     179For [TracCgi CGI]:
     181SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
     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   }}}
     194== Project Templates
     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.
     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.
     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.
     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.
     206Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
     209See also TracIni, TracNavigation