Changes between Version 6 and Version 7 of TracReports


Ignore:
Timestamp:
Mar 18, 2010, 8:29:15 PM (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracReports

    v6 v7  
    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:
     
    3029
    3130If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
     31
     32== Changing Report Numbering ==
     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 (as of 0.10):
     34 * id integer PRIMARY KEY
     35 * author text
     36 * title text
     37 * query text
     38 * description text
     39Changing the ID changes the shown order and number in the ''Available Reports'' list and the report's perma-link. This is done by running something like:
     40{{{
     41update report set id=5 where id=3;
     42}}}
     43Keep 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.
    3246
    3347== Navigating Tickets ==
     
    153167=== Automatically formatted columns ===
    154168 * '''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)
    155171 * '''created, modified, date, time''' -- Format cell as a date and/or time.
    156 
    157172 * '''description''' -- Ticket description field, parsed through the wiki engine.
    158173
     
    161176SELECT id as ticket, created, status, summary FROM ticket
    162177}}}
     178
     179Those columns can also be defined but marked as hidden, see [#column-syntax below].
    163180
    164181=== Custom formatting columns ===
     
    195212numeric representation from the ''enum'' table.
    196213
    197 === Changing layout of report rows ===
     214=== Changing layout of report rows === #column-syntax
    198215By default, all columns on each row are display on a single row in the HTML
    199216report, possibly formatted according to the descriptions above. However, it's
     
    205222
    206223 * '''`_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).
     224   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.
    207225
    208226'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     
    229247If 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.
    230248
    231 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.
     249If 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.
    232250
    233251'''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''