Changes between Version 1 and Version 2 of TracReports

Timestamp:

Sep 2, 2010 9:48:15 AM (15 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.''
 
+
 A report consists of these basic parts:
  * '''ID''' -- Unique (sequential) identifier 
@@ -29 +30 @@
 If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
 
+== 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):
+ * id integer PRIMARY KEY
+ * author text
+ * title text
+ * query text
+ * description text
+Changing the ID changes the shown order and number in the ''Available Reports'' list and the report's perma-link. This is done by running something like:
+{{{
+update report set id=5 where id=3;
+}}}
+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)''
 
 == Alternative Download Formats ==
@@ -61 +81 @@
 The ''ticket'' table has the following columns:
  * id
+ * type
  * time
  * changetime
@@ -75 +96 @@
  * summary
  * description
+ * keywords
 
 See TracTickets for a detailed description of the column fields.
@@ -101 +123 @@
 Example:
 {{{
-SELECT id AS ticket,summary FROM ticket WHERE priority='$PRIORITY'
-}}}
-
-To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the the leading '$'.
+SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
+}}}
+
+To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'.
 
 Example:
 {{{
- http://projects.edgewall.com/trac/reports/14?PRIORITY=high
+ http://trac.edgewall.org/reports/14?PRIORITY=high
 }}}
 
@@ -115 +137 @@
 Example:
 {{{
- http://projects.edgewall.com/trac/reports/14?PRIORITY=high&SEVERITY=critical
+ http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
 }}}
 
@@ -126 +148 @@
 Example (''List all tickets assigned to me''):
 {{{
-SELECT id AS ticket,summary FROM ticket WHERE owner='$USER'
+SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
 }}}
 
@@ -145 +167 @@
 === Automatically formatted columns ===
  * '''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.
 
@@ -153 +176 @@
 SELECT id as ticket, created, status, summary FROM ticket 
 }}}
+
+Those columns can also be defined but marked as hidden, see [#column-syntax below].
 
 === Custom formatting columns ===
@@ -160 +185 @@
  * '''`__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.
+{{{
+#!html
+<div style="margin-left:7.5em">Defaults: 
+<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
+<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
+<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
+<span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
+<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
+</div>
+}}}
  * '''`__style__`''' -- A custom CSS style expression to use for the current row. 
 
@@ -177 +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
@@ -187 +222 @@
 
  * '''`_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''
@@ -209 +245 @@
 === Reporting on custom fields ===
 
-If you have added custom fields to your tickets (experimental feature in v0.8, see TracTicketsCustomFields), you can write a SQL query to cover them. You'll need to make a join on the ticket_custom table, but this isn't especially easy.
-
-If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See TracIniReportCustomFieldSample for some examples.
-
-----
-See also: TracTickets, TracQuery, TracGuide
+If you have added custom fields to your tickets (a feature since v0.8, see TracTicketsCustomFields), you can write a SQL query to cover them. You'll need to make a join on the ticket_custom table, but this isn't especially easy.
+
+If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See [trac:TracIniReportCustomFieldSample TracIniReportCustomFieldSample] for some examples.
+
+'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''
+
+----
+See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]