Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Feb 24, 2010 5:37:18 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v1 v2  
    1717  ''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.''
    1818
    19   '''''You will almost definitely need to restart your httpd at this point.'''''
    2019
    2120A report consists of these basic parts:
     
    4342}}}
    4443Keep 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).
     44
     45You may also need to update or remove the report number stored in the report or query.
    4546
    4647== Navigating Tickets ==
     
    166167=== Automatically formatted columns ===
    167168 * '''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)
    168171 * '''created, modified, date, time''' -- Format cell as a date and/or time.
    169 
    170172 * '''description''' -- Ticket description field, parsed through the wiki engine.
    171173
     
    174176SELECT id as ticket, created, status, summary FROM ticket
    175177}}}
     178
     179Those columns can also be defined but marked as hidden, see [#column-syntax below].
    176180
    177181=== Custom formatting columns ===
     
    180184 
    181185 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
     186 * '''`__grouplink__`''' -- Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
    182187 * '''`__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.
    183188{{{
     
    193198 * '''`__style__`''' -- A custom CSS style expression to use for the current row.
    194199
    195 '''Example:''' ''List active tickets, grouped by milestone, colored by priority''
     200'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
    196201{{{
    197202SELECT p.value AS __color__,
    198203     t.milestone AS __group__,
     204     '../milestone/' || t.milestone AS __grouplink__,
    199205     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    200206       t.id AS ticket, summary
     
    208214numeric representation from the ''enum'' table.
    209215
    210 === Changing layout of report rows ===
     216=== Changing layout of report rows === #column-syntax
    211217By default, all columns on each row are display on a single row in the HTML
    212218report, possibly formatted according to the descriptions above. However, it's
     
    218224
    219225 * '''`_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).
     226   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.
    220227
    221228'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    242249If you have added custom fields to your tickets (a feature since v0.8, see TracTicketsCustomFields), you can write a SQL query to cover them. You'll need to make a join on the ticket_custom table, but this isn't especially easy.
    243250
    244 If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See TracIniReportCustomFieldSample for some examples.
     251If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See [trac:TracIniReportCustomFieldSample TracIniReportCustomFieldSample] for some examples.
    245252
    246253'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''