close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 4 and Version 5 of TracInterfaceCustomization


Ignore:
Timestamp:
May 10, 2020, 10:51:59 PM (3 months ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracInterfaceCustomization

    v4 v5  
    66
    77== Project Logo and Icon
    8 The easiest parts of the Trac interface to customize are the logo and the site icon. Both of these can be configured with settings in [wiki:TracIni trac.ini].
    9 
    10 The logo or icon image should be put in a folder named "htdocs" in your project's environment folder. ''Note: in projects created with a Trac version prior to 0.9 you will need to create this folder''.
    11 
    12 '''Note''': you can actually put the logo and icon anywhere on your server (as long as it's accessible through the web server), and use their absolute or server-relative URLs in the configuration.
    13 
    14 Now configure the appropriate section of your [wiki:TracIni trac.ini]:
     8The easiest parts of the Trac interface to customize are the logo and the site icon. Both of these can be configured with settings in [TracIni#project-section trac.ini].
     9
     10The logo or icon image should be put your environment's `htdocs` directory. You can actually put the logo and icon anywhere on your server (as long as it's accessible through the web server), and use their absolute or server-relative URLs in the configuration.
     11
     12Next, configure the appropriate section of your trac.ini:
    1513
    1614=== 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 `htdocs` directory belonging to a Trac installation. Note that 'site/' is not a placeholder for your project name, it is the literal prefix that should be used. 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'.
     15Change 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 `htdocs` directory belonging to a Trac installation. Note that `site/` is not a placeholder for your project name, it is the literal prefix. 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`.
    1816
    1917{{{#!ini
     
    3432
    3533== Custom Navigation Entries
    36 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.
    37 
    38 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:
     34The `[mainnav]` and `[metanav]` sections of trac.ini be used to customize the navigation entries, disable them and even add new ones.
     35
     36In the following example, we:
     37* rename the link to WikiStart to be //Home//
     38* hide the ''About'' entry
     39* make the //View Tickets// entry link to a specific report
     40* add a //Builds// entry that links to an external build system
     41* move the //Admin// entry to the meta navigation bar
    3942{{{#!ini
    4043[mainnav]
     
    4346
    4447[metanav]
    45 help = disabled
    46 }}}
    47 
    48 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.
    49 
    50 == Site Appearance #SiteAppearance
    51 
    52 Trac is using [http://genshi.edgewall.org Genshi] as the templating engine. Say you want to add a link to a custom stylesheet, and then your own header and footer. Save the following content as `site.html` inside your projects `templates/` directory (each Trac project can have their own `site.html`), eg `/path/to/env/templates/site.html`:
    53 
    54 {{{#!xml
    55 <html xmlns="http://www.w3.org/1999/xhtml"
    56       xmlns:py="http://genshi.edgewall.org/"
    57       py:strip="">
    58 
    59   <!--! Add site-specific style sheet -->
    60   <head py:match="head" py:attrs="select('@*')">
    61     ${select('*|comment()|text()')}
    62     <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
    63   </head>
    64 
    65   <body py:match="body" py:attrs="select('@*')">
    66     <!--! Add site-specific header -->
     48about = disabled
     49builds = enabled
     50builds.href = https://travis-ci.org/edgewall/trac
     51admin = enabled
     52}}}
     53
     54See also TracNavigation for a more detailed explanation of the mainnav and metanav navigation.
     55
     56== Site Appearance
     57
     58Trac is using [http://jinja.pocoo.org/ Jinja2] as the templating engine.
     59
     60We have put in place a number of "placeholder" in the form of "include" directives. These files don't need to exist, but if they do, their content will be processed by Jinja2 as well. As such, they can make use of other "include" directives, or any other feature of Jinja2 to generate dynamic content.
     61
     62There are three such placeholder templates:
     63 - `site_head.html`, which can be used to add content inside the generated `<head>` element
     64 - `site_header.html`, which can be used to **prepend** content inside the generated `<body>` element, before the standard content generated by Trac
     65 - `site_header.html`, which can be used to **append** content inside the generated `<body>` element, after the standard content generated by Trac
     66
     67Say you want to add a link to a custom stylesheet, and then your own header and footer. Save the following content as `site_head.html`, `site_header.html` and `site_footer.html` inside your projects `templates/` directory (each Trac project can have their own "placeholder" files) e.g. `/path/to/env/templates/site_head.html`:
     68
     69`site_head.html`:
     70{{{#!xml
     71  <!-- site_head.html: Add site-specific style sheet -->
     72  <link rel="stylesheet" href="${href.chrome('site/style.css')}" />
     73  <!-- /site_head.html -->
     74}}}
     75
     76`site_header.html`:
     77{{{#!xml
     78    <!-- site_header.html: Add site-specific header -->
    6779    <div id="siteheader">
    68       <!--! Place your header content here... -->
     80      ## Place your header content here...
    6981    </div>
    70 
    71     ${select('*|text()')}
    72 
    73     <!--! Add site-specific footer -->
     82    <!-- /site_header.html -->
     83}}}
     84
     85`site_footer.html`:
     86{{{#!xml
     87    <!-- site_footer.html: Add site-specific footer -->
    7488    <div id="sitefooter">
    75       <!--! Place your footer content here... -->
     89      ## Place your footer content here...
    7690    </div>
    77   </body>
    78 </html>
    79 }}}
    80 
    81 Notice that XSLT bears some similarities with Genshi templates. However, there are some Trac specific features, for example the `${href.chrome('site/style.css')}` attribute references `style.css` in the 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-section|[trac] htdocs_location]] configuration setting.
    82 
    83 `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 and modify them.
    84 See [http://groups.google.com/group/trac-users/browse_thread/thread/70487fb2c406c937/ this thread] for a detailed explanation of the above example `site.html`.
    85 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.
     91    <!-- /site_footer.html -->
     92}}}
     93
     94Notice that as Jinja2 is mostly content agnostic, you are free to open some `<div>` element in the `site_header.html` file and only close it in `site_footer.html` file.
     95Besides, as in any other Trac Jinja2 template, you can use some Trac specific features, for example the `${href.chrome('site/style.css')}` attribute references `style.css` in the 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-htdocs_location-option "[trac] htdocs_location"] setting.
    8696
    8797Example snippet of adding introduction text to the new ticket form (but not shown during preview):
    8898
    89 {{{#!xml
    90 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
    91   <py:if test="req.path_info == '/newticket' and (not 'preview' in req.args)">
    92     <p>Please make sure to search for existing tickets before reporting a new one!</p>
    93   </py:if>
    94   ${select('*')}
    95 </form>
    96 }}}
    97 
    98 This example illustrates a technique of using `req.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.path_info == '/timeline'` condition in `<py:if>` test.
    99 
    100 More examples snippets for `site.html` can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
     99 - first we need to introduce the extra "content" of this notice, if it's appropriate for the request. For that, we add this snippet in the `site_footer.html` placeholder file:
     100  {{{#!xml
     101  # if req.path_info == '/newticket' and 'preview' not in req.args:
     102    <p id="ntg">Please make sure to search for existing tickets before reporting a new one!</p>
     103  # endif
     104  }}}
     105 - second, we need to dynamically alter the rest of the content in order to position that notice at the desired location. For that, we add this snippet to the `site_head.html` placeholder file:
     106
     107{{{#!xml
     108<script>
     109  jQuery(function($) {
     110    var $ntg = $("#newticketguide");
     111    if ($ntg.length)
     112      $("#propertyform").prepend($ntg.detach());
     113  });
     114</script>
     115}}}
     116
     117This example illustrates a technique of using `req.path_info` to limit scope of changes to one view only. For instance, to make changes only for timeline and avoid modifying other sections, use `req.path_info == '/timeline'` as the condition in a `# if` test.
     118
     119More examples snippets for placeholder files can be found at [trac:wiki:CookBook/SiteHtml CookBook/SiteHtml].
    101120
    102121Example snippets for `style.css` can be found at [trac:wiki:CookBook/SiteStyleCss CookBook/SiteStyleCss].
    103122
    104 Note that the `site.html`, despite its name, can be put in a shared templates directory, see the [[TracIni#inherit-section|[inherit] templates_dir]] option. This could provide easier maintainence as one new global `site.html` file can be made to include any existing header, footer and newticket snippets.
     123=== Sharing Templates in Multiple Environments
     124
     125The `site_*.html` templates, despite their name, can be put in a shared templates directory, see the [[TracIni#inherit-templates_dir-option|[inherit] templates_dir]] option. This could provide easier maintenance, as global `site_head.html`, `site_header.html` and `site_footer.html` files can be made to `# include` any other local existing header, footer and newticket snippets.
    105126
    106127== Project List #ProjectList
     
    109130
    110131The 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:
     132
     133FIXME
    111134
    112135{{{#!text/html
     
    142165}}}
    143166
    144 For [wiki:TracFastCgi FastCGI]:
     167For [TracFastCgi FastCGI]:
    145168{{{#!apache
    146169FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
     
    148171}}}
    149172
    150 For [wiki:TracModPython mod_python]:
     173For [TracModPython mod_python]:
    151174{{{#!apache
    152175PythonOption TracEnvParentDir /parent/dir/of/projects
     
    154177}}}
    155178
    156 For [wiki:TracCgi CGI]:
     179For [TracCgi CGI]:
    157180{{{#!apache
    158181SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
    159182}}}
    160183
    161 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
     184For TracStandalone, you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
    162185 - Unix:
    163186   {{{#!sh
     
    171194== Project Templates
    172195
    173 The appearance of each individual Trac environment, ie instance of a project, can be customized independently of other projects, even those hosted on the same server. The recommended way is to use a `site.html` template whenever possible, see [#SiteAppearance]. 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.
    174 
    175 With that word of caution, any Trac template may be copied and customized. The default Trac templates are located inside the installed Trac egg, such as `/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.
    176 
    177 However, do not edit templates or site resources inside the Trac egg. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
     196The appearance of each individual Trac environment, ie instance of a project, can be customized independently of other projects, even those hosted on the same server. The recommended way is to use `site_{head,header,footer}.html` templates whenever possible, see [#SiteAppearance]. Using `site_{head,header,footer}.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.
     197
     198With that word of caution, any Trac template may be copied and customized. The default Trac templates are located in the Trac egg or wheel, such as `/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 or wheel's `trac/htdocs` directory.
     199
     200However, do not edit templates or site resources inside the Trac egg/wheel. Reinstalling Trac overwrites your modifications. Instead use one of these alternatives:
    178201 * For a modification to one project only, copy the template to project `templates` directory.
    179  * 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.
    180 
    181 Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg.
     202 * For a modification shared by several projects, copy the template to a shared location and have each project point to this location using the [[TracIni#inherit-templates_dir-option|[inherit] templates_dir]] option.
     203
     204Trac resolves requests for a template by first looking inside the project, then in any inherited templates location, and finally inside the Trac egg or wheel.
    182205
    183206Trac caches templates in memory by default to improve performance. To apply a template you need to restart the web server.
    184207
    185208----
    186 See also TracGuide, TracIni
     209See also TracIni, TracNavigation