Changes between Version 2 and Version 3 of TracReports


Ignore:
Timestamp:
2012/06/16 22:07:38 (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v2 v3  
    1717  ''これによって、ナビゲーションバーの "チケットを見る" (英語版では "View Tickets") でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。'' 
    1818 
    19   '''''ほとんど確実に httpd を再起動する必要があるでしょう。''''' 
    2019 
    2120レポートは以下の基本的なパーツから構成されます: 
    22  * '''ID''' -- ユニークな (連番の) 識別子 
    23  * '''レポート名 (Title)''' -- レポートのタイトル 
    24  * '''説明 (Description)''' -- WikiFormatting で記述された、レポートの説明。 
    25  * '''レポート本体 (Report Body)''' -- 後に述べるフォーマットで規定された、レポートクエリの結果。 
    26  * '''フッタ (Footer)''' -- レポート本体を異なる形式でダウンロードするためのリンク。 
     21 * '''ID''' ユニークな (連番の) 識別子 
     22 * '''レポート名 (Title)''' レポートのタイトル 
     23 * '''説明 (Description)''' WikiFormatting で記述された、レポートの説明。 
     24 * '''レポート本体 (Report Body)''' 後に述べるフォーマットで規定された、レポートクエリの結果。 
     25 * '''フッタ (Footer)''' レポート本体を異なる形式でダウンロードするためのリンク。 
    2726 
    2827== ソートの並び順変更 == #ChangingSortOrder 
     
    3231 
    3332== レポートの番号を変更する == #ChangingReportNumbering 
    34 レポートの ID を変更する必要がある場合があるかもしれませんが、おそらくレポート自体を編集する方がベターです。というのも Trac のデータベースを変更する必要があるからです。 ''report'' 表は以下のようなスキーマとなっています (0.10 相当): 
     33レポートの ID を変更する必要がある場合があるかもしれませんが、おそらくレポート自体を編集する方がベターです。というのも Trac のデータベースを変更する必要があるからです。 ''report'' 表は以下のようなスキーマとなっています ''(0.10 以降)'': 
    3534 * id integer PRIMARY KEY 
    3635 * author text 
     
    4443メンテナンス結果、データベースの一貫性を保つ必要があることに留意してください (例えば ID はユニークでなければなりませんし、 SQLite などデータベースの上限値を超えることはできません)。 
    4544 
     45保存されたレポートやクエリのレポート番号も更新したり削除したりする必要があるでしょう。 
     46 
    4647== チケットをナビゲート == #NavigatingTickets 
    4748レポートクエリ結果の 1 チケットをクリックするとそのチケットが表示されるでしょう。表示されたチケットのメインメニューバーのすぐ下にある ''次のチケット'' (英語版では ''Next Ticket'') または ''前のチケット'' (英語版では ''Previous Ticket'') リンクをクリックすることによって他のチケットに移動するか、''レポートに戻る'' (英語版では ''Back to Report'') リンクをクリックしてレポートページに戻ることができます。 
    4849 
    49 あなたは安全にチケットを編集することができます。またチケットの編集結果を保存した後で、 次のチケット/前のチケット/レポートに戻る (英語版では Next/Previous/Back to Report) のリンクを使用して結果を行き来することが可能です。しかし、あなたがチケットへの操作を終えてレポートに戻るときに、どのチケットが変更されたかのヒントは表示されません。この動作はカスタムクエリの動作とは異なります。 (カスタムクエリについては TracQuery#NavigatingTickets を参照して下さい) 。 ''(0.11 以降 )'' 
     50あなたは安全にチケットを編集することができます。またチケットの編集結果を保存した後で、 ''次のチケット/前のチケット/レポートに戻る'' (英語版では ''!Next/Previous/Back to Report'') のリンクを使用して結果を行き来することが可能です。しかし、あなたがチケットへの操作を終えてレポートに戻るときに、どのチケットが変更されたかのヒントは表示されません。この動作はカスタムクエリの動作とは異なります。 (カスタムクエリについては TracQuery#NavigatingTickets を参照して下さい) 。 ''(0.11 以降 )'' 
    5051 
    5152== ダウンロードできるフォーマット == #AlternativeDownloadFormats 
     
    5657=== カンマ区切りテキスト - CSV (Comma Separated Values) === #Comma-delimited-CSVCommaSeparatedValues 
    57581 レコードを 1 行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。 
    58 '''Note:''' CSV 形式を保つため、各カラムのデータに改行文字やカンマがある場合、その位置で切り取られます。 
     59'''Note:''' 各カラムのデータに改行文字やカンマがある場合、エスケープされて出力されます。 
    5960 
    6061=== タブ区切り === #Tab-delimited 
     
    99100各カラムに対応する属性の詳細な説明は、 TracTickets に記述しています。 
    100101 
    101 '''優先度順、登録日時順の全未解決チケット''' 
    102  
    103 '''例:''' ''優先度順、登録日時順の全未解決チケット'' 
     102例: '''優先度順、登録日時順の全未解決チケット''' 
    104103{{{ 
    105104SELECT id AS ticket, status, severity, priority, owner,  
    106        time as created, summary FROM ticket  
     105       time AS created, summary FROM ticket  
    107106  WHERE status IN ('new', 'assigned', 'reopened') 
    108107  ORDER BY priority, time 
    109108}}} 
    110109 
    111  
    112 ---- 
    113  
     110--- 
    114111 
    115112== 上級トピック: 動的変数の使用 == #AdvancedReports:DynamicVariables 
     
    141138 
    142139=== 特殊な定数 === #SpecialConstantVariables 
    143 実用的なレポートのために、定義済みの動的変数が用意されています。これらは URL に値を設定しなくても、自動的に値が割り当てられます。 
     140実用的なレポートにするために、自動的に値が設定される動的変数が用意されています。(URL で指定されると上書かれます) 
    144141 
    145142 * $USER -- ログインに使用したユーザ名。 
     
    165162 
    166163=== 自動的に整形されるカラム名 === #Automaticallyformattedcolumns 
    167  * '''ticket''' -- チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。 (訳注: `summary` というカラム名もチケットにハイパーリンクされます。日本語版では `概要` でもリンクします。) 
    168  * '''created, modified, date, time''' -- 日付や時刻に整形されます。 (訳注: `datetime` という列名にすると日時で整形されます。日本語版では `時刻` で終わるカラムは `time` に、 `日付` で終わるカラムは `date` に、 `日時` で終わるカラムは `datetime` に、それぞれ整形されます。) 
    169  
    170  * '''description''' -- チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。 (訳注: 日本語版では `説明` でも整形されます。) 
     164 * '''ticket''' — チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます。 (訳注: `summary` というカラム名もチケットにハイパーリンクされます。日本語版では `概要` でもリンクします。) 
     165 * '''id''' — '''realm''' が指定されない場合は、 '''ticket''' と同じです。 
     166 * '''realm''' — '''id''' と同時に使用します。チケット以外のリソースにリンクを行う場合に使用します。 (e.g. ''wiki'' のレルムに ''id'' としてページ名を組み合わせると、 Wiki ページへのリンクを生成します) 
     167 * '''created, modified, date, time''' — 日付や時刻に整形されます。 (訳注: `datetime` という列名にすると日時で整形されます。日本語版では `時刻` で終わるカラムは `time` に、 `日付` で終わるカラムは `date` に、 `日時` で終わるカラムは `datetime` に、それぞれ整形されます。) 
     168 * '''description''' — チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます。 (訳注: 日本語版では `説明` でも整形されます。) 
    171169 
    172170'''例:''' 
    173171{{{ 
    174 SELECT id as ticket, created, status, summary FROM ticket  
    175 }}} 
     172SELECT id AS ticket, created, status, summary FROM ticket  
     173}}} 
     174 
     175これらのカラムは定義しても非表示にすることができます。方法は [#column-syntax 下記] を参照してください。 
     176 
     177''ticket'' 以外のレルムに対するレポートの作成方法については [http://trac.edgewall.org/wiki/CookBook/Configuration/Reports CookBook/Configuration/Reports] を参照してください。 
    176178 
    177179'''訳注''': Trac-0.11.1.ja1 以降のバージョンで作成した Environment では、デフォルトのレポートに日本語での整形ルールが適用されています。このような Environment を本家版 Trac で使用したい場合は各レポートの SQL を編集し、上記の日本語のカラム別名を英語に変更してください。 
     
    181183''整形用のヒント'' として扱われ、レコードの整形が行われます。 
    182184  
    183  * '''`__group__`''' -- 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。 
    184  * '''`__color__`''' -- 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。 
     185 * '''`__group__`''' — 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます。 
     186 * '''`__grouplink__`''' — グループ化した場合の各グループのヘッダで生成するリンク先の URL を指定します。この URL は各グループの最初の行にだけ付与されます。 
     187 * '''`__color__`''' — 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです。 
    185188{{{ 
    186189#!html 
     
    193196</div> 
    194197}}} 
    195  * '''`__style__`''' -- CSS 形式でレコードを整形できます。 
    196  
    197 '''例:''' ''マイルストーン別未解決チケット (優先度別色付け)'' 
     198 * '''`__style__`''' CSS 形式でレコードを整形できます。 
     199 
     200'''例:''' ''マイルストーン別未解決チケット (優先度別色付け, グループのヘッダでマイルストーンにリンク)'' 
    198201{{{ 
    199202SELECT p.value AS __color__, 
    200203     t.milestone AS __group__, 
     204     '../milestone/' || t.milestone AS __grouplink__, 
    201205     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    202206       t.id AS ticket, summary 
     
    210214取り出しています。 
    211215 
    212 === 行単位のレイアウト変更 === #Changinglayoutofreportrows 
     216=== 行単位のレイアウト変更 === #column-syntax 
    213217デフォルトでは、全てのカラムで1行を使い、上記の指定がされていれば、 
    214218フォーマットされた形式で HTML に表示されます。それだけでなく、 
    215219これから挙げる指定によって、複数行にわたってのレイアウトを行うことができます。 
    216220 
    217  * '''`column_`''' -- ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます。 
    218  
    219  * '''`_column_`''' -- ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます。 
    220  
    221  * '''`_column`'''  --  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います。 
     221 * '''`column_`''' — ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます。 
     222 
     223 * '''`_column_`''' — ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます。 
     224 
     225 * '''`_column`'''  —  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います。 
     226   この機能ではあらゆるカラムを非表示にできます。リソースの特定などで他のカラムが異存しているような場合に有用です。たとえば `id as _id` とすることで、 '''Id''' カラムは非表示となりますが、チケットへのリンクは正しく生成されます。 
    222227 
    223228'''例:''' ''アクティブなチケットを、マイルストーンでグループ化し、優先度で色付け、チケットの説明を multi-line レイアウトでリスト表示する''