projectdoc Toolbox

Lists macros that allow to select from a fixed set of values. These macros are used to define the range of document property values. So they are a tool for template authors.

Audience

The selection macro is a quick option to select from a list of values. The drawback is that this list of values is not extendable by authors. Also there is no description defined by the team for those values. If neither of this is a problem, use one of the section macros. If you want to have more control over those values consider to define a new doctype and use the Name List Macro to select from them.

List of Selection Macros

The following macros allow to select a value from a defined range of values.

Actor Type Macro
Allows to select the type of an actor.
Communication Type Macro
Allows to select the type of communication between two entities.
Complexity
Allows to select the complexity for an item.
Day Rating
Allows a user to select a rating for a day.
Documented Information Type Macro
Defines the type of a documented information.
Even Rating
Allows to select a rating from values between one and four. Since there is no middle ground, the selection is either on the lower or on the upper side.
Feature Importance Macro
Allows to select the importance of a feature.
HML Rating
Allows to rate an item in three simple categories: High, Mid, and Low. This categories are especially useful to rate scenarios in quality trees.
Open Issue Severity Macro
Allows to select a severity for an open issue.
Open Issue Status Macro
Allows to select a status for an open issue.
Pattern Domain
Allows to select the domain for a pattern.
Priority
Allows to prioritize an item in a range of five categories.
Project Constraint Type Macro
Allows to select the type of a project constraint.
Quality Scenario Type Macro
Allows to select the type of a quality scenario.
Resource Type
Allows to select the type of a resource from a fixed set of values.
Risk Phase Macro
Allows to select a phase of a risk.
Risk Probability Macro
Allows to select a probability for a risk.
Risk Severity Macro
Allows to select a severity for a risk.
Severity
Allows to select a value to define the severity for an item.
Status
Allows to select a status for an issue.
Technical Debt Quality Macro
Allows to select the quality type of technical debt.
Use Case Level Macro
Allows to select the level of an use case.
User Character Type Macro
Allows to select the type of an user character.
Vision Statement Type Macro
Allows to select the type of a vision statement.
Word Type
Allows to select the type of word for a glossary term.

Resources

Related resources to selection macros.

Selection Boxes on ad-hoc Doctypes
Define a doctype on document instances to select from its set of values.
Define Status Tags
Doctypes and the Name List Macro allow to specify a range of valid tokens for a value. These values can be rendered by applying specific CSS styles.
Name List Macro
Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.
Name Body List Macro
Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name hat is added to the body.