TicketQuery documentation improvement proposal

[AdrianFritz]

I believe this can improve a little bit TicketQuery documentation (rendered from source code found at ​http://trac.edgewall.org/browser/trunk/trac/ticket/query.py?rev=10750#L1178)

START

---

TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value", as follws:

[[TicketQuery([key=value][,key=value][,key=value]...)]]

If the key is the name of a ticket field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage.

• Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character.
• Commas (,) can be included in field values by escaping them with a backslash (\).

The date keys created and modified can also constrain the criteria. Again, see TracQuery#QueryLanguage.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

Key	Description & Details	Default
col	Pipe-separated list of columns and its order to show (requires format=table).	col=id|summary |owner|type| status|priority |milestone
desc	Reverse (true) the natural display order of the tickets.	desc=false
format1	Sets how the list of tickets is displayed: * list — ticket id next to the summary, each ticket on a separate line. * compact — comma-separated list of ticket ids. * count — the count of matching tickets * table — similar to the custom query view (but without the controls) * progress — a view similar to the milestone progress bars.	format=list
group	Sets the ticket field for grouping tickets.	None
groupdesc	Reverse (true) the natural display order of the groups.	groupdesc=false
max	Sets the limit number of tickets to display (max=0 means no maximum).	max=0
order	Sets the ticket field for ordering tickets.	order=id
rows	Pipe-separated list of ticket fields to be viewed as a row, e.g. rows=description|summary (requires format=table)	None
verbose	Get the description for the listed tickets (true). Use with format=table only. Deprecated (< 0.12) in favor of the rows key.	verbose=false

Note ¹

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format.

Note

Also, for compatibility with Trac 0.10, using "&" as a field separator still works (except for order) but is deprecated.