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

Make the name parameter of the Template macro mandatory

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 17.10.14, 18.8.0
    • Template API
    • None
    • Unknown

    Description

      The name parameter of the Template macro is optional in its descriptor, but the macro renders nothing without it, with no message.

      KOs covered

      Macro Criterion Parameters Problem
      template C2 mandatory name Not mandatory in the descriptor, but nothing works without it: no name renders nothing, with no message, and the legacy documentation says it is mandatory. No default would work for the example, so it should be mandatory; the dialog then refuses an empty value, and Quick Actions opens the dialog as for include and uiextension, which also fixes I2. Reproduce: Quick Actions, Template inserts {{template/}}.
      template I2 zero-config   {{template/}}, inserted from Quick Actions or by the Edit Macro dialog with the default values, renders nothing in view mode, with no message, and shows only the generic "macro:template" placeholder in the editor: the user cannot tell that a name is missing. Making the name mandatory fixes it.

      Impact found on macro fluidity

      These 2 KOs come from the WYSIWYG usability audit of the macros, under the criteria C2 mandatory, I2 zero-config of its usability criteria. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the parameter declarations of the macros: their groups, order, default values, mandatory and advanced flags.

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated: