Uploaded image for project: 'PlantUML Macro'
  1. PlantUML Macro
  2. PLANTUML-37

Declare the URL format of the server parameter of the PlantUML macro

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 2.5
    • None
    • None
    • Unknown

    Description

      The server parameter of the PlantUML macro takes a URL in a text field of the Edit Macro dialog, but declares no format, so the dialog accepts any text and the user only finds out at rendering.

      The fix is done in PlantUMLMacroParameters.java:

      • Declare the URL format of the server parameter, for example with a @Pattern annotation. Whether the domain is trusted can still only be checked at rendering.

      Depends on

      • XWIKI-25287, without which the Edit Macro dialog does not enforce the declared format and the value is only checked when the macro is rendered.

      KOs covered

      Macro Criterion Parameter Problem Depends on
      plantuml C13 constraints server A URL with no declared format: "abc" is accepted and fails at rendering with "no protocol: abc". XWIKI-25287

      Impact found on macro fluidity

      This KO comes from the WYSIWYG usability audit of the macros, under the criterion C13 constraints of its usability criteria. The page of the macro, linked in the table, has the full notes and the steps to reproduce. Fixing it means declaring the format of one parameter of the macro.

      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: