Changes between Version 1 and Version 2 of TracReports

Timestamp:

Aug 2, 2010, 3:26:14 PM (14 years ago)

Author:

trac

Comment:

--

TracReports

@@ -17 +17 @@
   ''This will make the query module the default handler for the “View Tickets” navigation item. We encourage you to try this configuration and report back what kind of features of reports you are missing, if any.''
 
-  '''''You will almost definitely need to restart your httpd at this point.'''''
 
 A report consists of these basic parts:
- * '''ID''' -- Unique (sequential) identifier 
- * '''Title'''  -- Descriptive title
- * '''Description'''  -- A brief description of the report, in WikiFormatting text.
- * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
- * '''Footer''' -- Links to alternative download formats for this report.
+ * '''ID''' — Unique (sequential) identifier 
+ * '''Title''' — Descriptive title
+ * '''Description''' — A brief description of the report, in WikiFormatting text.
+ * '''Report Body''' — List of results from report query, formatted according to the methods described below.
+ * '''Footer''' — Links to alternative download formats for this report.
 
 == Changing Sort Order ==
@@ -32 +31 @@
 
 == Changing Report Numbering ==
-There may be instances where you need to change the ID of the report, perhaps to organize the reports better. At present this requires changes to the trac database. The ''report'' table has the following schema (as of 0.10):
+There may be instances where you need to change the ID of the report, perhaps to organize the reports better. At present this requires changes to the trac database. The ''report'' table has the following schema ''(since 0.10)'':
  * id integer PRIMARY KEY
  * author text
@@ -44 +43 @@
 Keep in mind that the integrity has to be maintained (i.e., ID has to be unique, and you don't want to exceed the max, since that's managed by SQLite someplace).
 
+You may also need to update or remove the report number stored in the report or query.
+
 == Navigating Tickets ==
 Clicking on one of the report 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 Report'' link to return to the report page.
 
-You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Report links after saving your results, but when you return to the report, there will be no hint about what has changed, as would happen if you were navigating a list of tickets obtained from a query (see TracQuery#NavigatingTickets). ''(since 0.11)''
+You can safely edit any of the tickets and continue to navigate through the results using the ''!Next/Previous/Back to Report'' links after saving your results, but when you return to the report, there will be no hint about what has changed, as would happen if you were navigating a list of tickets obtained from a query (see TracQuery#NavigatingTickets). ''(since 0.11)''
 
 == Alternative Download Formats ==
@@ -56 +57 @@
 === Comma-delimited - CSV (Comma Separated Values) ===
 Export the report as plain text, each row on its own line, columns separated by a single comma (',').
-'''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
+'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
 
 === Tab-delimited ===
@@ -72 +73 @@
 A report is basically a single named SQL query, executed and presented by
 Trac.  Reports can be viewed and created from a custom SQL expression directly
-in from the web interface.
+in the web interface.
 
 Typically, a report consists of a SELECT-expression from the 'ticket' table,
@@ -99 +100 @@
 See TracTickets for a detailed description of the column fields.
 
-'''all active tickets, sorted by priority and time'''
-
-'''Example:''' ''All active tickets, sorted by priority and time''
+Example: '''All active tickets, sorted by priority and time'''
 {{{
 SELECT id AS ticket, status, severity, priority, owner, 
-       time as created, summary FROM ticket 
+       time AS created, summary FROM ticket 
   WHERE status IN ('new', 'assigned', 'reopened')
   ORDER BY priority, time
 }}}
 
-
-----
-
+---
 
 == Advanced Reports: Dynamic Variables ==
@@ -140 +137 @@
 
 
-=== Special/Constant Variables ===
-There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL. 
-
- * $USER -- Username of logged in user.
+=== !Special/Constant Variables ===
+There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports. 
+
+ * $USER — Username of logged in user.
 
 Example (''List all tickets assigned to me''):
@@ -165 +162 @@
 
 === Automatically formatted columns ===
- * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 
- * '''created, modified, date, time''' -- Format cell as a date and/or time.
-
- * '''description''' -- Ticket description field, parsed through the wiki engine.
+ * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket. 
+ * '''id''' — same as '''ticket''' above when '''realm''' is not set
+ * '''realm''' — together with '''id''', can be used to create links to other resources than tickets (e.g. a realm of ''wiki'' and an ''id'' to a page name will create a link to that wiki page)
+ * '''created, modified, date, time''' — Format cell as a date and/or time.
+ * '''description''' — Ticket description field, parsed through the wiki engine.
 
 '''Example:'''
 {{{
-SELECT id as ticket, created, status, summary FROM ticket 
-}}}
+SELECT id AS ticket, created, status, summary FROM ticket 
+}}}
+
+Those columns can also be defined but marked as hidden, see [#column-syntax below].
+
+See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
 
 === Custom formatting columns ===
@@ -179 +181 @@
 assumed to be ''formatting hints'', affecting the appearance of the row.
  
- * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
- * '''`__color__`''' -- Should be a numeric value ranging from 1 to 5 to select a pre-defined row color. Typically used to color rows by issue priority.
+ * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
+ * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
+ * '''`__color__`''' — Should be a numeric value ranging from 1 to 5 to select a pre-defined row color. Typically used to color rows by issue priority.
 {{{
 #!html
@@ -191 +194 @@
 </div>
 }}}
- * '''`__style__`''' -- A custom CSS style expression to use for the current row. 
-
-'''Example:''' ''List active tickets, grouped by milestone, colored by priority''
+ * '''`__style__`''' — A custom CSS style expression to use for the current row. 
+
+'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
 {{{
 SELECT p.value AS __color__,
      t.milestone AS __group__,
+     '../milestone/' || t.milestone AS __grouplink__,
      (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
        t.id AS ticket, summary
@@ -208 +212 @@
 numeric representation from the ''enum'' table.
 
-=== Changing layout of report rows ===
+=== Changing layout of report rows === #column-syntax
 By default, all columns on each row are display on a single row in the HTML
 report, possibly formatted according to the descriptions above. However, it's
 also possible to create multi-line report entries.
 
- * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
-
- * '''`_column_`''' -- ''Full row''. By adding an underscore ('_') both at the beginning and the end of a column name, the data will be shown on a separate row.
-
- * '''`_column`'''  --  ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML).
+ * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
+
+ * '''`_column_`''' — ''Full row''. By adding an underscore ('_') both at the beginning and the end of a column name, the data will be shown on a separate row.
+
+ * '''`_column`''' — ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML).
+   This can be used to hide any kind of column, even important ones required for identifying the resource, e.g. `id as _id` will hide the '''Id''' column but the link to the ticket will be present.
 
 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''