WordPress.org

Making WordPress.org

Changes between Initial Version and Version 1 of TracInterfaceCustomization


Ignore:
Timestamp:
06/05/13 17:29:27 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v1 v1  
     1= Customizing the Trac Interface = 
     2[[TracGuideToc]] 
     3[[PageOutline]] 
     4 
     5== Introduction == 
     6This 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 == 
     9The 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 
     11The 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 
     15Now configure the appropriate section of your [wiki:TracIni trac.ini]: 
     16 
     17=== Logo === 
     18Change 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{{{ 
     21[header_logo] 
     22src = site/my_logo.gif 
     23alt = My Project 
     24width = 300 
     25height = 100 
     26}}} 
     27 
     28=== Icon === 
     29Icons 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{{{ 
     32[project] 
     33icon = site/my_icon.ico 
     34}}} 
     35 
     36Note 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] 
     40icon = /favicon.ico 
     41}}} 
     42 
     43Should 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] 
     47icon = /favicon.ico? 
     48}}} 
     49 
     50== Custom Navigation Entries == 
     51The 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 
     53In 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{{{ 
     55[mainnav] 
     56wiki.label = Home 
     57tickets.href = /report/24 
     58 
     59[metanav] 
     60help = disabled 
     61}}} 
     62 
     63See also TracNavigation for a more detailed explanation of the mainnav and metanav terms. 
     64 
     65== Site Appearance == #SiteAppearance 
     66 
     67Trac 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 
     69Say you want to add a link to a custom stylesheet, and then your own 
     70header 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 --> 
     87    <div id="siteheader"> 
     88      <!--! Place your header content here... --> 
     89    </div> 
     90 
     91    ${select('*|text()')} 
     92 
     93    <!--! Add site-specific footer --> 
     94    <div id="sitefooter"> 
     95      <!--! Place your footer content here... --> 
     96    </div> 
     97  </body> 
     98</html> 
     99}}} 
     100 
     101Those 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 
     104and modify them. 
     105See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`. 
     106A `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 
     108 
     109Example snippet of adding introduction text to the new ticket form (but not shown during preview): 
     110 
     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 
     120This 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 
     122More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. 
     123 
     124Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss]. 
     125 
     126If 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 
     138Also 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 
     142You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.   
     143 
     144The 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 
     148<!DOCTYPE html 
     149    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 
     150    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 
     151<html xmlns="http://www.w3.org/1999/xhtml" 
     152      xmlns:py="http://genshi.edgewall.org/" 
     153      xmlns:xi="http://www.w3.org/2001/XInclude"> 
     154  <head> 
     155    <title>Available Projects</title> 
     156  </head> 
     157  <body> 
     158    <h1>Available Projects</h1> 
     159    <ul> 
     160      <li py:for="project in projects" py:choose=""> 
     161        <a py:when="project.href" href="$project.href" 
     162           title="$project.description">$project.name</a> 
     163        <py:otherwise> 
     164          <small>$project.name: <em>Error</em> <br /> ($project.description)</small> 
     165        </py:otherwise> 
     166      </li> 
     167    </ul> 
     168  </body> 
     169</html> 
     170}}} 
     171 
     172Once 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): 
     173 
     174For [wiki:TracModWSGI mod_wsgi]: 
     175{{{ 
     176os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template.html' 
     177}}} 
     178 
     179For [wiki:TracFastCgi FastCGI]: 
     180{{{ 
     181FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \ 
     182              -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template 
     183}}} 
     184 
     185For [wiki:TracModPython mod_python]: 
     186{{{ 
     187PythonOption TracEnvParentDir /parent/dir/of/projects 
     188PythonOption TracEnvIndexTemplate /path/to/template 
     189}}} 
     190 
     191For [wiki:TracCgi CGI]: 
     192{{{ 
     193SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template 
     194}}} 
     195 
     196For [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 
     200$ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 
     201   }}} 
     202 - Windows 
     203   {{{ 
     204#!sh 
     205$ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template 
     206   }}} 
     207 
     208== Project Templates == 
     209 
     210The 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 
     212With 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 
     214However, 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: 
     215 * 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 
     218Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg. 
     219 
     220Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server. 
     221 
     222---- 
     223See also TracGuide, TracIni