Trees Indices Help
Trac
Package trac :: Package ticket :: Module query :: Class TicketQueryMacro

Class TicketQueryMacro

source code

 object --+ 
 | 
 core.Component --+ 
 | 
wiki.macros.WikiMacroBase --+
 |
 TicketQueryMacro

Wiki macro listing tickets that match certain criteria.
This macro accepts a comma-separated list of keyed parameters,
in the form "key=value".
If the key is the name of a 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 (`\`).
Groups of field constraints to be OR-ed together can be separated by a
litteral `or` argument.
In addition to filters, several other named parameters can be used
to control how the results are presented. All of them are optional.
The `format` parameter determines how the list of tickets is
presented: 
 - '''list''' -- the default presentation is to list the ticket ID next
 to the summary, with each ticket on a separate line.
 - '''compact''' -- the tickets are presented as a comma-separated
 list of ticket IDs. 
 - '''count''' -- only the count of matching tickets is displayed
 - '''table''' -- a view similar to the custom query view (but without
 the controls)
The `max` parameter can be used to limit the number of tickets shown
(defaults to '''0''', i.e. no maximum).
The `order` parameter sets the field used for ordering tickets
(defaults to '''id''').
The `desc` parameter indicates whether the order of the tickets
should be reversed (defaults to '''false''').
The `group` parameter sets the field used for grouping tickets
(defaults to not being set).
The `groupdesc` parameter indicates whether the natural display
order of the groups should be reversed (defaults to '''false''').
The `verbose` parameter can be set to a true value in order to
get the description for the listed tickets. For '''table''' format only.
''deprecated in favor of the `rows` parameter''
The `rows` parameter can be used to specify which field(s) should 
be viewed as a row, e.g. `rows=description|summary`
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`.
Also, using "&" as a field separator still works (except for `order`)
but is deprecated.
Nested Classes

Inherited from core.Component : __metaclass__

Instance Methods
expand_macro(self, formatter, name, content) source code
__init__(self, compmgr, init=None, cls=<class 'trac.ticket.query.TicketQueryMacro'>)
x.__init__(...) initializes x; see help(type(x)) for signature source code

Inherited from wiki.macros.WikiMacroBase : get_macro_description , get_macros , parse_macro

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
parse_args(content)
Parse macro arguments and translate them to a query string. source code

Inherited from core.Component : __new__ , implements

Class Variables
Properties

Inherited from object: __class__

Method Details

expand_macro(self, formatter, name, content)

source code
Overrides: wiki.macros.WikiMacroBase.expand_macro

__init__(self, compmgr, init=None, cls=<class 'trac.ticket.query.TicketQueryMacro'>)
(Constructor)

source code
x.__init__(...) initializes x; see help(type(x)) for signature
Overrides: object.__init__
(inherited documentation)

Trees Indices Help
Trac

AltStyle によって変換されたページ (->オリジナル) /