Changes between Version 3 and Version 4 of TracInterfaceCustomization
- Timestamp:
- Jan 28, 2010, 4:25:36 AM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracInterfaceCustomization
v3 v4 1 = Trac のインタフェースをカスタマイズする=1 = Customizing the Trac Interface = 2 2 [[TracGuideToc]] 3 3 4 == イントロダクション==5 このページは Trac の外観をカスタマイズする方法をユーザに提案するために書きました。主要な話題は HTML テンプレートと CSS ファイルであり、プログラムコードではありません。特定のニーズを満たすために Trac の外観を変更する方法を、ユーザに示すことを意図しています。 Trac の全てのユーザにとって有益な、インタフェース変更の提案は、このページに書くのではなくチケットを使用してください。 [[BR]] '''(訳注: 本家サイトのチケットの話です)''' 4 == Introduction == 5 This page is meant to give users suggestions on how they can customize the look of Trac. Topics on this page cover editing the HTML templates and CSS files, but not the program code itself. The topics are intended to show users how they can modify the look of Trac to meet their specific needs. Suggestions for changes to Trac's interface applicable to all users should be filed as tickets, not listed on this page. 6 6 7 == プロジェクトのロゴとアイコン==8 T rac のインタフェースをカスタマイズする中で、最も簡単なのは、ロゴとサイトアイコンです。両方とも [wiki:TracIni trac.ini] に設定するだけで構成できます。7 == 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 9 10 ロゴやアイコンのイメージは、 Trac Environment フォルダの中の "htdocs" というフォルダに置かなければいけません。 (''Note: バージョン 0.9 以前の Trac で作成したプロジェクトでは、このフォルダを自分で作成する必要があります'')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 11 12 ''Note: 実際、ロゴとアイコンはサーバのどこのパスにおいてもかまいません(Web サーバがアクセスできるところならですが)。 そして、設定の中でそれらの絶対またはサーバの相対 URL を使用します。''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 13 14 [wiki:TracIni trac.ini] の適切なセクションの構成は以下の通りです:14 Now configure the appropriate section of your [wiki:TracIni trac.ini]: 15 15 16 === ロゴ===17 `src` の設定を `site/` に続く画像ファイルの名前に変更してください。 `width` と `height` は画像ファイルにあわせて設定を変更してください。(Trac の chrome ハンドラはプロジェクトのディレクトリ `htdocs` と "`common/`" の中のファイル用に "`site/`" を使用します。) 16 === 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). 18 18 19 19 {{{ … … 25 25 }}} 26 26 27 === アイコン===28 アイコンは `.gif` か `.ico` 形式の 16x16 の画像である必要があります。 `icon` の設定を `site/` に続くアイコンファイルの名前に変更してください。アイコンは通常、サイトの URL の横や、 `ブックマーク` メニューに表示されます。 27 === Icon === 28 Icons should be a 16x16 image in `.gif` or `.ico` format. Change the `icon` setting to `site/` followed by the name of your icon file. Icons will typically be displayed by your web browser next to the site's URL and in the `Bookmarks` menu. 29 29 30 30 {{{ … … 33 33 }}} 34 34 35 Note : Internet Explorer では、ホストのルートディレクトリにある ``favicon.ico`` という名前のファイルしか許容しないため、このアイコンは無視されます。プロジェクトアイコンを IE と他のブラウザで共用したい場合、アイコンをホストのドキュメントルートに配置し、 ``trac.ini`` から以下のように参照します:35 Note though that this icon is ignored by Internet Explorer, which only accepts a file named ``favicon.ico`` at the root of the host. To make the project icon work in both IE and other browsers, you can store the icon in the document root of the host, and reference it from ``trac.ini`` as follows: 36 36 37 37 {{{ … … 40 40 }}} 41 41 42 == サイトヘッダとサイトフッタ == 42 == 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 (but not for adding new ones). 43 44 44 それぞれのプロジェクトの Trac Environment フォルダには {{{templates}}} ディレクトリがあります。このフォルダには {{{site_header.cs}}} と {{{site_footer.cs}}} というファイルがあります。これらのファイルに HTML マークアップされた内容を追加することで、ユーザは Trac サイトをカスタマイズできます。2つのファイルはサイト内で {{{<body>}}} タグの直後と、 {{{</body>}}} タグの直前にそれぞれ展開されます。 45 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 . 46 {{{ 47 [mainnav] 48 wiki.label = Home 49 tickets.href = /report/24 45 50 46 これらのファイルでは、静的な HTML を記述することが出来ます。動的に生成されるコンテンツを置きたい場合、 [http://www.clearsilver.net/ ClearSilver] テンプレート言語も使用できます。テンプレートで利用可能な変数を見たい場合、 Trac に接続している URL にクエリ文字列 `?hdfdump=1` を追加してください。テンプレートデータを構造化表示できます。 47 48 == サイト CSS == 49 Trac サイトのレイアウトを調整する主な方法は [http://www.w3.org/TR/REC-CSS2/ CSS] にスタイルのルールを追加し、デフォルトのルールをオーバレイすることです。このためのベストなやり方は、 Trac Environment の `templates` ディレクトリにあるファイル `site_css.cs` を編集することです。 テンプレートから取得したコンテンツは、 Trac が生成する全ての HTML ページで `<style type="text/css"></style>` 要素に挿入されます。 50 51 カスタマイズしたスタイルのルールを `site_css.cs` ファイルに直接書くことも出来ますが、単に外部のスタイルシートへの参照を記述するのを推奨します。その結果、応答のたびにルールを送信するのではなく、ブラウザが CSS ファイルをキャッシュするのを可能にします。 52 53 この例はホストの `style` ディレクトリに配置したスタイルシートをインポートする書き方です: 54 {{{ 55 @import url(/style/mytrac.css); 51 [metanav] 52 help = disabled 56 53 }}} 57 54 58 !ClearSilver の変数を使用することで、 Trac Environment の `htdocs` ディレクトリに格納したスタイルシートを参照させることが出来ます。 55 See also TracNavigation for a more detailed explanation of the mainnav and metanav terms. 56 57 == Site Appearance == 58 59 Trac 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. 60 61 Say 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: 63 59 64 {{{ 60 @import url(<?cs var:chrome.href ?>/site/style.css); 65 #!xml 66 <html xmlns="http://www.w3.org/1999/xhtml" 67 xmlns:py="http://genshi.edgewall.org/" 68 py:strip=""> 69 70 <!--! Add site-specific style sheet --> 71 <head py:match="head" py:attrs="select('@*')"> 72 ${select('*|comment()|text()')} 73 <link rel="stylesheet" type="text/css" 74 href="${href.chrome('site/style.css')}" /> 75 </head> 76 77 <body py:match="body" py:attrs="select('@*')"> 78 <!--! Add site-specific header --> 79 <div id="siteheader"> 80 <!--! Place your header content here... --> 81 </div> 82 83 ${select('*|text()')} 84 85 <!--! Add site-specific footer --> 86 <div id="sitefooter"> 87 <!--! Place your footer content here... --> 88 </div> 89 </body> 90 </html> 91 }}} 92 Note that this references your environment's `htdocs/style.css`. 93 94 Example snippet of adding introduction text to the new ticket form (hide when preview): 95 96 {{{ 97 #!xml 98 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"> 99 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> 100 <p>Please make sure to search for existing tickets before reporting a new one!</p> 101 </py:if> 102 ${select('*')} 103 </form> 61 104 }}} 62 105 63 == プロジェクトリスト == 64 複数の Trac プロジェクトを動かしているときに、ClearSilver テンプレートをカスタマイズして、プロジェクトの一覧を表示することができます。 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: 107 {{{ 108 #!xml 109 <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')" 110 xmlns:xi="http://www.w3.org/2001/XInclude"> 111 <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> 112 <xi:include href="site_newticket.cs"><xi:fallback /></xi:include> 113 </py:if> 114 ${select('*')} 115 </form> 116 }}} 65 117 66 以下に示すのは Trac が使用しているプロジェクトのリンクリストを表示するための基本のテンプレートです。ロードできないプロジェクトについては、エラーメッセージを表示します。これをあなた自身のインデックステンプレートのスタートポイントとして使用することができます。 118 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. 119 120 == Project List == 121 You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects. 122 123 The 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. 67 124 68 125 {{{ 69 126 #!text/html 70 <html> 71 <head><title>プロジェクト一覧</title></head> 72 <body> 73 <h1>プロジェクト一覧</h1> 74 <ul><?cs 75 each:project = projects ?><li><?cs 76 if:project.href ?> 77 <a href="<?cs var:project.href ?>" title="<?cs var:project.description ?>"> 78 <?cs var:project.name ?></a><?cs 79 else ?> 80 <small><?cs var:project.name ?>: <em>エラー</em> <br /> 81 (<?cs var:project.description ?>)</small><?cs 82 /if ?> 83 </li><?cs 84 /each ?> 85 </ul> 86 </body> 127 <!DOCTYPE html 128 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 129 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 130 <html xmlns="http://www.w3.org/1999/xhtml" 131 xmlns:py="http://genshi.edgewall.org/" 132 xmlns:xi="http://www.w3.org/2001/XInclude"> 133 <head> 134 <title>Available Projects</title> 135 </head> 136 <body> 137 <h1>Available Projects</h1> 138 <ul> 139 <li py:for="project in projects" py:choose=""> 140 <a py:when="project.href" href="$project.href" 141 title="$project.description">$project.name</a> 142 <py:otherwise> 143 <small>$project.name: <em>Error</em> <br /> ($project.description)</small> 144 </py:otherwise> 145 </li> 146 </ul> 147 </body> 87 148 </html> 88 149 }}} 89 150 90 いったんカスタムテンプレートを作ると、web サーバにテンプレートのロケーションの設定を読み込ませる必要があります:151 Once 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): 91 152 92 [wiki:TracFastCgi FastCGI] 用:153 For [wiki:TracFastCgi FastCGI]: 93 154 {{{ 94 155 FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \ … … 96 157 }}} 97 158 98 [wiki:TracModPython mod_python] 用:159 For [wiki:TracModPython mod_python]: 99 160 {{{ 100 161 PythonOption TracEnvIndexTemplate /path/to/template 101 162 }}} 102 163 103 [wiki:TracCgi CGI] 用:164 For [wiki:TracCgi CGI]: 104 165 {{{ 105 166 SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template 106 167 }}} 107 168 108 109 == メインテンプレート == 110 111 Trac の [http://www.clearsilver.net/ ClearSilver] テンプレートについても、カスタマイズしたバージョンを使用することが出来ます。 Note: Trac をアップグレードするときに多くの問題が発生するので、このテクニックは推奨されません: 残念ながら、テンプレートとアプリケーションコードの間には、フォームフィールドの名前やテンプレートデータの構造など、いくつか依存関係があります。また、これらは今後の Trac のバージョン間で互換性を持たないこともあります。 112 113 どうしてもテンプレートを変更する必要があるなら、デフォルトのテンプレートディレクトリ (通常は `$prefix/share/trac/templates`) から、 Trac Environment の `templates` ディレクトリにテンプレートファイルをコピーして、必要な結果が得られるようにコピーの方を変更してください。 169 For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd: 170 - Unix 171 {{{ 172 #!sh 173 $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template 174 }}} 175 - Windows 176 {{{ 177 #!sh 178 $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template 179 }}} 114 180 115 181 ----