Version 1 から Version 2 における更新: TracQuery

Timestamp:

Nov 29, 2010, 3:25:28 PM (13 years 前)

Author:

trac (IP: 127.0.0.1)

Comment:

--

TracQuery

@@ -1 @@
-= チケットクエリ = #TracTicketQueries
+= Trac Ticket Queries =
 [[TracGuideToc]]
 
-[wiki:TracReports レポート] に加えて、 Trac は ''カスタムチケットクエリ'' があります。 ''カスタムチケットクエリ'' は、ある一定の基準を満たすチケットのリストを表示するのに使用されます。
+In addition to [wiki:TracReports reports], Trac provides support for ''custom ticket queries'', used to display lists of tickets meeting a specified set of criteria. 
 
-カスタムクエリを設定・実行するために、ナビゲーションバーの ''チケットを見る'' (英語版では ''View tickets'') モジュールに切り替え、 ''カスタムクエリ'' (英語版では ''Custom Query'') のリンクを選択します。
+To configure and execute a custom query, switch to the ''View Tickets'' module from the navigation bar, and select the ''Custom Query'' link.
 
-== フィルタ == #Filters
-最初にクエリのページを開くと、デフォルトのフィルタとして、現在未解決のチケットの一覧が表示されます。ログインしているならば、自分が担当者となっていて未解決のチケットが表示されます。現在のフィルタは検索条件の右側にある "-" (マイナス) のラベルのボタンをクリックすることにより削除することができます。新しいフィルタをフィルタボックスの右下にあるプルダウンリストから追加することができます。テキストボックスやオプションのプルダウンメニューのフィルタを ''or'' 条件として、いくつでも追加することができます。
+== Filters ==
 
-フィルタボックスの下のフィールドを使用することによって、結果をフィールドごとにグループ化したり、各チケットの完全な説明を表示することができます。
+When you first go to the query page the default filter will display tickets relevant to you:
+ * If logged in then all open tickets it will display open tickets assigned to you.
+ * If not logged in but you have specified a name or email address in the preferences then it will display all open tickets where your email (or name if email not defined) is in the CC list.
+ * If not logged and no name/email defined in the preferences then all open issues are displayed.
 
-一度フィルタを編集したら、 ''更新'' (英語版では ''Update'') ボタンで結果を更新することができます。
+Current filters can be removed by clicking the button to the right with the minus sign on the label.  New filters are added from the pulldown lists at the bottom corners of the filters box ('And' conditions on the left, 'Or' conditions on the right).  Filters with either a text box or a pulldown menu of options can be added multiple times to perform an ''or'' of the criteria.
 
-== チケットナビゲーション == #NavigatingTickets
-クエリの結果の一つをクリックすると、そのチケットが表示されます。メインメニューバーの ''次のチケット'' (英語版では ''Next Ticket'') または ''前のチケット'' (英語版では ''Previous Ticket'') というリンクをクリックすることによって、クエリの結果を行き来することができます。 ''クエリに戻る'' (英語版では ''Back to Query'') というリンクをクリックすると、クエリのページに戻ります。
+You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.
 
-あなたは安全にチケットの編集をすることができ、編集を保存した後に ''次のチケット/前のチケット/クエリに戻る'' の各リンクを使用して、結果を行き来することができます。クエリに戻ったとき、 ''編集済みのチケット'' はイタリックのテキストで表示されます。チケットの 1 つが編集され、 [[html(<span style="color: grey">クエリの基準を満たさなくなった</span>)]] 場合、テキストはグレーで表示されます。最後に、 '''クエリの基準を満たす新しいチケットが登録される''' と、テキストが太字で表示されます。
+Once you've edited your filters click the ''Update'' button to refresh your results.
 
-クエリの結果は ''更新'' ボタンを押すごとにステータスがクリアされリフレッシュされます。
+== Navigating Tickets ==
+Clicking on one of the query results will take you to that ticket.  You can navigate through the results by clicking the ''Next Ticket'' or ''Previous Ticket'' links just below the main menu bar, or click the ''Back to Query'' link to return to the query page.  
 
-== クエリを保存する == #SavingQueries
+You can safely edit any of the tickets and continue to navigate through the results using the ''!Next/Previous/Back to Query'' links after saving your results.  When you return to the query ''any tickets which were edited'' will be displayed with italicized text.  If one of the tickets was edited such that [[html(<span style="color: grey">it no longer matches the query criteria </span>)]] the text will also be greyed. Lastly, if '''a new ticket matching the query criteria has been created''', it will be shown in bold. 
 
-Trac は今のところ、クエリに名前をつけて保存することも、 (訳注: レポート一覧のように) ナビゲート可能なリストを作ることもできませんが、以下に示すように Wiki のコンテンツとしてクエリへの参照を保存できます。
+The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
 
-=== TracLinks を使用する === #UsingTracLinks
+== Saving Queries ==
 
