Details
-
Improvement
-
Resolution: Unresolved
-
Major
-
None
-
17.10.14, 18.8.0
-
None
-
Unknown
-
Description
Two parameters of the script macros have descriptions that do not say which values are accepted, nor what an empty value does.
The macros to change, with the file where most of the fix is done:
- velocity: defined in VelocityMacro.java, descriptions in ApplicationResources.properties.
- script: defined in DefaultScriptMacro.java, descriptions in ApplicationResources.properties.
KOs covered
| Macro | Criterion | Parameters | Problem |
|---|---|---|---|
| script | C1 clarity | language | The description "The identifier of the script language ("groovy", "python", etc)" gives examples of values, which is OK for a free field, but it does not say that an empty value runs nothing and shows the script as text, and that the identifier is case sensitive, "PYTHON" is refused. |
| velocity | C1 clarity | filter | The description "indicate which filtering mode to use" gives no possible value for a free field, and does not say what a filter does or that an empty value stands for the default configured in the wiki, indent unless changed. The valid values, none, indent and html, are in no description, and the documentation only mentions indent. The name is the ID. |
Impact found on macro fluidity
These 2 KOs come from the WYSIWYG usability audit of the macros, under the criteria C1 clarity of its usability criteria. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the translations of the macros and, for a name or a category, their definitions.