Details
-
Improvement
-
Resolution: Unresolved
-
Major
-
None
-
17.10.14, 18.8.0
-
None
-
Unknown
-
Description
Several macros of XWiki Standard build their output with JavaScript, which the WYSIWYG editor does not run. In the editor they show only the generic placeholder with the macro ID, or the raw HTML fallback of their output, so the user cannot see what the macro shows.
The macros to change, with the file where most of the fix is done:
- attachmentGalleryPicker: AttachmentGalleryPickerMacro.java.
- children: ChildrenMacro.xml.
- documentTree: DocumentTreeMacros.xml.
- gallery: GalleryMacro.java.
- menu: MenuMacro.xml.
- tree: Tree.xml.
- dashboard: DashboardMacro.java.
What each macro could show in the editor:
- attachmentGalleryPicker: the search field and the grid of the matching attachments as a static preview, with buttons that cannot be clicked, see XWIKI-23036.
- children and documentTree: the first level of the tree as a static list, or a summary naming the root page.
- gallery: the slide-show frame with the first image and the image count, "1 / 2", instead of every image stacked.
- menu: the menu bar with its top-level entries and collapsed sub-menus, in the colors of view mode.
- tree: the tree collapsed to its first level, with the node icons.
- dashboard: the frame of each gadget with its title and a short description of its content, and a link to the inline form editor where the gadgets are added and edited.
Depends on
- XWIKI-25523, which gives the macros a supported way to know they are rendered for the WYSIWYG editor and a shared edit-mode representation to reuse.
KOs covered
| Macro | Criterion | Problem | Depends on |
|---|---|---|---|
| attachmentGalleryPicker | E1 wysiwyg | The editor shows only the generic "macro:attachmentGalleryPicker" placeholder, while view mode shows the search field, the buttons and the grid of attachments. | XWIKI-25523 |
| children | E1 wysiwyg | The editor shows only the generic "macro:children" placeholder, even when the page has child pages, while view mode shows them as a tree. | XWIKI-25523 |
| documentTree | E1 wysiwyg | The editor shows only the generic "macro:documentTree" placeholder, while view mode shows the tree of the wiki pages. | XWIKI-25523 |
| gallery | E1 wysiwyg | The editor shows the images stacked one under the other, while view mode shows a slide-show with one image at a time and a counter. | XWIKI-25523 |
| menu | E1 wysiwyg | The editor shows a nested bulleted list with every sub-menu expanded and low-contrast links on the blue background, while view mode shows a menu bar whose sub-menus open on hover. | XWIKI-25523 |
| tree | E1 wysiwyg | The editor shows a nested bulleted list with every level expanded, while view mode shows a tree collapsed to its first level, with icons. | XWIKI-25523 |
| dashboard | E1 wysiwyg | The editor shows the gadget titles but not their content built by JavaScript, like the page tree and the activity stream, and the dedicated edit representation is only in the inline form editor, which the WYSIWYG editor does not lead to. | XWIKI-25523 |
Impact found on macro fluidity
These 7 KOs come from the WYSIWYG usability audit of the macros, under the criterion E1 wysiwyg of its usability criteria, which accepts a dedicated edit representation that keeps the meaning of the macro. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means giving the macros an edit-mode representation built on XWIKI-25523.
Attachments
Issue Links
- depends on
-
-
- Open
-
- is related to
-
-
- Open
-