This issue has been created
 
 
XWiki Infrastructure / cid:jira-generated-image-avatar-c4c76e92-a395-4c7f-9309-4a6345452847 XINFRA-525 Open

Document the parameters of the macros of XWiki Standard in the new documentation

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-d5b8c0ed-dfcc-4449-9b72-ec7eee065b6b Charpentier Lucas created this issue on 22/Oct/26 15:48
 
Summary: Document the parameters of the macros of XWiki Standard in the new documentation
Issue Type: cid:jira-generated-image-avatar-c4c76e92-a395-4c7f-9309-4a6345452847 Improvement
Assignee: Unassigned
Components: XWiki.org Web Site (www.xwiki.org)
Created: 22/Oct/26 15:48
Priority: cid:jira-generated-image-static-major-6d1b9aa9-8b17-450a-866a-2ded0cea7851 Major
Reporter: Charpentier Lucas
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.