Changes between Version 3 and Version 4 of TracInterfaceCustomization


Ignore:
Timestamp:
03/18/10 20:29:15 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInterfaceCustomization

    v3 v4  
    4141
    4242== Custom Navigation Entries ==
    43 The new [mainnav] and [metanav] can now be used to customize the text and link used for the navigation items, or even to disable them.
     43The 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).
    4444
    4545In 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 .
    … …  
    5353}}}
    5454
    55 
    56 == Site Appearance ==
     55See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
     56
     57== Site Appearance == #SiteAppearance
    5758
    5859Trac 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.
    5960
    6061Say you want to add a link to a custom stylesheet, and then your own
    61 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}}}:
    6263
    6364{{{
    … …  
    6970  <!--! Add site-specific style sheet -->
    7071  <head py:match="head" py:attrs="select('@*')">
    71     ${select('*')}
     72    ${select('*|comment()|text()')}
    7273    <link rel="stylesheet" type="text/css"
    7374          href="${href.chrome('site/style.css')}" />
    … …  
    8990</html>
    9091}}}
    91 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
    9298
    9399Example snippet of adding introduction text to the new ticket form (hide when preview):
    … …  
    103109}}}
    104110
    105 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:
    106114{{{
    107115#!xml
    … …  
    117125Also 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.
    118126
    119 == Project List ==
    120 You can use a custom ClearSilver template to display the list of projects if you are using Trac with multiple projects. 
     127== Project List == #ProjectList
     128
     129You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
    121130
    122131The 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.
    … …  
    158167For [wiki:TracModPython mod_python]:
    159168{{{
     169PythonOption TracEnvParentDir /parent/dir/of/projects
    160170PythonOption TracEnvIndexTemplate /path/to/template
    161171}}}
    … …  
    178188   }}}
    179189
     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.
    180203----
    181204See also TracGuide, TracIni