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

Offer pickers for the reference, root, openTo and exclusions of the tree macro

    XMLWordPrintable

Details

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

    Description

      The tree macro shows either a static tree, written as a bulleted list in its content, or a dynamic tree, loaded from the page or the URL set in its reference parameter. Its reference, root, openTo and exclusions are plain text fields of the Edit Macro dialog: the user has to type a page reference, or a URL with the path: prefix that only the documentation gives, and node ids whose format depends on the source of the tree, like document:xwiki:Main.WebHome for a tree of pages.

      The parameters are declared in Tree.xml.

      The main problems:

      • The reference is a page or a URL that provides the tree, not a node: it needs a page picker that also accepts a path: URL.
      • The root, openTo and exclusions are nodes of the tree that the reference provides, so a node picker has to load that tree, which depends on the value of the reference field. A format that changes with the use case also hints that the static and dynamic trees could be two macros.

      Depends on

      • XWIKI-25565, which provides the tree node picker, taking several values.
      • XWIKI-25180, which lets a parameter depend on another one, here the nodes on the source of the tree.

      KOs covered

      Macro Criterion Parameter Problem Depends on
      tree C4 input-assistance reference A plain text field for the page providing a dynamic tree, where a page picker could be used. -
      tree C4 input-assistance root A plain text field for a node id, where a node picker, like the Root field of Page Tree, could be used. The picker would depend on the tree source. XWIKI-25565, XWIKI-25180
      tree C4 input-assistance openTo A plain text field for a node id, where a node picker, like the Open to field of Page Tree, could be used. The picker would depend on the tree source. XWIKI-25565, XWIKI-25180
      tree C4 input-assistance exclusions A plain text field for a list of node ids, where a node picker with several values could be used. The picker would depend on the tree source. XWIKI-25565, XWIKI-25180

      Impact found on macro fluidity

      These 4 KOs come from the WYSIWYG usability audit of the macros, under the criterion C4 input-assistance of its usability criteria. The page of the macro, linked in the table, has the full notes. Fixing them means declaring the types of the parameters in the macro definition, once the tickets above provide the pickers.

      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: