|
| Description: |
The server and type parameters of the PlantUML macro are rarely needed, the server being a setting of the wiki and the type being given by the @start tag of the content, but the Edit Macro dialog shows them with the main options. The format select also opens blank, which hides the format it stands for.
The format must declare as its default the format configured by plantuml.format in xwiki.properties, png when it is not set, read when the macro descriptor is built, so that the select preselects it.
h2. KOs covered
||Macro||Criterion||Parameters||Problem||
|[plantuml|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/plantuml/]|C8 advanced|{{server}}|A rarely used parameter, since the server is a setting of the wiki, not marked advanced. Moving it to an advanced tab would keep it out of the way of the user.|
|[plantuml|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/plantuml/]|C8 advanced|{{type}}|The content of nearly every diagram starts with its @start tag, which sets the type, so the parameter is rarely needed, but it is documented and realistic for content without a tag, so it is not hidden.|
|[plantuml|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/plantuml/]|C3 defaults|{{format}}|The select opens blank, which hides the value it stands for: the documentation says png, unless plantuml.format is set in xwiki.properties. Partly covered, see below.|
h2. Impact found on macro fluidity
These 2 3 KOs come from the [WYSIWYG usability audit of the macros|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Macros/], under the criteria C8 advanced and C3 defaults of its [usability criteria|https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros/Usability%20criteria/]. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the parameter declarations of the macros: their groups, order, default values, mandatory and advanced flags.
The C3 defaults KO of plantuml is only partly covered here, for the value to preselect. The same KO is also partly covered by XWIKI-23759, which adds custom placeholders to the macro fields; a placeholder alone does not show the value the empty field stands for. |
|
