Edgewall Software

Changes between Version 3 and Version 4 of 0.12/TracReports


Ignore:
Timestamp:
Mar 30, 2010, 1:55:50 AM (12 years ago)
Author:
mark.m.mcmahon@…
Comment:

CSV is now escaped, Added a link to the Reports cookbook, other minor changes

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracReports

    v3 v4  
    3131
    3232== 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):
     33There 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)'':
    3434 * id integer PRIMARY KEY
    3535 * author text
     
    4848Clicking 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.
    4949
    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)''
     50You 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)''
    5151
    5252== Alternative Download Formats ==
     
    5757=== Comma-delimited - CSV (Comma Separated Values) ===
    5858Export 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.
     59'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
    6060
    6161=== Tab-delimited ===
     
    7373A report is basically a single named SQL query, executed and presented by
    7474Trac.  Reports can be viewed and created from a custom SQL expression directly
    75 in from the web interface.
     75in the web interface.
    7676
    7777Typically, a report consists of a SELECT-expression from the 'ticket' table,
     
    100100See TracTickets for a detailed description of the column fields.
    101101
    102 '''all active tickets, sorted by priority and time'''
    103 
    104 '''Example:''' ''All active tickets, sorted by priority and time''
     102Example: '''All active tickets, sorted by priority and time'''
    105103{{{
    106104SELECT id AS ticket, status, severity, priority, owner,
     
    110108}}}
    111109
    112 
    113 ----
    114 
     110---
    115111
    116112== Advanced Reports: Dynamic Variables ==
     
    141137
    142138
    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.
     139=== !Special/Constant Variables ===
     140There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    145141
    146142 * $USER -- Username of logged in user.
     
    178174
    179175Those columns can also be defined but marked as hidden, see [#column-syntax below].
     176
     177See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
    180178
    181179=== Custom formatting columns ===