-クエリを保存しておくと、後から保存したクエリを再度実行できます。保存は Wiki ページにクエリへのリンクを作成することで行います。
+Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have ''Updated'' the view and then click the ''Save query'' button displayed beneath the results.
+You can also save references to queries in Wiki content, as described below.
+
+''Note:'' one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click ''Save query''. This will build the query string for you. All you need to do is remove the extra line breaks.
+
+=== Using TracLinks ===
+
+You may want to save some queries so that you can come back to them later.  You can do this by making a link to the query from any Wiki page.
 {{{
-[query:status=new|assigned|reopened&version=1.0 1.0 での未解決のチケット]
-
+[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
 }}}
 
-表示内容:
-  [query:status=new|assigned|reopened&version=1.0 1.0 での未解決のチケット]
+Which is displayed as:
+  [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
 
-ここでは、検索内容を特定するとても単純なクエリ言語が使用されています。 ([wiki:TracQuery#QueryLanguage クエリ言語] 参照)
+This uses a very simple query language to specify the criteria (see [wiki:TracQuery#QueryLanguage Query Language]).
 
-あるいは、クエリを実行した画面の URL をコピーし、 `?` 以降の文字列 (訳注: URL のパラメータ部) を Wiki リンクに貼り付けることができます:
+Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading `?` character:
 {{{
-[query:?status=new&status=assigned&status=reopened&group=owner 担当者別着手済みチケット]
-
+[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
 }}}
 
-表示内容:
-  [query:?status=new&status=assigned&status=reopened&group=owner 担当者別着手済みチケット]
+Which is displayed as:
+  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
 
-=== `[[TicketQuery]]` マクロを使用する === #UsingtheTicketQueryMacro
+=== Using the `[[TicketQuery]]` Macro ===
 
-!TicketQuery マクロは条件にマッチするチケットの一覧を表示します。 WikiFormatting が使用できるいずれの場所でも使用できます。
+The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
 
-例:
+Example:
 {{{
 [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
 }}}
 
-表示内容:
+This is displayed as:
   [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
 
-[wiki:TracQuery#UsingTracLinks query: Wiki リンク] 同様、このマクロのパラメータは [wiki:TracQuery#QueryLanguage クエリ言語] に規定されるルールに基づいたクエリ文字列で記述しなければなりません。
+Just like the [wiki:TracQuery#UsingTracLinks query: wiki links], the parameter of this macro expects a query string formatted according to the rules of the simple [wiki:TracQuery#QueryLanguage ticket query language].
 
-チケットのサマリを表示しない、よりコンパクトな表示も利用可能です:
+A more compact representation without the ticket summaries is also available:
 {{{
 [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
-
 }}}
 
-表示内容:
+This is displayed as:
   [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
 
-クエリにマッチした件数だけを取得したいのならば、 ``count`` パラメータを使用してください。
+Finally if you wish to receive only the number of defects that match the query using the ``count`` parameter.
 
 {{{
 [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
-
 }}}
 
-表示内容:
+This is displayed as:
   [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
 
+=== Customizing the ''table'' format ===
+You can also customize the columns displayed in the table format (''format=table'') by using ''col=<field>'' - you can specify multiple fields and what order they are displayed by placing pipes (`|`) between the columns like below:
 
-=== クエリ言語 === #QueryLanguage
+{{{
+[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
+}}}
 
-`query:` TracLinks と `[[TicketQuery]]` マクロは、いずれもクエリのフィルタを特定するために小さな "クエリ言語" を使用します。基本的に、フィルタはアンパサンド (`&`) で区切られます。それぞれのフィルタはチケットの各フィールドの名前、オペレータ、1つ以上の値で構成されています。値が複数ある場合はパイプ (`|`) で区切り、フィルタがいずれかの値にマッチすればいいことを意味しています。
+This is displayed as:
+[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
 
-オペレータ一覧:
-|| '''=''' || フィールドの内容はいずれかの値と完全に一致する ||
-|| '''~=''' || フィールドの内容は1つ以上の値を含む ||
-|| '''!^=''' || フィールドの内容が値の一つで始まる ||
-|| '''$=''' || フィールドの内容が値の一つで終了する ||
+==== Full rows ====
+In ''table'' format you can also have full rows by using ''rows=<field>'' like below:
 
-これらのオペレータは否定の意味があります:
-|| '''!=''' || フィールドの内容がいずれの値にも一致しない ||
-|| '''!~=''' || フィールドの内容がいずれの値も含んでいない ||
-|| '''!!^=''' || フィールドの内容がいずれの値でも始まらない ||
-|| '''!$=''' || フィールドの内容がいずれの値でも終わらない ||
+{{{
+[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
+}}}
+
+This is displayed as:
+[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
+
+
+=== Query Language ===
+
+`query:` TracLinks and the `[[TicketQuery]]` macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (`&`). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (`|`), meaning that the filter matches any of the values. To include a litteral `&` or `|` in a value, escape the character with a backslash (`\`).
+
+The available operators are:
+|| '''`=`''' || the field content exactly matches the one of the values ||
+|| '''`~=`''' || the field content contains one or more of the values ||
+|| '''`^=`''' || the field content starts with one of the values ||
+|| '''`$=`''' || the field content ends with one of the values ||
+
+All of these operators can also be negated:
+|| '''`!=`''' || the field content matches none of the values ||
+|| '''`!~=`''' || the field content does not contain any of the values ||
+|| '''`!^=`''' || the field content does not start with any of the values ||
+|| '''`!$=`''' || the field content does not end with any of the values ||
+
+The date fields `created` and `modified` can be constrained by using the `=` operator and specifying a value containing two dates separated by two dots (`..`). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be left out to avoid having to quote the query string. 
+|| '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 ||
+|| '''`created=lastmonth..thismonth`''' || query tickets created during the previous month ||
+|| '''`modified=1weekago..`''' || query tickets that have been modified in the last week ||
+|| '''`modified=..30daysago`''' || query tickets that have been inactive for the last 30 days ||
 
 ----