Edgewall Software

Changes between Version 5 and Version 6 of 0.12/TracReports


Ignore:
Timestamp:
Jul 16, 2012, 9:16:12 PM (7 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracReports

    v5 v6  
    1 ** Note: this page was used to prepare the 0.12 version of wiki:/TracReports, see now directly that toplevel page **
     1** Note: this page documents the 0.12 version of Trac, see [[0.11/TracReports]] if you need the previous version **
    22= Trac Reports =
    33[[TracGuideToc]]
     
    1818  ''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.''
    1919
    20 
    2120A report consists of these basic parts:
    22  * '''ID''' -- Unique (sequential) identifier
    23  * '''Title'''  -- Descriptive title
    24  * '''Description'''  -- A brief description of the report, in WikiFormatting text.
    25  * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
    26  * '''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.
    2726
    2827== Changing Sort Order ==
     
    141140There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    142141
    143  * $USER -- Username of logged in user.
     142 * $USER Username of logged in user.
    144143
    145144Example (''List all tickets assigned to me''):
     
    163162
    164163=== Automatically formatted columns ===
    165  * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
    166  * '''id''' -- same as '''ticket''' above when '''realm''' is not set
    167  * '''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)
    168  * '''created, modified, date, time''' -- Format cell as a date and/or time.
    169  * '''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.
    170169
    171170'''Example:'''
     
    182181assumed to be ''formatting hints'', affecting the appearance of the row.
    183182 
    184  * '''`__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.
    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.
     196 * '''`__style__`''' A custom CSS style expression to use for the current row.
    198197
    199198'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     
    218217also possible to create multi-line report entries.
    219218
    220  * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
    221 
    222  * '''`_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.
    223 
    224  * '''`_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).
    225224   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.
    226225