Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
2009/10/03 12:40:44 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    1 = レポート = 
     1= レポート = #TracReports 
    22[[TracGuideToc]] 
    33 
     
    1515  trac.ticket.report.* = disabled 
    1616  }}} 
    17   ''これによって、ナビゲーションバーの "チケットを見る" でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。'' 
     17  ''これによって、ナビゲーションバーの "チケットを見る" (英語版では "View Tickets") でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。'' 
     18 
     19  '''''ほとんど確実に httpd を再起動する必要があるでしょう。''''' 
    1820 
    1921レポートは以下の基本的なパーツから構成されます: 
     
    2426 * '''フッタ (Footer)''' -- レポート本体を異なる形式でダウンロードするためのリンク。 
    2527 
    26 == ソートの並び順変更 == 
     28== ソートの並び順変更 == #ChangingSortOrder 
    2729単純なレポート (特にグループ化されていないもの) では、カラムのヘッダをクリックすれば、そのカラムでソートすることが出来ます。 
    2830 
    2931カラムのヘッダがハイパーリンク (赤) になっていれば、クリックすることでそのカラムでのソートができます。並び順を逆にするには、もう一度クリックします。 
    3032 
    31  
    32 == ダウンロードできるフォーマット == 
     33== レポートの番号を変更する == #ChangingReportNumbering 
     34レポートの ID を変更する必要がある場合があるかもしれませんが、おそらくレポート自体を編集する方がベターです。というのも Trac のデータベースを変更する必要があるからです。 ''report'' 表は以下のようなスキーマとなっています (0.10 相当): 
     35 * id integer PRIMARY KEY 
     36 * author text 
     37 * title text 
     38 * query text 
     39 * description text 
     40ID を変更すると ''レポート一覧 (Available Reports)'' での表示順と番号、レポートのパーマリンクが変更されます。以下のような SQL を実行すると ID が変更されます: 
     41{{{ 
     42update report set id=5 where id=3; 
     43}}} 
     44メンテナンス結果、データベースの一貫性を保つ必要があることに留意してください (例えば ID はユニークでなければなりませんし、 SQLite などデータベースの上限値を超えることはできません)。 
     45 
     46== チケットをナビゲート == #NavigatingTickets 
     47レポートクエリ結果の 1 チケットをクリックするとそのチケットが表示されるでしょう。表示されたチケットのメインメニューバーのすぐ下にある ''次のチケット'' (英語版では ''Next Ticket'') または ''前のチケット'' (英語版では ''Previous Ticket'') リンクをクリックすることによって他のチケットに移動するか、''レポートに戻る'' (英語版では ''Back to Report'') リンクをクリックしてレポートページに戻ることができます。 
     48 
     49あなたは安全にチケットを編集することができます。またチケットの編集結果を保存した後で、 次のチケット/前のチケット/レポートに戻る (英語版では Next/Previous/Back to Report) のリンクを使用して結果を行き来することが可能です。しかし、あなたがチケットへの操作を終えてレポートに戻るときに、どのチケットが変更されたかのヒントは表示されません。この動作はカスタムクエリの動作とは異なります。 (カスタムクエリについては TracQuery#NavigatingTickets を参照して下さい) 。 ''(0.11 以降 )'' 
     50 
     51== ダウンロードできるフォーマット == #AlternativeDownloadFormats 
    3352通常表示される HTML でのビューの加え、レポートはいろいろな形式で使用することができます。 
    3453レポートページの一番下に、利用可能なデータ形式の一覧があります。望む形式のリンクをクリックすれば、 
    3554その形式でのレポートをダウンロードすることができます。 
    3655 
    37 === カンマ区切りテキスト - CSV (Comma Separated Values) === 
     56=== カンマ区切りテキスト - CSV (Comma Separated Values) === #Comma-delimited-CSVCommaSeparatedValues 
    38571 レコードを 1 行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。 
    3958'''Note:''' CSV 形式を保つため、各カラムのデータに改行文字やカンマがある場合、その位置で切り取られます。 
    4059 
    41 === タブ区切り === 
     60=== タブ区切り === #Tab-delimited 
    4261CSV と似ていますが、水平タブ文字 (\t) で区切られる点が違います。 
    4362 
    44 === RSS - XML Content Syndication === 
     63=== RSS - XML コンテンツ配信 === #RSS-XMLContentSyndication 
    4564全てのレポートは、 XML/RSS 2.0 での配信が可能です。 RSS フィードを購読するにはページ下部にある、オレンジ色の 'XML' アイコンをクリックしてください。 Trac での RSS 対応についての一般的な情報は、 TracRss に記述しています。 
    4665 
    4766---- 
    4867 
    49 == カスタムレポートを作成する == 
     68== カスタムレポートを作成する == #CreatingCustomReports 
    5069 
    5170''カスタムレポートを作成するためには、 SQL を楽に書ける程度の知識が必要です。'' 
     
    5877SELECT 文となります。 
    5978 
    60 == Ticket 表のカラム == 
     79== Ticket 表のカラム == #Ticketcolumns 
    6180''ticket'' 表は、以下のカラムを持ちます: 
    6281 * id           -- チケットID 
     82 * type         -- チケット分類 
    6383 * time         -- 登録日時 
    6484 * changetime   -- 最終更新日時 
     
    7595 * summary      -- チケットの概要 
    7696 * description  -- チケットについての完全な説明 
     97 * keywords     -- キーワード 
    7798 
    7899各カラムに対応する属性の詳細な説明は、 TracTickets に記述しています。 
     
    92113 
    93114 
    94 == 上級トピック: 動的変数の使用 == 
     115== 上級トピック: 動的変数の使用 == #AdvancedReports:DynamicVariables 
    95116レポートに汎用性を持たせる手段として、 ''動的変数'' をレポート SQL で使用する方法があります。 
    96117簡単に言うと、動的変数とは、クエリを実行する前に置き換えられる ''特別な'' 文字列のことです。 
    97118 
    98 === クエリで動的変数を使う方法 === 
     119=== クエリで動的変数を使う方法 === #UsingVariablesinaQuery 
    99120動的変数を使うためのシンタックスは単純です。 '$' に続いて、大文字で変数名となる語を挿入してください。 
    100121 
    101122例: 
    102123{{{ 
    103 SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY' 
     124SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY 
    104125}}} 
    105126 
     
    119140 
    120141 
    121 === 特殊な定数 === 
     142=== 特殊な定数 === #SpecialConstantVariables 
    122143実用的なレポートのために、定義済みの動的変数が用意されています。これらは URL に値を設定しなくても、自動的に値が割り当てられます。 
    123144 
     
    126147例 (''私が担当になっているチケット一覧''): 
    127148{{{ 
    128 SELECT id AS ticket,summary FROM ticket WHERE owner='$USER' 
    129 }}} 
    130  
    131  
    132 ---- 
    133  
    134  
    135 == 上級トピック: 表示形式のカスタマイズ == 
     149SELECT id AS ticket,summary FROM ticket WHERE owner=$USER 
     150}}} 
     151 
     152 
     153---- 
     154 
     155 
     156== 上級トピック: 表示形式のカスタマイズ == #AdvancedReports:CustomFormatting 
    136157Trac には、レイアウトのカスタマイズや、グルーピング、ユーザ定義の CSS 利用などによる 
    137158もっと複雑なレポートの作成も可能です。このようなレポートを作成するには、  
    138159Trac のレポートエンジンが出力を制御するためのステートメントを含む、特別な SQL を使用します。 
    139160 
    140 == 特別なカラム == 
     161== 特別なカラム == #SpecialColumns 
    141162レポートを整形するため、 TracReports はクエリの結果から '特定の' カラム名を 
    142163探します。このような '特定の' 名前で、最終的なレポートのレイアウトやスタイルが 
    143164処理され、変更されます。 
    144165 
    145 === 自動的に整形されるカラム名 === 
    146  * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。 
    147  * '''created, modified, date, time''' -- 日付や時刻に整形されます。 
    148  
    149  * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。 
     166=== 自動的に整形されるカラム名 === #Automaticallyformattedcolumns 
     167 * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。 (訳注: `summary` というカラム名もチケットにハイパーリンクされます。日本語版では `概要` でもリンクします。) 
     168 * '''created, modified, date, time''' -- 日付や時刻に整形されます。 (訳注: `datetime` という列名にすると日時で整形されます。日本語版では `時刻` で終わるカラムは `time` に、 `日付` で終わるカラムは `date` に、 `日時` で終わるカラムは `datetime` に、それぞれ整形されます。) 
     169 
     170 * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。 (訳注: 日本語版では `説明` でも整形されます。) 
    150171 
    151172'''例:''' 
     
    154175}}} 
    155176 
    156 === 整形されるカラムのカスタマイズ === 
     177'''訳注''': Trac-0.11.1.ja1 以降のバージョンで作成した Environment では、デフォルトのレポートに日本語での整形ルールが適用されています。このような Environment を本家版 Trac で使用したい場合は各レポートの SQL を編集し、上記の日本語のカラム別名を英語に変更してください。 
     178 
     179=== 整形されるカラムのカスタマイズ === #Customformattingcolumns 
    157180カラム名の前後に 2 つのアンダースコアがついている場合 (例: '''`__color__`''') は、  
    158181''整形用のヒント'' として扱われ、レコードの整形が行われます。 
     
    160183 * '''`__group__`''' -- 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。 
    161184 * '''`__color__`''' -- 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。 
     185{{{ 
     186#!html 
     187<div style="margin-left:7.5em">デフォルトの色付け:  
     188<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span> 
     189<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span> 
     190<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span> 
     191<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span> 
     192<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span> 
     193</div> 
     194}}} 
    162195 * '''`__style__`''' -- CSS 形式でレコードを整形できます。 
    163196 
     
    177210取り出しています。 
    178211 
    179 === 行単位のレイアウト変更 === 
     212=== 行単位のレイアウト変更 === #Changinglayoutofreportrows 
    180213デフォルトでは、全てのカラムで1行を使い、上記の指定がされていれば、 
    181214フォーマットされた形式で HTML に表示されます。それだけでなく、 
     
    207240}}} 
    208241 
    209 === カスタムフィールドをレポートで使用する === 
    210  
    211 チケットにカスタムフィールドを追加した場合(バージョン 0.8 では実験的な機能でした。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。 
     242=== カスタムフィールドをレポートで使用する === #Reportingoncustomfields 
     243 
     244チケットにカスタムフィールドを追加した場合(バージョン 0.8 以降の機能。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。 
    212245 
    213246追加のフィールドを trac.ini に宣言する ''前に'' 、チケットがデータベースに存在する場合、 ticket_custom テーブルには関連するデータを持たないことになります。これに起因する問題を回避するためには SQL の "LEFT OUTER JOIN" 節を使用してください。 
    214247 
    215 ---- 
    216 See also: TracTickets, TracQuery, TracGuide 
     248'''Note レポートの追加、編集をするボタンを表示するためには権限を設定する必要があります。''' 
     249 
     250---- 
     251See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]