Uploaded image for project: 'XWiki Platform'
  1. XWiki Platform
  2. XWIKI-23020

Add documentation column in the syntax guide for macros

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 17.2.0-rc-1
    • Help
    • Unknown

    Description

      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.

      Attachments

        Activity

          People

            Unassigned Unassigned
            Lucas C Charpentier Lucas
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: