|
| Summary: |
Reorganize the Edit Macro dialog of the page list and tree macros |
| Issue Type: |
 Improvement |
| Affects Versions: |
17.10.14, 18.8.0 |
| Assignee: |
Unassigned |
| Components: |
Index, Tree |
| Created: |
22/Oct/26 11:58 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The Edit Macro dialog of the macros that list pages puts many fields in one group, in alphabetical order, so the parameters that matter are lost among the display options. The macros to change, with the file where most of the fix is done:
- children: parameters declared in its wiki macro definition, ChildrenMacro.xml.
- documentTree: parameters declared in its wiki macro definition, DocumentTree.xml.
- documents: parameters declared in its wiki macro definition, DocumentsMacro.xml.
- tree: parameters declared in its wiki macro definition, Tree.xml.
The main problems:
- documents and tree put every field, 9 and 15 of them, in the single Optional parameters group, and documentTree has 10 fields in its Elements to show group, mixing a filter with the elements of the tree.
- The sort selects of children and documentTree open on "---" without saying which order it stands for.
- Rarely used parameters, like the id of documents and the class of tree, are not marked as advanced.
KOs covered
| Macro |
Criterion |
Parameters |
Problem |
| children |
C3 defaults |
sort |
The two selects open on "--", which means the default sort, title ascending, the value of the most common example. Neither the field nor the description says what "--" sorts by. |
| documentTree |
C5 groups |
showWikis, showWikiPrettyName, showSpaces, showDocumentTitle, showTranslations, showAttachments, showObjects, showClassProperties, showOnlyViewable, showRoot |
The Elements to show group holds 10 parameters, above 7 ± 2, and mixes the filter showOnlyViewable with the elements of the tree. |
| documentTree |
C3 defaults |
sortDocumentsBy |
The selects open on "--", the default order, which is by title when Show Page Title is checked and by name otherwise. The field does not say which order "--" gives, although a default is used. |
| documents |
C5 groups |
count, actions, space, id, parent, columns, location, description, filters |
The 9 fields are all in the single group "Optional parameters", above 7, mixing the parameters that choose the pages, location, space, parent and filters, with the display options, columns, count, actions, id and description. The same holds for every parameter. |
| documents |
C8 advanced |
id |
Rarely used, for styling, and not marked as advanced. |
| documents |
C3 defaults |
columns |
The field opens empty and the descriptor declares no default. Empty gives the expected columns, Title, Location, Date and Last Author, but the description gives another default, see C1, so the dialog does not show the actual default. |
| documents |
C6 order |
location |
The only parameter set by the most common example, and the 6th of the 9 fields, after Actions, Columns, Count, Description and Id. |
| tree |
C5 groups |
reference, root, dragAndDrop, contextMenu, class, icons, edges, links, checkboxes, openTo, finder, showRoot, limit, exclusions |
The only group, Optional parameters, holds the 15 fields of the dialog, content included, above 7 ± 2, in alphabetical order, mixing the display options of every tree with the parameters that only work with a dynamic tree. |
| tree |
C8 advanced |
class |
A styling parameter that most trees do not set, not marked as advanced. |
Impact found on macro fluidity These 39 KOs come from the WYSIWYG usability audit of the macros, under the criteria C3 defaults, C5 groups, C6 order, C8 advanced 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 parameter declarations of the macros: their groups, order, default values, mandatory and advanced flags. |
|
