This issue has been created
There is 1 comment.
 
 
XWiki Platform / cid:jira-generated-image-avatar-49be1432-feb3-4213-bf25-2fa37e044526 XWIKI-23020 Open

Add documentation column in the syntax guide for macros

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-61029ed6-b3bb-45c1-86a0-33bb4c876db9 Charpentier Lucas created this issue on 25/Mar/25 12:30
 
Summary: Add documentation column in the syntax guide for macros
Issue Type: cid:jira-generated-image-avatar-49be1432-feb3-4213-bf25-2fa37e044526 Improvement
Affects Versions: 17.2.0-rc-1
Assignee: Unassigned
Attachments: image-2025-03-25-12-22-50-085.png
Components: Help
Created: 25/Mar/25 12:30
Labels: usability
Priority: cid:jira-generated-image-static-major-98d5d243-e835-46f2-8704-2aa54ff425f0 Major
Reporter: Charpentier Lucas
Description:

_thumb_43425.png

As we can see here, the info in this table is not enough at all to understand how to use the macro. Even when editing macros, some of the more generic info about the macro is missing.

IMO we should provide a straight forward link to the macro documentation instead of expecting the user to look for it themselves. This will improve a lot the macro usability with almost no cost. Right now some macros have some documentation on their own instances, but it's definitely not enough. As far as I could see, the documentation that's the best maintained about those is the online documentation.

As seen in https://design.xwiki.org/xwiki/bin/view/Proposal/WYSIWYGusabilityofXWikimacros#HListofXS2Brecommended28nonpro29macros , it's not straightforward to find macro documentation yet. We can definitely improve things on this end, but providing a direct link from the local documentation to the online documentation makes things easier for users. It would be a bit closer to what we currently do for extensions: There's some info locally, but also a link to online documentation with all the up-to-date infos you could want.

 
 

1 comment

 
cid:jira-generated-image-avatar-61029ed6-b3bb-45c1-86a0-33bb4c876db9 Charpentier Lucas on 25/Mar/25 12:33
 

Sidenote: The info is duplicated at the top of the page. It's probably to clear up some changes from XWiki Syntax 2.0, but in the current context, it looks more confusing than anything else. We should probably remove the two lines at the start since the exact same info is showed in the table right under them.