|
| Summary: |
Improve the descriptions of the icon macros and of their parameters |
| Issue Type: |
 Improvement |
| Affects Versions: |
17.10.14, 18.8.0 |
| Assignee: |
Unassigned |
| Components: |
Icon |
| Created: |
22/Oct/26 11:59 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The descriptions of the displayIcon and iconPicker macros, and of their parameters, use "icon set" for what the administration calls an Icon Theme, do not say where to find an icon name, and give a wrong default for the prefix of iconPicker. The macros to change, with the file where most of the fix is done:
KOs covered
| Macro |
Criterion |
Parameters |
Problem |
| displayIcon |
C1 clarity |
fallback |
The description says what the parameter does, but uses "icon set" for the Icon Theme, see iconSet, and "the default icon set" without saying which one it is, Silk, nor that with false nothing is displayed. |
| displayIcon |
C1 clarity |
iconSet |
The description "The name of the icon set." uses "icon set", the historical name of what the administration and the documentation call an Icon Theme, and it does not say that an empty value takes the Icon Theme configured for the wiki, nor that the value "default" selects the Icon Theme XWiki falls back to. The German "Der Name des Icon Sets." has the same problem. |
| displayIcon |
C1 clarity |
name |
The description "The name of the icon." only repeats the field name: it does not say that the name is one of the XWiki Icon Set, like "home" or "add", nor where to find the list. |
| iconPicker |
D2 summary |
|
"Select an icon within the XWiki icon set." describes what the picker does once it is on a field, not what the macro adds to the page: it adds nothing visible, it only turns existing input fields into icon pickers by their id or CSS class. It also uses "icon set", the historical name of what the administration calls an Icon Theme. |
| iconPicker |
C1 clarity |
prefix |
The description does not say that an empty value means no prefix at all, which is the value both calls of TemplateProviderSheet and TemplateProviderEditSheet use, and it states a default, "image:icon:", that is wrong, see C3. |
Impact found on macro fluidity These 5 KOs come from the WYSIWYG usability audit of the macros, under the criteria C1 clarity, D2 summary 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. |
|
