Deprecate the image parameter of the code macro

The code macro has an image parameter only because it reuses the box macro: CodeMacro extends AbstractBoxMacro, and CodeMacroParameters extends BoxMacroParameters, to get the frame and the title of the box. The image of a box makes no sense on a code block, no example of the documentation sets it, yet the Edit Macro dialog shows it in the main parameters, described as "the image which is to be displayed in the message box".

The parameters are declared in CodeMacroParameters.java.

Proposal

• Override getImage() and setImage() in CodeMacroParameters and annotate them with @Deprecated, which marks the parameter as deprecated in the descriptor of the code macro only: the box and message macros keep it.
• The Edit Macro dialog then hides the field when the macro does not set it, and shows it as deprecated when an existing macro does, so the pages that use it keep their image and their users can still remove it.

KOs covered

Impact found on macro fluidity

These 5 KOs come from the WYSIWYG usability audit of the macros, under the criteria C1 clarity, C4 input-assistance, C5 groups, C9 technical and E2 errors of its usability criteria. The page of the macro, linked in the table, has the full notes. Deprecating the parameter covers them all, since the field leaves the dialog.

The E2 errors KO of code is only partly covered here, for the image. The same KO also reports other invalid values, covered by the other issues listed on the page of the macro, among them XCOMMONS-3847 for the conversion of the values and XRENDERING-823 for the wording of the error.