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

Allow wiki macro parameters to declare a range or a format for their value

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • None
    • Rendering - WikiMacro
    • None
    • Unknown

    Description

      Java macros can declare constraints on the value of a parameter with Bean Validation annotations, such as @Min, @Positive or @Pattern. XWiki.WikiMacroParameterClass has no equivalent, so a wiki macro can only check a value while it runs, and it usually falls back silently to a default instead of reporting the problem.

      Examples from XWiki Standard wiki macros:

      • documentTree limit: a non-numeric value silently becomes 15, and a value above the query items limit makes the children request fail.
      • documents count and notifications count: invalid or negative values are accepted or ignored without any message.

      Proposal

      • Add optional constraint properties to XWiki.WikiMacroParameterClass, for example a minimum, a maximum and a pattern.
      • Expose them in the parameter descriptor the same way as the constraints declared by Java macros, so that the editor can use them, see XWIKI-25182.
      • Check them when the macro parameters are populated, so that an invalid value gives a clear error naming the parameter, as for a Java macro.

      Allowed values coming from a list are covered separately by XWIKI-23045.

      Raised in https://forum.xwiki.org/t/brainstorming-usability-criteria-for-auditing-macros-in-the-wysiwyg-editor/18907/19

      Attachments

        Issue Links

          blocks

          Improvement - An improvement or enhancement to an existing feature or task. CHARTJS-42 Use number fields and lists of values for the parameters of the chartjs and tableToChartJS macros

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. JWPLAYER-29 Use number fields for the width and height of the JW Player macro

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25497 Use a number field for the number of events of the notifications macro

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25498 Use number fields and a list of page properties for the parameters of the page list and tree macros

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25499 Use number fields and lists of values for the parameters of the attachment picker macros

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25580 Report the invalid values of the documents, documentTree and tree macros instead of an empty result

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25581 Report the invalid values of the attachmentGalleryPicker and attachmentSelector macros instead of showing nothing

          • Major - Major loss of function.
          • Open
          is related to

          Bug - A problem which impairs or prevents the functions of the product. XCOMMONS-3847 Invalid boolean and number values of a bean property are silently converted instead of failing

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-23045 Allow to define a provider of values for a macro parameter

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25182 Numeric macro parameters accept any text in the Edit Macro dialog

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. XWIKI-25287 The Edit Macro dialog doesn't enforce the constraints declared on the parameters of Java macros

          • Major - Major loss of function.
          • Open

          Activity

            People

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

              Dates

                Created:
                Updated: