Changes between Version 2 and Version 3 of TracInterfaceCustomization


Ignore:
Timestamp:
Apr 16, 2016, 7:07:21 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInterfaceCustomization

    v2 v3  
    1 = Customizing the Trac Interface =
     1= Customizing the Trac Interface
     2
    23[[TracGuideToc]]
    34[[PageOutline]]
    45
    5 == Introduction ==
     6== Introduction
     7
    68This 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.
    79
    8 == Project Logo and Icon ==
     10== Project Logo and Icon
     11
    912The 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].
    1013
    1114The 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''.
    1215
    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.''
     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.
    1417
    1518Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    1619
    17 === Logo ===
     20=== Logo
     21
    1822Change 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'.
    1923
    20 {{{
     24{{{#!ini
    2125[header_logo]
    2226src = site/my_logo.gif
    … …  
    2630}}}
    2731
    28 === Icon ===
     32=== Icon
     33
    2934Icons 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:
    3035
    31 {{{
     36{{{#!ini
    3237[project]
    3338icon = site/my_icon.ico
    3439}}}
    3540
    36 Note 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 IE as well as other browsers, you can store the icon in the document root of the host and then reference it from `trac.ini` as follows:
    37 
    38 {{{
    39 [project]
    40 icon = /favicon.ico
    41 }}}
    42 
    43 If your browser does not show your favicon in the address bar, append a "?" to the file extension:
    44 
    45 {{{
    46 [project]
    47 icon = /favicon.ico?
    48 }}}
    49 
    50 == Custom Navigation Entries ==
     41== Custom Navigation Entries
     42
    5143The 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.
    5244
    5345In 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 {{{
     46{{{#!ini
    5547[mainnav]
    5648wiki.label = Home
    … …  
    6557== Site Appearance == #SiteAppearance
    6658
    67 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}}}:
    68 
    69 {{{
    70 #!xml
     59Trac 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
    7162<html xmlns="http://www.w3.org/1999/xhtml"
    7263      xmlns:py="http://genshi.edgewall.org/"
    … …  
    119110
    120111If 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:
    121 {{{
    122 #!xml
     112{{{#!xml
    123113<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
    124114        xmlns:xi="http://www.w3.org/2001/XInclude">
    … …  
    138128The 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:
    139129
    140 {{{
    141 #!text/html
     130{{{#!text/html
    142131<!DOCTYPE html
    143132    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    … …  
    167156
    168157For [wiki:TracModWSGI mod_wsgi]:
    169 {{{
     158{{{#!python
    170159os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
    171160}}}
    172161
    173162For [wiki:TracFastCgi FastCGI]:
    174 {{{
     163{{{#!apache
    175164FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    176165              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    … …  
    178167
    179168For [wiki:TracModPython mod_python]:
    180 {{{
     169{{{#!apache
    181170PythonOption TracEnvParentDir /parent/dir/of/projects
    182171PythonOption TracEnvIndexTemplate /path/to/template
    … …  
    184173
    185174For [wiki:TracCgi CGI]:
    186 {{{
     175{{{#!apache
    187176SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    188177}}}
    … …  
    190179For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    191180 - Unix
    192    {{{
    193 #!sh
     181   {{{#!sh
    194182$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    195183   }}}
    196184 - Windows
    197    {{{
    198 #!sh
     185   {{{#!sh
    199186$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    200187   }}}
    201188
    202 == Project Templates ==
     189== Project Templates
    203190
    204191The 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.
    205192
    206 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.
     193With 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.
    207194
    208195However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
    209196 * For a modification to one project only, copy the template to project `templates` directory.
    210  * 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.
     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.
    211198
    212199Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    213200
    214 Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server.
     201Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
    215202
    216203----