Dreditor templates and macros

Last updated February 4, 2013.

Intro

This page and child pages are meant to mitigate the issue handling process by providing a tool and stock responses and issue state transitions. Watch the video demo.

The tool is provided by dreditor currently as a sandbox project.

The templates and macros are defined by this pages children.

Template or stock response

A stock response is just a standard text. But it mostly has an Issue State Transition as a side effect.

Macro or issue state transition

Each issue undergoes a transition every time a new comment is added. Most times there is not just a comment added but also changes to other fields.

Notes

The _default page is intended for all projects which is a little blunt. The audience of each individual project is different. So feel free to add your own special page under this pages parent. This is provided by #1133104: auto discovery of new project specific stock responses

Why are those pages similar to http://drupal.org/node/467548? That page is used by editor tools as an ease of use. For dreditor to work the pages should be strong structured.

Please do not mesh with these child pages before contacting Clemens Tolboom

Child page structure

Each child page must be named like this "dreditor_project-name [Internal use page for the dreditor project]"

The prefix dreditor_ and postix [Internal use page for the dreditor project] are there for two reasons

1. Make sure tracker users are not confused about a page update
2. Dreditor needs to page the title string

These pages give us the possibility to define a tree containing labels, issue field setters and comment snippets.

For implementing Stock Response and/or Issue State Transition we need a structure to organize them. The page is processed into an UL / LI presented to the dreditor user.

The page structure is as follows:

DL : the top level definition list
- DT : A grouping element followed by an optional macro.
- DD : an optional description used for the Issue comment when clicked or
- DD followed by a (nested) DL : sub options for nuanced text

Each DT must contain text optional followed by macro's.

A macro is structured like @status(2) for setting an issue value or @duplicate_issue(?) for prompting for an issue number.

A DD may contain text followed by an optional DL

The DD text may contain getters like @duplicate_issue().

Supported field names are: title, project_title, assigned, component, category, priority, status, comment, tags

Depending on the field type the value is either appended or replaced. I.e. Comments and Tags are appended.

Macro's

Macro's can be used for the following fields:

• title
• project_title
• version
• assigned
• component
• category
• priority
• status
• comment
• tags

The field names can be used by the following set, get and old. They are not used when prompting a value.

set

Setting issue status: @status(3)
Adding an issue tag: @tags(needs documentation)

get

Enrich comments: @duplicate_project()

old

Filtering on old or current issue status: @oldStatus(active)

prompt

Ask the user to provide a value: @duplicate_issue(?)

Supported are duplicate_issue and duplicate_project are defined.

Example

Note: the above is an issue status oriented tree which is not the only way to manage issues. We need to consider this when implementing a real workflow.

References

Views Bug Squad Handbook
Bugsquad / Triage - Mitigating the developers pain