Uploaded image for project: 'XWiki Infrastructure'
  1. XWiki Infrastructure
  2. XINFRA-526

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

    XMLWordPrintable

Details

    • Unknown

    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.

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated: