Changes between Version 1 and Version 2 of TracReports
- Время:
- 13 апр. 2009 г., 12:52:51 (17 лет назад)
Обозначения:
- Без изменений
- Добавлено
- Удалено
- Изменено
-
TracReports
v1 v2 17 17 ''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.'' 18 18 19 '''''You will almost definitely need to restart your httpd at this point.''''' 19 20 20 21 A report consists of these basic parts: 21 * '''ID''' —Unique (sequential) identifier22 * '''Title''' —Descriptive title23 * '''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.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. 26 27 27 28 == Changing Sort Order == … … 31 32 32 33 == 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 ''(since 0.10)'':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 (as of 0.10): 34 35 * id integer PRIMARY KEY 35 36 * author text … … 43 44 Keep 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 45 45 You may also need to update or remove the report number stored in the report or query.46 47 46 == Navigating Tickets == 48 47 Clicking 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. 49 48 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)''49 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)'' 51 50 52 51 == Alternative Download Formats == … … 57 56 === Comma-delimited - CSV (Comma Separated Values) === 58 57 Export the report as plain text, each row on its own line, columns separated by a single comma (','). 59 '''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.58 '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure. 60 59 61 60 === Tab-delimited === 62 Like above, but uses tabs ( \t) instead of comma.61 Like above, but uses tabs ( ) instead of comma. 63 62 64 63 === RSS - XML Content Syndication === … … 73 72 A report is basically a single named SQL query, executed and presented by 74 73 Trac. Reports can be viewed and created from a custom SQL expression directly 75 in the web interface.74 in from the web interface. 76 75 77 76 Typically, a report consists of a SELECT-expression from the 'ticket' table, … … 100 99 See TracTickets for a detailed description of the column fields. 101 100 102 Example: '''All active tickets, sorted by priority and time''' 101 '''all active tickets, sorted by priority and time''' 102 103 '''Example:''' ''All active tickets, sorted by priority and time'' 103 104 {{{ 104 105 SELECT id AS ticket, status, severity, priority, owner, 105 time AScreated, summary FROM ticket106 time as created, summary FROM ticket 106 107 WHERE status IN ('new', 'assigned', 'reopened') 107 108 ORDER BY priority, time 108 109 }}} 109 110 110 --- 111 112 ---- 113 111 114 112 115 == Advanced Reports: Dynamic Variables == … … 137 140 138 141 139 === !Special/Constant Variables ===140 There 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.142 === Special/Constant Variables === 143 There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL. 144 145 * $USER -- Username of logged in user. 143 146 144 147 Example (''List all tickets assigned to me''): … … 162 165 163 166 === Automatically formatted columns === 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. 167 * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 168 * '''created, modified, date, time''' -- Format cell as a date and/or time. 169 170 * '''description''' -- Ticket description field, parsed through the wiki engine. 169 171 170 172 '''Example:''' 171 173 {{{ 172 SELECT id AS ticket, created, status, summary FROM ticket 173 }}} 174 175 Those columns can also be defined but marked as hidden, see [#column-syntax below]. 176 177 See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''. 174 SELECT id as ticket, created, status, summary FROM ticket 175 }}} 178 176 179 177 === Custom formatting columns === … … 181 179 assumed to be ''formatting hints'', affecting the appearance of the row. 182 180 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. 181 * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table. 182 * '''`__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. 186 183 {{{ 187 184 #!html … … 194 191 </div> 195 192 }}} 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''193 * '''`__style__`''' -- A custom CSS style expression to use for the current row. 194 195 '''Example:''' ''List active tickets, grouped by milestone, colored by priority'' 199 196 {{{ 200 197 SELECT p.value AS __color__, 201 198 t.milestone AS __group__, 202 '../milestone/' || t.milestone AS __grouplink__,203 199 (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__, 204 200 t.id AS ticket, summary … … 212 208 numeric representation from the ''enum'' table. 213 209 214 === Changing layout of report rows === #column-syntax210 === Changing layout of report rows === 215 211 By default, all columns on each row are display on a single row in the HTML 216 212 report, possibly formatted according to the descriptions above. However, it's 217 213 also possible to create multi-line report entries. 218 214 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). 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. 215 * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line. 216 217 * '''`_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. 218 219 * '''`_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 220 226 221 '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with description and multi-line layout''
