Changes between Version 5 and Version 6 of TracReports


Ignore:
Timestamp:
04/06/12 16:33:29 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v5 v6  
    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  '''''You will almost definitely need to restart your httpd at this point.'''''
    2021
    2122A 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.
     23 * '''ID''' -- Unique (sequential) identifier
     24 * '''Title'''  -- Descriptive title
     25 * '''Description'''  -- A brief description of the report, in WikiFormatting text.
     26 * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
     27 * '''Footer''' -- Links to alternative download formats for this report.
    2728
    2829== Changing Sort Order ==
     
    3233
    3334== Changing Report Numbering ==
    34 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 ''(since 0.10)'':
     35There 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):
    3536 * id integer PRIMARY KEY
    3637 * author text
     
    4445Keep 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).
    4546
    46 You may also need to update or remove the report number stored in the report or query.
    47 
    4847== Navigating Tickets ==
    4948Clicking 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.
    5049
    51 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)''
    5251
    5352== Alternative Download Formats ==
     
    5857=== Comma-delimited - CSV (Comma Separated Values) ===
    5958Export the report as plain text, each row on its own line, columns separated by a single comma (',').
    60 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
     59'''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.
    6160
    6261=== Tab-delimited ===
     
    7473A report is basically a single named SQL query, executed and presented by
    7574Trac.  Reports can be viewed and created from a custom SQL expression directly
    76 in the web interface.
     75in from the web interface.
    7776
    7877Typically, a report consists of a SELECT-expression from the 'ticket' table,
     
    101100See TracTickets for a detailed description of the column fields.
    102101
    103 Example: '''All active tickets, sorted by priority and time'''
     102'''all active tickets, sorted by priority and time'''
     103
     104'''Example:''' ''All active tickets, sorted by priority and time''
    104105{{{
    105106SELECT id AS ticket, status, severity, priority, owner,
    106        time AS created, summary FROM ticket
     107       time as created, summary FROM ticket
    107108  WHERE status IN ('new', 'assigned', 'reopened')
    108109  ORDER BY priority, time
    109110}}}
    110111
    111 ---
     112
     113----
     114
    112115
    113116== Advanced Reports: Dynamic Variables ==
     
    138141
    139142
    140 === !Special/Constant Variables ===
    141 There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
    142 
    143  * $USER Username of logged in user.
     143=== Special/Constant Variables ===
     144There 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.
    144147
    145148Example (''List all tickets assigned to me''):
     
    163166
    164167=== 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.
     168 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket.
     169 * '''created, modified, date, time''' -- Format cell as a date and/or time.
     170
     171 * '''description''' -- Ticket description field, parsed through the wiki engine.
    170172
    171173'''Example:'''
    172174{{{
    173 SELECT id AS ticket, created, status, summary FROM ticket
    174 }}}
    175 
    176 Those columns can also be defined but marked as hidden, see [#column-syntax below].
    177 
    178 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     175SELECT id as ticket, created, status, summary FROM ticket
     176}}}
    179177
    180178=== Custom formatting columns ===
     
    182180assumed to be ''formatting hints'', affecting the appearance of the row.
    183181 
    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.
     182 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
     183 * '''`__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.
    187184{{{
    188185#!html
     
    195192</div>
    196193}}}
    197  * '''`__style__`''' A custom CSS style expression to use for the current row.
    198 
    199 '''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     194 * '''`__style__`''' -- A custom CSS style expression to use for the current row.
     195
     196'''Example:''' ''List active tickets, grouped by milestone, colored by priority''
    200197{{{
    201198SELECT p.value AS __color__,
    202199     t.milestone AS __group__,
    203      '../milestone/' || t.milestone AS __grouplink__,
    204200     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    205201       t.id AS ticket, summary
     
    213209numeric representation from the ''enum'' table.
    214210
    215 === Changing layout of report rows === #column-syntax
     211=== Changing layout of report rows ===
    216212By default, all columns on each row are display on a single row in the HTML
    217213report, possibly formatted according to the descriptions above. However, it's
    218214also possible to create multi-line report entries.
    219215
    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).
    225    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.
     216 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.
     217
     218 * '''`_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.
     219
     220 * '''`_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).
    226221
    227222'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    254249----
    255250See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]
    256