Edgewall Software

Changes between Version 55 and Version 56 of TracInterfaceCustomization


Ignore:
Timestamp:
Aug 15, 2008, 10:54:39 PM (12 years ago)
Author:
osimons
Comment:

Trying to clean the text and cautions for copying Trac templates.

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v55 v56  
    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.
     
    118118Also 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.
    119119
    120 == Project List ==
     120== Project List == #ProjectList
     121
    121122You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 
    122123
     
    182183== Project Templates ==
    183184
    184 The 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. For Trac 0.11, simply add and/or change the Genshi template files in that project environment's `templates` folder. For Trac 0.10, simply add and/or change the Clearsilver template files in that project environment's `htdocs` folder.
     185The 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.
    185186
    186 For instance, if you are running Trac 0.11 and your project environment directory is `/srv/trac/myproject` then you can customize `myproject`'s appearance by changing the files found in `/srv/trac/myproject/templates`. For more information, read the `templates/README` file.
     187With 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.
    187188
    188 To make template changes for all projects served by a single installation of Trac, modify the global templates in the egg's `trac/templates` directory.
     189However, 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:
     190 * For a modification to one project only, copy the template to project `templates` directory.
     191 * 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.
    189192
    190 === Caution: Do not make changes to the Trac installation egg ===
    191 
    192 Though possible, it is considered very bad practice to make global modifications by editing the Trac installation egg directly. Any changes you make here ''will be overwritten when you update your [TracInstall Trac install]'' and thus lost. The only way to prevent this from happening is to keep a current backup of your changes elsewhere.
    193 
    194 The default Trac templates are located in the egg's `trac/templates` directory (e.g., `/usr/lib/pythonVERSION/site-packages/Trac-VERSION.egg/trac/templates`). The [#ProjectList]'s template file is called `index.html` while the theme for the WikiStart page is called `theme.html`. Page assets such as images and CSS style sheets are located in the egg's `trac/htdocs` directory. Remember, ''your changes will be lost upon the next update you perform'' to your installation and you should thus use the method described in [#ProjectList], above, to effect global template customizations.
     193Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
    195194
    196195----