Changes between Version 68 and Version 69 of TracInterfaceCustomization
- Timestamp:
- Mar 26, 2011, 3:59:27 PM (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v68 v69 50 50 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 (but not for adding new ones). 51 51 52 In 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 .52 In 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 . 53 53 {{{ 54 54 [mainnav] … … 67 67 68 68 Say you want to add a link to a custom stylesheet, and then your own 69 header 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}}}:69 header 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}}}: 70 70 71 71 {{{ … … 98 98 }}} 99 99 100 Those 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 find100 Those 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. 101 102 `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 103 103 and modify them. 104 104 See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`. 105 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. 106 107 108 Example snippet of adding introduction text to the new ticket form (hide when preview): 109 110 {{{ 111 #!xml 105 A `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. 106 107 108 Example snippet of adding introduction text to the new ticket form (but now shown during preview): 109 110 {{{#!xml 112 111 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"> 113 112 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> … … 118 117 }}} 119 118 120 This 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.119 This 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 120 122 121 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml]. … … 136 135 }}} 137 136 138 Also 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.137 Also 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 138 140 139 == Project List == #ProjectList