| Info |
|---|
Because of the direct relationship between status and its labels and thus their interaction, it is important to adhere to the conventions listed below. |
| Table of Contents | ||||
|---|---|---|---|---|
|
Prefix
A prefix is the part of the label up to the first separator (underscore "_" or hyphen "-"). See Configuring the Viable States macro.
The prefix must be unique within a state swapper macro set. I.e. each selection should start with the same prefix.
Examples
- status_ or status-
- statustotal_ or statustotal-
- overallstatus_ or overallstatus-
- knowledge_ or knowledge-
- report_ or report-
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Not defined,grey,pstatus-all-notdefined;On Track,green,pstatus-all-inplan;Changes,yellow,pstatus-all-changes;Critical,red,pstatus-all-critical; |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Not defined,grey,pstatus-scope_notdefined;On Track,green,pstatus-scope_inplan;Changes,yellow,pstatus-scope-changes;Critical,red,pstatus-scope_critical; |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Not defined,grey,status_notdefined;Draft,yellow,status_draft;In Progress,blue,status_inprogress;Approved,green,status-approved;Rejected,red,status_rejected; |
Spaces
The Status parameter may not contain spaces at certain positions in the character string. See Configuring the Viable States macro.
- No space is required after the comma
- No spaces are required after the semicolon
- labels must not contain spaces
It is permissible for the title, i.e. the selection itself, to contain spaces.
Example
...
...
Not defined,grey,status-notdefined;Draft,yellow,status-draft;In Progress,blue,status-inprogress;Approved,green,status-approved;Rejected,red,status-rejected; |
Special character
The Status parameter must not contain special characters in the character string for the label. See Configuring the Viable States macro.
- Keywords may not contain special characters
Special characters such as "_" and "-" act as separators and are therefore permitted.
Example
...
Not defined,grey,status-notdefined;Draft,yellow,status-draft;In Progress,blue,status-inprogress;Approved,green,status-approved;Rejected,red,status-rejected; |
Uniqueness
The Status parameter must be unique in the string for the label. See Configuring the Viable States macro.
- Keywords must be unique within a selection set.
Because of the direct relationship between status and its label and therefore their interaction, it is necessary for keywords to be unique. Otherwise, it is not clear which selection is to be set.
...