This issue has been created
 
 
XWiki Infrastructure / cid:jira-generated-image-avatar-41502125-e302-404f-98fc-02bf54e96c04 XINFRA-526 Open

Give an example of the most common use in the documentation of each macro of XWiki Standard

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-5756ae5f-3b07-42e0-bead-799f17e279e1 Charpentier Lucas created this issue on 22/Oct/26 15:48
 
Summary: Give an example of the most common use in the documentation of each macro of XWiki Standard
Issue Type: cid:jira-generated-image-avatar-41502125-e302-404f-98fc-02bf54e96c04 Improvement
Assignee: Unassigned
Components: XWiki.org Web Site (www.xwiki.org)
Created: 22/Oct/26 15:48
Priority: cid:jira-generated-image-static-major-0e953588-7362-4092-8cb1-5db19b0e4079 Major
Reporter: Charpentier Lucas
Description:

The documentation of 20 macros of XWiki Standard has no example of their most common use that works when copied into a page of XWiki Standard.

The recurring problems:

  • The macro has no documentation, so no example.
  • The examples only show off one parameter, or use placeholders, so none shows the common call.
  • An example renders an error or nothing when copied, like a syntax that XWiki Standard doesn't have, an identifier that doesn't exist, or a typo.

Progress

The progress of each macro, with its problem, is tracked in the L3 doc-example table. The fix of a row is an example of the most common use, in the new documentation page of the macro, that renders on XWiki Standard. This issue is done when every row of that table is Fixed or Other ticket.

Impact found on macro fluidity

These 20 KOs come from the WYSIWYG usability audit of the macros, under the criterion L3 doc-example of its usability criteria. The page of each macro, linked in the table, has the full notes.