|
| Summary: |
Improve the name and descriptions of the MathJax macro |
| Issue Type: |
 Improvement |
| Affects Versions: |
1.1.10 |
| Assignee: |
Unassigned |
| Created: |
22/Oct/26 12:10 |
| Priority: |
 Major |
| Reporter: |
Charpentier Lucas |
| Description: |
The name and description of the MathJax macro name the JavaScript library it uses, not what it adds to the page, mathematical formulas, and the content description does not say which notation to type. KOs covered
| Macro |
Criterion |
Parameters |
Problem |
| mathjax |
D1 wording |
|
"MathJax" is the name of the JavaScript library that typesets the formulas, written in camelCase, not the word a user types for what the macro produces, like formula, equation or math. A user who does not know the library cannot guess what it does from the name, and the macro is not a product that XWiki defines. The documentation and the Confluence converter of xwiki-contrib/confluence call it "MathJax" too. |
| mathjax |
D2 summary |
|
"Enter content supported by the MathJax javascript engine." repeats the name and describes an input, not what the macro adds to the page. It never says that it displays mathematical formulas, nor which notation to type, and "javascript engine" is technical wording. The French and German descriptions are the English text. |
| mathjax |
C1 clarity |
$content |
The name "Content" is clear, but the description "Macro content" is the generic one of every macro and says nothing about the expected text. The content must be LaTeX with MathJax delimiters, like ( ... ) for an inline formula and $$ ... $$ or an environment such as \begin{equation} for a display one, and a text without delimiters, like {{mathjax}}x{{/mathjax}}, is shown as plain text. |
Impact found on macro fluidity These 3 KOs come from the WYSIWYG usability audit of the macros, under the criteria C1 clarity, D1 wording, D2 summary 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 translations of the macros and, for a name or a category, their definitions. |
|
