Edgewall Software

Changes between Version 44 and Version 45 of TracReports


Ignore:
Timestamp:
Apr 10, 2010, 6:45:51 PM (14 years ago)
Author:
Christian Boos
Comment:

copied from 0.12/TracReports@5

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v44 v45  
     1** Note: this page documents the 0.12 version of Trac, see [[0.11/TracReports]] if you need the previous version **
    12= Trac Reports =
    23[[TracGuideToc]]
     
    3132
    3233== Changing Report Numbering ==
    33 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):
     34There 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)'':
    3435 * id integer PRIMARY KEY
    3536 * author text
     
    4849Clicking 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.
    4950
    50 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)''
     51You 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)''
    5152
    5253== Alternative Download Formats ==
     
    5758=== Comma-delimited - CSV (Comma Separated Values) ===
    5859Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    59 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
     60'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    6061
    6162=== Tab-delimited ===
     
    7374A report is basically a single named SQL query, executed and presented by
    7475Trac.  Reports can be viewed and created from a custom SQL expression directly
    75 in from the web interface.
     76in the web interface.
    7677
    7778Typically, a report consists of a SELECT-expression from the 'ticket' table,
     
    100101See TracTickets for a detailed description of the column fields.
    101102
    102 '''all active tickets, sorted by priority and time'''
    103 
    104 '''Example:''' ''All active tickets, sorted by priority and time''
     103Example: '''All active tickets, sorted by priority and time'''
    105104{{{
    106105SELECT id AS ticket, status, severity, priority, owner,
     
    110109}}}
    111110
    112 
    113 ----
    114 
     111---
    115112
    116113== Advanced Reports: Dynamic Variables ==
     
    141138
    142139
    143 === Special/Constant Variables ===
    144 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL.
     140=== !Special/Constant Variables ===
     141There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    145142
    146143 * $USER -- Username of logged in user.
     
    179176Those columns can also be defined but marked as hidden, see [#column-syntax below].
    180177
     178See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     179
    181180=== Custom formatting columns ===
    182181Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     
    184183 
    185184 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
     185 * '''`__grouplink__`''' -- Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    186186 * '''`__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.
    187187{{{
     
    197197 * '''`__style__`''' -- A custom CSS style expression to use for the current row.
    198198
    199 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     199'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    200200{{{
    201201SELECT p.value AS __color__,
    202202     t.milestone AS __group__,
     203     '../milestone/' || t.milestone AS __grouplink__,
    203204     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    204205       t.id AS ticket, summary