Uploaded image for project: 'XWiki Rendering'
  1. XWiki Rendering
  2. XRENDERING-827

The box and message macros give no box when inserted with no content

    XMLWordPrintable

Details

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

    Description

      The box macro and the message macros give no box when they are inserted with no content, while an empty box, ready to be filled, is the result a user expects. The message macros declare their content as mandatory, so an empty call renders an error, and the box macro renders nothing at all.

      The macros to change, with the file where most of the fix is done:

      The main problems:

      • The content of the message macros is mandatory: an empty call renders "The required content is missing." instead of an empty box, and the Edit Macro dialog does nothing when submitted with an empty content, with no message.
      • The box macro with no content renders nothing in view mode, and only the generic "macro:box" placeholder in the editor.

      The fix is to make the content optional and to render the empty box, with its icon and frame, when there is no content.

      KOs covered

      Macro Criterion Problem
      box I2 zero-config {{box/}}, inserted from Quick Actions or by the Edit Macro dialog with the default values, shows a "macro:box" placeholder in the editor and renders nothing in view mode.
      error I2 zero-config The content is mandatory: {{error}}{{/error}} renders "The required content is missing." instead of an empty box, and the Edit Macro dialog does nothing when submitted with an empty content.
      info I2 zero-config The content is mandatory: {{info/}} renders "The required content is missing." instead of an empty box, and the Edit Macro dialog does nothing when submitted with an empty content.
      success I2 zero-config The content is mandatory: {{success/}} renders "The required content is missing." instead of an empty box, and the Edit Macro dialog does nothing when submitted with an empty content.
      warning I2 zero-config The content is mandatory: {{warning/}} renders "The required content is missing." instead of an empty box, and the Edit Macro dialog does nothing when submitted with an empty content.

      Impact found on macro fluidity

      These 5 KOs come from the WYSIWYG usability audit of the macros, under the criterion 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 content descriptor of the message macros and the output of the box macro when the content is empty.

      Attachments

        Issue Links

          Activity

            People

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

              Dates

                Created:
                Updated: