Details
-
Improvement
-
Resolution: Unresolved
-
Major
-
None
-
Unknown
-
Description
The parameters of 51 macros of XWiki Standard are not documented accurately. Most of these macros are only documented on a legacy extensions.xwiki.org page, with no page in the new documentation tree, and these pages drifted from the macro descriptors.
The recurring problems:
- The macro has no Reference page in the new documentation tree.
- The content is missing from the parameter table, or not marked as mandatory.
- Documented defaults or mandatory flags don't match the descriptor.
- The page documents parameters the macro no longer has, or misses parameters it has.
- Some pages have no parameter table at all.
Progress
The progress of each macro, with its problem, is tracked in the L2 doc-parameters table. The fix of a row is usually the migration of its legacy page, checked against the macro descriptor. This issue is done when every row of that table is Fixed or Other ticket.
Impact found on macro fluidity
These 51 KOs come from the WYSIWYG usability audit of the macros, under the criterion L2 doc-parameters of its usability criteria. The page of each macro, linked in the table, has the full notes.