バージョン 11 から バージョン 12 における更新: TracDoc/TickTackBlogPlugin
- 更新日時:
- 2008/04/26 18:04:14 (17 年 前)
凡例:
- 変更なし
- 追加
- 削除
- 変更
-
TracDoc/TickTackBlogPlugin
v11 v12 1 2 = チケットでブログ - TickTackBlogプラグイン = 3 4 == 1. 概要 == 5 6 チケットに入力したブログを、タイムラインといっしょに表示するプラグインです。[[BR]]名前は、 '''Tic''' ket '''T''' r '''ack''' ingWe '''bLog''' の略です。タイムラインに分刻みで表示されるので、時計のチクタクと掛けてます。 7 8 ちょっとかわったブログとして使うのもよいですが、作業メモをちょこちょこと入力するのをお勧めします。[[BR]]ブログがタイムラインイベントと共に表示されるので、自分がなにをしたか後で見直すことができます。[[BR]] 9 10 [[Image(20060501001mini.png)]] 11 12 画面は2ペイン型にしてみました。Tracにはめずらしいですが、ブログでは一般的なので。 13 14 Trac0.9.xとTrac0.10.0に対応しています。 15 16 == 2. 主な機能 == 17 18 * ブログの表示[[BR]]特定の分類(Type)を指定したチケットをブログのように表示します。[[BR]][[BR]] 19 * タイムライン表示[[BR]]タイムラインを代替する機能。Wikiの作成やリポジトリへのチェックインといったタイムラインに表示できるアイテムは全て表示可能です(設定により非表示も可能)。[[BR]][[BR]] 20 * RSS[[BR]]Tracのタイムラインと異なり、ブログの登録のみRSSに出力します。[[BR]][[BR]] 21 22 == 3. セットアップ == 23 24 === 3.1 ダウンロード === 25 26 以下からダウンロードしてください。[[BR]]・[[Download2(TickTackBlogPlugin Version 0.1,TickTackBlogPlugin0.1,ticktackblogplugin,76)]][[BR]] 27 28 === 3.2 インストールとセットアップ === 29 30 TickTackBlogPluginのインストールを行います。[[FootNote(Tracのプラグインに共通する説明は、[wiki:TracPlugins TracPlugins]を参照してください。)]][[BR]] 31 32 ==== (1) eggの設置 ==== 33 34 zipを解凍してください。[[BR]]解凍して出来たフォルダ配下のsrcディレクトリに移動してください。[[BR]]以下のコマンドを実行して下さい: 35 1 36 {{{ 2 #!html 3 <h1 id="チケットでブログ - TickTackBlogプラグイン">チケットでブログ - TickTackBlogプラグイン</h1> <h2 id="1. 概要">1. 概要</h2> <p>チケットに入力したブログを、タイムラインといっしょに表示するプラグインです。<br />名前は、<strong>Tic</strong>ket<strong>T</strong>r<strong>ack</strong>ingWe<strong>bLog</strong>の略です。タイムラインに分刻みで表示されるので、時計のチクタクと掛けてます。</p>ちょっとかわったブログとして使うのもよいですが、作業メモをちょこちょこと入力するのをお勧めします。<br />ブログがタイムラインイベントと共に表示されるので、自分がなにをしたか後で見直すことができます。<br /><p>[[Image(20060501001mini.png)]]</p><p>画面は2ペイン型にしてみました。Tracにはめずらしいですが、ブログでは一般的なので。</p><p>Trac0.9.xとTrac0.10.0に対応しています。<br /></p><p>[[VisitCounter(TracDoc/TickTackBlogPlugin)]]</p> <h2 id="2. 主な機能">2. 主な機能</h2> <ul><li>ブログの表示<br />特定の分類(Type)を指定したチケットをブログのように表示します。<br /> <br /> </li><li>タイムライン表示<br />タイムラインを代替する機能。Wikiの作成やリポジトリへのチェックインといったタイムラインに表示できるアイテムは全て表示可能です(設定により非表示も可能)。<br /> <br /> </li><li>RSS<br />Tracのタイムラインと異なり、ブログの登録のみRSSに出力します。<br /><br /></li></ul> <h2 id="3. セットアップ">3. セットアップ</h2> <h3 id="3.1 ダウンロード">3.1 ダウンロード</h3> 以下からダウンロードしてください。<br /> ・[[Download2(TickTackBlogPlugin Version 0.1,TickTackBlogPlugin0.1,ticktackblogplugin,76)]]<br /> <h3 id="3.2 インストールとセットアップ">3.2 インストールとセットアップ</h3>TickTackBlogPluginのインストールを行います。[[FootNote(Tracのプラグインに共通する説明は、[wiki:TracPlugins TracPlugins]を参照してください。)]]<br /> <h4 id="(1) eggの設置 ">(1) eggの設置 </h4> <p>zipを解凍してください。<br /> 解凍して出来たフォルダ配下のsrcディレクトリに移動してください。<br /> 以下のコマンドを実行して下さい: </p> <pre class="wiki">$ python setup.py bdist_egg<br /></pre> <p> distフォルダが作成されます。<br /> その中にある*.eggファイルを、TracEnvのplugins ディレクトリにコピーしてください。<br /> </p> <h4 id="(2) Trac.iniの設定">(2) Trac.iniの設定</h4> TickTackBlogPluginを使用可能にするには、Trac.iniの[components]カテゴリに以下を加えてください。<br /> (pluginフォルダに置いた場合には不要)<br /> <pre>[componets]<br />ticktackblog.* = enabled<br /></pre>ここまでで、TickTackBlogPluginのインストールは終了です。メインメニューに「TickTackBlog」というメニューが追加されていると思います。<br /> ただし、まだ設定をしてないので、メニューを押してもブログは表示されません。<br /> 引き続き、ブログを表示するための設定を行ってください。<br /> <h4 id="(3) Trac.iniの設定">(3) Trac.iniの設定</h4> TracAdminスクリプトまたは、TracWebAdminを使用して、チケットの分類(Type)に「blog」を追加してください。<br />これで、チケットの分類(Type)を「blog」にしたチケットが、TickTackBlogに表示されます。[[FootNote(「blog」はTrac.iniに設定することで別の文字に変更可能です)]]<br />ためしに何かブログ(チケットのこと)を登録して、メニューバーのTickTackBlogをクリックしてみてください。( ̄▽ ̄)V <br /><h2 id="4. 使用方法">4. 使用方法</h2> メニューにある「TickTackBlog」をクリックしてください。あとは適当にさわればわかります。ヾ(・_・;) オイオイ<br /> <h2 id="5. カスタマイズ">5. カスタマイズ</h2><h3 id="5.1 Trac.ini ">5.1 Trac.ini </h3> Trac.iniの[ticktackblog]セクションを記載することで、TickTackBlogの動作をカスタマイズすることが出来ます。 <br />ちなみに、このサイトでは以下の指定を行っています。<br /><pre>[ticktackblog]<br />filter = ticket,ticket_comments,changeset,milestone,mailarchive<br />defaultauthor = weekbuild<br />tickettype = ブログ<br />title = ブログ<br /></pre> <br /> <strong> [ticktackblog</strong><strong>]</strong><br /> <table border=0 class=wiki > <tbody><tr><td>tickettype </td><td>ブログとして扱うチケットの分類(Type)を1つ指定します。(デフォルト:blog)<br /></td></tr><tr><td>defaultauthor </td><td>デフォルトで表示するユーザIDを指定します。(デフォルト:everyone)<br />現在は日付クリック時のURLがかわる以外は特になにも起こりません。<br /> </td></tr><tr><td>title </td><td> メニューバーに表示するタイトルを指定します。(デフォルト:!TickTackBlog)<br /></td></tr><tr><td>defaultdays <br /></td><td> 一覧に表記表示する日数を指定します。(デフォルト:5)<br /> </td></tr><tr><td>filter </td><td>タイムラインとして表示するイベントを指定します。<br />この項目がない場合は全てのイベントを表示します。(デフォルト)<br />表示したいタイムラインのフィルタ名を','(カンマ)区切りで指定してください。<br />ちなみに、以下にフィルタ名を挙げます。左がフィルタ名です。<br /><ul><li>!wiki:Wiki ページの更新</li><li>ticket:チケットの登録、ステータス変更</li><li>ticket_comments:チケットのコメント[[FootNote(TickTackBlogPluginに添付のタイムラインイベントです。ticketを指定しただけでは表示されないコメントも表示できます。#71参照)]]</li><li>ticket_details:チケットの詳細[[FootNote(ticket_detailsは、trac.iniの別の個所にも指定しないと表示されません。なお、ticket_detailsはticket_commentと出力するイベントが重複します。どちらかを指定してください。)]]</li><li>changeset:リポジトリへのチェックイン<br /> </li><li>milestone:マイルストーン</li><li>mailarchive:メールの受信(MailArchivePlugin使用時のみ)</li></ul> </td></tr></tbody> </table> <p> </p> <h3 id="4.2 サイドバーの表示 ">4.2 サイドバーの表示 </h3>特定のWikiページを登録しておくことで、TickTackBlogプラグインのサイドバー(右側のカレンダーの下)にコンテンツを表示できます。<br />Wikiのページ名は、上記(4.1)で指定した"[defaultauthorに指定したID]/TickTackWikiSide"にしてください。<br /><br /><pre>例:<br />everyone/TickTackWikiSide</pre> <h3 id=" 4.3 Templateを書き換える。"> 4.3 Templateを書き換える。</h3><strong>(注意):以下はClearSilverTemplateの知識がないと難しいです。</strong><br /><br /> 他のブログのように、簡単にレイアウトを変えることは出来ませんが、Templateファイルを直接編集することでレイアウトを変更可能です。[[FootNote(現在はまだユーザごとにTemplateを分けることは出来ません。1TracEnvにつき1Templateです)]]<br />ソースからticktackblog.csを取り出してTracEnvのTemplatesフォルダに置いてください。<br />で、そのファイルを適当に書き換えてください。もちろん、動作保証などありません。<br /><h2 id="5. 開発中のソースについて">5. 開発中のソースについて</h2>開発中の最新版は、[[Download2(ここ,TickTackBlogPluginDev,ticktackblogplugin,)]]から取得できます。<br />開発中のもののため動かない可能性もあります。<br /><h2 id="6. ご意見・ご要望">6. ご意見・ご要望</h2> ご意見・ご要望は[/trac/newticket?component=TickTackBlogPlugin こちら] から登録してください。<br /> これまでに登録されたものは[query:?component=TickTackBlogPlugin こちら] を参照してください。<br /> <br /> <br /> [[FootNote]]<br /> <br /> 37 $ python setup.py bdist_egg 4 38 }}} 39 40 distフォルダが作成されます。[[BR]]その中にある*.eggファイルを、TracEnvのplugins ディレクトリにコピーしてください。[[BR]] 41 42 ==== (2) Trac.iniの設定 ==== 43 44 TickTackBlogPluginを使用可能にするには、Trac.iniの[components]カテゴリに以下を加えてください。[[BR]](pluginフォルダに置いた場合には不要)[[BR]] 45 46 {{{ 47 [componets] 48 ticktackblog.* = enabled 49 }}} 50 ここまでで、TickTackBlogPluginのインストールは終了です。メインメニューに「TickTackBlog」というメニューが追加されていると思います。[[BR]]ただし、まだ設定をしてないので、メニューを押してもブログは表示されません。[[BR]]引き続き、ブログを表示するための設定を行ってください。[[BR]] 51 52 ==== (3) Trac.iniの設定 ==== 53 54 TracAdminスクリプトまたは、TracWebAdminを使用して、チケットの分類(Type)に「blog」を追加してください。[[BR]]これで、チケットの分類(Type)を「blog」にしたチケットが、TickTackBlogに表示されます。[[FootNote(「blog」はTrac.iniに設定することで別の文字に変更可能です)]][[BR]]ためしに何かブログ(チケットのこと)を登録して、メニューバーのTickTackBlogをクリックしてみてください。( ̄▽ ̄)V[[BR]] 55 56 == 4. 使用方法 == 57 58 メニューにある「TickTackBlog」をクリックしてください。あとは適当にさわればわかります。ヾ(・_・;) オイオイ[[BR]] 59 60 == 5. カスタマイズ == 61 62 === 5.1 Trac.ini === 63 64 Trac.iniの[ticktackblog]セクションを記載することで、TickTackBlogの動作をカスタマイズすることが出来ます。[[BR]]ちなみに、このサイトでは以下の指定を行っています。[[BR]] 65 66 {{{ 67 [ticktackblog] 68 filter = ticket,ticket_comments,changeset,milestone,mailarchive 69 defaultauthor = weekbuild 70 tickettype = ブログ 71 title = ブログ 72 }}} 73 [[BR]] '''[ticktackblog''' ''']''' [[BR]] 74 75 ||tickettype||ブログとして扱うチケットの分類(Type)を1つ指定します。(デフォルト:blog)[[BR]]|| 76 ||defaultauthor||デフォルトで表示するユーザIDを指定します。(デフォルト:everyone)[[BR]]現在は日付クリック時のURLがかわる以外は特になにも起こりません。[[BR]]|| 77 ||title||メニューバーに表示するタイトルを指定します。(デフォルト:!TickTackBlog)[[BR]]|| 78 ||defaultdays[[BR]]||一覧に表記表示する日数を指定します。(デフォルト:5)[[BR]]|| 79 ||filter||タイムラインとして表示するイベントを指定します。[[BR]]この項目がない場合は全てのイベントを表示します。(デフォルト)[[BR]]表示したいタイムラインのフィルタ名を','(カンマ)区切りで指定してください。[[BR]]ちなみに、以下にフィルタ名を挙げます。左がフィルタ名です。[[BR]]!wiki:Wiki ページの更新ticket:チケットの登録、ステータス変更ticket_comments:チケットのコメント[[FootNote(TickTackBlogPluginに添付のタイムラインイベントです。ticketを指定しただけでは表示されないコメントも表示できます。#71参照)]]ticket_details:チケットの詳細[[FootNote(ticket_detailsは、trac.iniの別の個所にも指定しないと表示されません。なお、ticket_detailsはticket_commentと出力するイベントが重複します。どちらかを指定してください。)]]changeset:リポジトリへのチェックイン[[BR]]milestone:マイルストーンmailarchive:メールの受信(MailArchivePlugin使用時のみ)|| 80 81 82 === 4.2 サイドバーの表示 === 83 84 特定のWikiページを登録しておくことで、TickTackBlogプラグインのサイドバー(右側のカレンダーの下)にコンテンツを表示できます。[[BR]]Wikiのページ名は、上記(4.1)で指定した"[defaultauthorに指定したID]/TickTackWikiSide"にしてください。[[BR]][[BR]] 85 86 {{{ 87 例: 88 everyone/TickTackWikiSide 89 }}} 90 91 === 4.3 Templateを書き換える。 === 92 '''(注意):以下はClearSilverTemplateの知識がないと難しいです。''' [[BR]][[BR]]他のブログのように、簡単にレイアウトを変えることは出来ませんが、Templateファイルを直接編集することでレイアウトを変更可能です。[[FootNote(現在はまだユーザごとにTemplateを分けることは出来ません。1TracEnvにつき1Templateです)]][[BR]]ソースからticktackblog.csを取り出してTracEnvのTemplatesフォルダに置いてください。[[BR]]で、そのファイルを適当に書き換えてください。もちろん、動作保証などありません。[[BR]] 93 94 == 5. 開発中のソースについて == 95 96 いったん停止 97 98 == 6. ご意見・ご要望 == 99 100 ご意見・ご要望は[/trac/newticket?component=TickTackBlogPlugin こちら] から登録してください。[[BR]]これまでに登録されたものは[query:?component=TickTackBlogPlugin こちら] を参照してください。[[BR]][[BR]][[BR]][[FootNote]][[BR]][[BR]]