Changes between Version 4 and Version 5 of TracReports


Ignore:
Timestamp:
12/23/12 14:06:38 (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v4 v5  
    1919 
    2020A report consists of these basic parts: 
    21  * '''ID''' -- Unique (sequential) identifier  
    22  * '''Title'''  -- Descriptive title 
    23  * '''Description'''  -- A brief description of the report, in WikiFormatting text. 
    24  * '''Report Body''' -- List of results from report query, formatted according to the methods described below. 
    25  * '''Footer''' -- Links to alternative download formats for this report. 
     21 * '''ID''' Unique (sequential) identifier  
     22 * '''Title''' Descriptive title 
     23 * '''Description''' A brief description of the report, in WikiFormatting text. 
     24 * '''Report Body''' List of results from report query, formatted according to the methods described below. 
     25 * '''Footer''' Links to alternative download formats for this report. 
    2626 
    2727== Changing Sort Order == 
     
    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,  
    107        time as created, summary FROM ticket  
     105       time AS created, summary FROM ticket  
    108106  WHERE status IN ('new', 'assigned', 'reopened') 
    109107  ORDER BY priority, time 
    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.  
    145  
    146  * $USER -- Username of logged in user. 
     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.  
     141 
     142 * $USER Username of logged in user. 
    147143 
    148144Example (''List all tickets assigned to me''): 
     
    166162 
    167163=== Automatically formatted columns === 
    168  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.  
    169  * '''id''' -- same as '''ticket''' above when '''realm''' is not set 
    170  * '''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) 
    171  * '''created, modified, date, time''' -- Format cell as a date and/or time. 
    172  * '''description''' -- Ticket description field, parsed through the wiki engine. 
     164 * '''ticket''' Ticket ID number. Becomes a hyperlink to that ticket.  
     165 * '''id''' same as '''ticket''' above when '''realm''' is not set 
     166 * '''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) 
     167 * '''created, modified, date, time''' Format cell as a date and/or time. 
     168 * '''description''' Ticket description field, parsed through the wiki engine. 
    173169 
    174170'''Example:''' 
    175171{{{ 
    176 SELECT id as ticket, created, status, summary FROM ticket  
     172SELECT id AS ticket, created, status, summary FROM ticket  
    177173}}} 
    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 === 
     
    183181assumed to be ''formatting hints'', affecting the appearance of the row. 
    184182  
    185  * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 
    186  * '''`__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. 
     183 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table. 
     184 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group. 
     185 * '''`__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. 
    187186{{{ 
    188187#!html 
     
    195194</div> 
    196195}}} 
    197  * '''`__style__`''' -- A custom CSS style expression to use for the current row.  
    198  
    199 '''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 
     196 * '''`__style__`''' A custom CSS style expression to use for the current row.  
     197 
     198'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority'' 
    200199{{{ 
    201200SELECT p.value AS __color__, 
    202201     t.milestone AS __group__, 
     202     '../milestone/' || t.milestone AS __grouplink__, 
    203203     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 
    204204       t.id AS ticket, summary 
     
    217217also possible to create multi-line report entries. 
    218218 
    219  * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 
    220  
    221  * '''`_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. 
    222  
    223  * '''`_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). 
     219 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line. 
     220 
     221 * '''`_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. 
     222 
     223 * '''`_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). 
    224224   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. 
    225225