Changes between Version 2 and Version 3 of TracInterfaceCustomization


Ignore:
Timestamp:
02/08/2011 05:01:16 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v2 v3  
    1515 
    1616=== Logo === 
    17 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 ones). 
     17Change 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 ones). 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'. 
    1818 
    1919{{{ 
     
    4040}}} 
    4141 
     42Should 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.  
     43 
     44{{{ 
     45[project] 
     46icon = /favicon.ico? 
     47}}} 
     48 
    4249== Custom Navigation Entries == 
    4350The 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). 
     
    6067 
    6168Say 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: 
     69header 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}}}: 
    6370 
    6471{{{ 
     
    9097</html> 
    9198}}} 
    92 Note that this references your environment's `htdocs/style.css`. 
     99 
     100Those 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. 
     101 
     102`site.html` is one file to contain all your modifications. It usually works by the py:match (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 
     103and modify them. 
     104See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`. 
     105A 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. 
     106 
    93107 
    94108Example snippet of adding introduction text to the new ticket form (hide when preview): 
     
    104118}}} 
    105119 
    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: 
     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: 
    107127{{{ 
    108128#!xml 
     
    152172Once 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): 
    153173 
     174For [wiki:TracModWSGI mod_wsgi]: 
     175{{{ 
     176os.environ['TRAC_ENV_INDEX_TEMPLATE'] = '/path/to/template' 
     177}}} 
     178 
    154179For [wiki:TracFastCgi FastCGI]: 
    155180{{{ 
     
    193218Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg. 
    194219 
     220Trac caches templates in memory by default to improve performance. To apply a template you need to restart the server. 
     221 
    195222---- 
    196223See also TracGuide, TracIni