Changes between Version 4 and Version 5 of TracInterfaceCustomization


Ignore:
Timestamp:
Nov 23, 2016, 6:53:44 AM (12 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v4 v5  
    1 = Customizing the Trac Interface =
     1= Customizing the Trac Interface
     2
    23[[TracGuideToc]]
    3 [[PageOutline]]
    4 
    5 == Introduction ==
     4[[PageOutline(2-5,Contents,pullout)]]
     5
    66This 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.
    77
    8 == Project Logo and Icon ==
     8== Project Logo and Icon
     9
    910The 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].
    1011
    1112The 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''.
    1213
    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'''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.
    1415
    1516Now configure the appropriate section of your [wiki:TracIni trac.ini]:
    1617
    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 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'.
    19 
    20 {{{
     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
    2123[header_logo]
    2224src = site/my_logo.gif
     
    2628}}}
    2729
    28 === Icon ===
     30=== Icon
     31
    2932Icons 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:
    3033
    31 {{{
     34{{{#!ini
    3235[project]
    3336icon = site/my_icon.ico
    3437}}}
    3538
    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 ==
     39== Custom Navigation Entries
     40
    5141The 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.
    5242
    5343In 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 {{{
     44{{{#!ini
    5545[mainnav]
    5646wiki.label = Home
     
    6353See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
    6454
    65 == Site Appearance == #SiteAppearance
    66 
    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
     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
    7160<html xmlns="http://www.w3.org/1999/xhtml"
    7261      xmlns:py="http://genshi.edgewall.org/"
     
    10594{{{#!xml
    10695<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
    107   <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)">
    10897    <p>Please make sure to search for existing tickets before reporting a new one!</p>
    10998  </py:if>
     
    112101}}}
    113102
    114 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.
     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.
    115104
    116105More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     
    118107Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
    119108
    120 If 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
     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
    123111<form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
    124112        xmlns:xi="http://www.w3.org/2001/XInclude">
    125   <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)">
    126114    <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
    127115  </py:if>
     
    130118}}}
    131119
    132 Also 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 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.
    133 
    134 == Project List == #ProjectList
    135 
    136 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
     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.
    137125
    138126The 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:
    139127
    140 {{{
    141 #!text/html
     128{{{#!text/html
    142129<!DOCTYPE html
    143130    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     
    164151}}}
    165152
    166 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:
    167154
    168155For [wiki:TracModWSGI mod_wsgi]:
    169 {{{
     156{{{#!python
    170157os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html'
    171158}}}
    172159
    173160For [wiki:TracFastCgi FastCGI]:
    174 {{{
     161{{{#!apache
    175162FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
    176163              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     
    178165
    179166For [wiki:TracModPython mod_python]:
    180 {{{
     167{{{#!apache
    181168PythonOption TracEnvParentDir /parent/dir/of/projects
    182169PythonOption TracEnvIndexTemplate /path/to/template
     
    184171
    185172For [wiki:TracCgi CGI]:
    186 {{{
     173{{{#!apache
    187174SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    188175}}}
    189176
    190177For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    191  - Unix
    192    {{{
    193 #!sh
     178 - Unix:
     179   {{{#!sh
    194180$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    195181   }}}
    196  - Windows
    197    {{{
    198 #!sh
     182 - Windows:
     183   {{{#!sh
    199184$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
    200185   }}}
    201186
    202 == Project Templates ==
    203 
    204 The 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.
    205 
    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.
     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.
    207192
    208193However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
    209194 * 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.
     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.
    211196
    212197Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    213198
    214 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.
    215200
    216201----