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

Use number fields and a list of page properties for the parameters of the page list and tree macros

    XMLWordPrintable

Details

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

    Description

      Several parameters of the macros that list pages take a number or a list of page properties in a plain text field of the Edit Macro dialog, so any text can be typed and a wrong value only shows once the macro renders.

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

      The main problems:

      • The numbers are declared as strings: they need an integer type and a minimum, a depth starting at 0 and the other values at 1.
      • The columns of documents are page properties typed by hand, with a default that the description gets wrong.

      Depends on

      Most of these fields cannot be offered before these generic changes, each giving the macro the means to declare the expected value:

      • XWIKI-25182, which gives a number input to the parameters of a numeric type.
      • XWIKI-25197, which lets a wiki macro parameter declare its minimum and maximum.
      • XWIKI-23045, which lets a parameter get its values from a provider, with or without custom values.

      KOs covered

      Macro Criterion Parameter Problem Depends on
      documentTree C4 input-assistance limit A plain text field for the number of child nodes shown before "More". XWIKI-25182, XWIKI-25197
      documentTree C4 input-assistance expandToLevel A plain text field for a tree depth starting at 0. XWIKI-25182, XWIKI-25197
      documents C4 input-assistance count A plain text field for the number of entries per page: count="-3" is accepted and shows "(No entries)". XWIKI-25182, XWIKI-25197
      tree C4 input-assistance limit A plain text field for the number of child nodes shown before "More". XWIKI-25182, XWIKI-25197
      documents C4 input-assistance columns A plain text field for an ordered list of page properties, which a multiple select of the properties could offer. XWIKI-23045

      Impact found on macro fluidity

      These 5 KOs come from the WYSIWYG usability audit of the macros, under the criterion C4 input-assistance 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 declaration of the parameters in the macro definitions.

      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: