Uploaded image for project: 'JIRA Components'
  1. JIRA Components
  2. JIRA-128

Reorganize the Edit Macro dialog of the JIRA macro

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 11.1.7
    • JIRA Macro
    • None
    • Unknown

    Description

      The Edit Macro dialog of the JIRA macro puts the server, without which nothing renders, in the second tab, as two optional fields, URL and id, rather than as one required feature, sorts the optional fields alphabetically so the parameters of the examples come last, and preselects {} in the parameters field. The fields field opens empty, which stands for the default fields of the chosen style but does not show them.

      The fields field must preselect the default fields of the chosen style, type, key, summary, status and created for the table style, and follow the style when it changes. This needs XWIKI-25180, which lets a parameter declare that it depends on another one.

      KOs covered

      Macro Criterion Parameters Problem
      jira C5 groups URL URL and id, the server without which nothing renders, are in the second tab, "Instance", after the "Optional parameters" tab, which holds the display options.
      jira C5 groups id In the second tab, "Instance", with URL, see the notes of URL.
      jira C3 defaults parameters The field preselects "{}", the Java rendering of an empty set of properties, instead of an empty field.
      jira C8 advanced parameters Rarely used, for internal settings like the label of the url field, and set by no example of the documentation, but not marked as advanced.
      jira C6 order source The documentation sets it in three examples, but it comes fourth in the Optional parameters tab, after maxCount and parameters, which no example sets: the order is alphabetical.
      jira C6 order style The documentation sets it in three examples, but it comes last in the Optional parameters tab, after maxCount and parameters, which no example sets: the order is alphabetical.
      jira C7 alternatives URL URL and id are two ways to set the server and one of them is needed, but the "Instance" group is a tab, not a feature, and neither is required: the dialog submits {{jira}}XWIKI-2484{{/jira}}, which renders "No JIRA Server found. You must specify a JIRA server [...]".
      jira C7 alternatives id An alternative of URL, not grouped with it as a feature and not required, see URL.
      jira I5 focus   The content comes first and has the focus, but the server, without which nothing renders, is in the second tab, "Instance", behind the "Optional parameters" tab: the URL and id fields are not visible until that tab is clicked.
      jira C3 defaults fields The field opens empty, which stands for the default fields of the style, type, key, summary, status and created for the default table style, but neither the field nor the description says which ones. Partly covered, see below.

      Impact found on macro fluidity

      These 10 KOs come from the WYSIWYG usability audit of the macros, under the criteria I5 focus, C3 defaults, C5 groups, C6 order, C7 alternatives, C8 advanced 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 features, groups, order, default values, mandatory and advanced flags.

      The C3 defaults KO of jira is only partly covered here, for the value to preselect. The same KO is also partly covered by XWIKI-23759, which adds custom placeholders to the macro fields; a placeholder alone does not show the value the empty field stands for.

      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: