as part of my work for adding a UIXP for the Viewers’ part of “Other action” menu, I started to check how to properly refactor the menus to use UIX and I now have several questions.
Usage of “shortcuts” terminology for viewers Menu
It’s apparently something historical that I don’t really understand but the “viewers” part of the menu is currently defined in shortcuts.vm and we are checking that
$displayShortcuts is true for displaying them. Here I’m just wondering if we want to keep that terminology in the future, or if we want to put everything in menus_content.vm.
Just to be clear when I’m talking about the “viewer” part of the menu I’m talking about this:
Partial usage of hardcoded items or full usage of UIX in menus
Right now the different menus we have (namely the Edit menu, the Manage menu, the More actions menu, and the Viewers menu) are all using a mix of hardcoded items and items coming from UIXP.
I’d like to know what direction we want to take and how we want to do that, between keeping this mix of hardcoded items and UIX or using UIX everywhere.
The advantage of having hardcoded items is that you’re currently sure that those menu will be displayed whenever the template is available (so basically with a minimal wiki).
Now the advantage of having UIX everywhere is the flexibility to order them, chose them, customize them etc.
I personally think it would be better to go for using UIX for all items of the menu, now it would mean that someone creating an empty wiki wouldn’t have some menu options such as Copy/Remove/Delete (part of Manage menu). We could also decide that those specifically are too important to be UIXP and that they need to remain hardcoded. But then we need to be clear of what can remain hardcoded and what cannot.
Now here I was talking only about the items of the Menus, but the Menus themselves could be displayed as UIX, we also have hardcoded Menus and some dynamic ones with the
org.xwiki.plaftorm.menu.content UIXP. I wouldn’t change that right now personally, but it can be considered to discuss the global direction we want to take.
So to sum up:
- Are you ok if we stop using “shortcuts” for talking about viewers, and to discard the
shortcuts.vmunless we keep using it only for handling keyboard shortcuts?
- Are you ok if we’re going to a solution with all menu items defined as UIX, meaning that an empty wiki wouldn’t have them?