Deprecated since version 0.2.0.
.. needfilter:: :status: open;in_progress :tags: user;login :types: req;Specification :filter: "my_tag" in tags and ("another_tag" in tags or "closed" in status) :show_status: :show_tags: :show_filters: :show_legend: :sort_by: id :layout: list
This prints a list of needs matching the filters for the
Separate the values for the
:types: options with “;”.
:filter: gets evaluated.
The logic to check if a need belongs to the
needfilter result list, is:
status = (open OR in_progress) AND tags = (user OR login) AND types = (req OR spec) AND eval(filter) is True
:types: option, you can use the type itself and the human-readable type_title as filter value.
show_status / show_tags¶
If you set the
:show_tags: options, the related information will be shown after the name of the need.
To show the used filters under a list, set the
:show_legend: option is supported only if
:layout: diagram. It adds a legend with colors to the generated diagram.
You can sort the showed list by setting the
Valid options for
:sort_by: are id and status.
Please read the common filter page Filtering needs for more detailed information about filter possibilities.
Three different types of layouts are available:
Only the list layout supports each
table and diagram only supports filter options (status, tags, types, filter) and their design is somehow fix.
Diagrams are available only, if the sphinx extension sphinxcontrib-plantuml is installed, activated and has a working configuration.
If the configured output is svg, the diagram elements are linked to the location of their definition.