Inadequately explained documentation of static content macro documentation parameter

XMLWordPrintable

    • Minor

      Issue Summary

      The static content macro documentation inadequately explains the documentation fields. See also https://community.developer.atlassian.com/t/unable-to-change-the-macro-documentation-title-of-help/43486.

      Steps to Reproduce

      1. View the static macro documentation (https://developer.atlassian.com/cloud/confluence/modules/static-content-macro/).
      2. Create a static content macro specifying one or more input parameters and a documentation field as follows: `"documentation": {"url": "https://www.foo.com", title: "Foo", altText: "foo"}`.
      3. Within a page, insert the macro to view it in editor mode.
      4. Modify the macro so that it specifies a custom editor.
      5. Within a page, insert the macro to view it in editor mode.

      Expected Results

      At step 1, all fields are explained clearly.

      At step 3, the link to the documentation has a title attribute of "Foo".

      At step 5, the link tot he documentation is displayed.

      Actual Results

      At step 1, the effect of the `altText` and `title` fields within the `documentation` field are not explained.

      At step 3, the link to the documentation does not have a title attribute of "Foo".

      At step 5, the link tot he documentation is not displayed.

      Workaround

      None

            Assignee:
            Unassigned
            Reporter:
            Dugald Morrow
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: