Changes between Version 1 and Version 2 of TracInterfaceCustomization


Ignore:
Timestamp:
09/22/11 13:47:52 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v1 v2  
    5555See also TracNavigation for a more detailed explanation of the mainnav and metanav terms. 
    5656 
    57 == Site Appearance == 
     57== Site Appearance == #SiteAppearance 
    5858 
    5959Trac 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. 
    6060 
    6161Say you want to add a link to a custom stylesheet, and then your own 
    62 header and footer.  Create a file {{{/path/to/env/templates/site.html}}} or {{{/path/to/inherit/option/templates_dir/site.html}}}, with contents like this: 
     62header 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}}}: 
    6363 
    6464{{{ 
     
    9090</html> 
    9191}}} 
    92 Note that this references your environment's `htdocs/style.css`. 
     92 
     93Those 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 template placed into environment's ''htdocs/''  In a similar fashion '''${chrome.htdocs_location}''' is used to specify common ''htdocs/'' directory from Trac installation. 
     94 
     95site.html is one file to contain all your modifications. It usually works by the py:match (element of 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 
     96and modify them. A site.html can contain any number of such py:match sections for whatever you need to modify. This is all [http://genshi.edgewall.org/ Genshi], so the docs on the exact syntax can be found there.  
     97 
    9398 
    9499Example snippet of adding introduction text to the new ticket form (hide when preview): 
     
    104109}}} 
    105110 
    106 If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can actually be loaded by using a workaroud - 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: 
     111This 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. 
     112 
     113If 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: 
    107114{{{ 
    108115#!xml 
     
    118125Also note that the `site.html` (despite its name) can be put in a common templates directory - see the `[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. 
    119126 
    120 == Project List == 
     127== Project List == #ProjectList 
     128 
    121129You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.   
    122130 
     
    159167For [wiki:TracModPython mod_python]: 
    160168{{{ 
     169PythonOption TracEnvParentDir /parent/dir/of/projects 
    161170PythonOption TracEnvIndexTemplate /path/to/template 
    162171}}} 
     
    179188   }}} 
    180189 
     190== Project Templates == 
     191 
     192The 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. 
     193 
     194With 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. 
     195 
     196However, 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: 
     197 * For a modification to one project only, copy the template to project `templates` directory. 
     198 * 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. 
     199 
     200Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg. 
     201 
     202Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server. 
    181203---- 
    182204See also TracGuide, TracIni