[Proposal] Changes to remove Dashboard, Crypto, Macros, Rendering entries in the Navigation Panels

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

[Proposal] Changes to remove Dashboard, Crypto, Macros, Rendering entries in the Navigation Panels

vmassol
Administrator
Hi devs,

On a standard XS, if you show hidden document you see some entries that you shouldn’t see and that should be hidden. See screenshot.



Another problem is that clicking on the  Dashboard, Crypto, Macros, Rendering links lead to non-existing pages.

I’m this proposing to:

1) Introduce a xwiki-platform-crypto-ui modules with a single Crypto.Webhome page and some one liner explaining what this space is about.
2) Introduce a xwiki-platform-rendering-wikimacro-ui module with a single Macros.WebHome page and some one liner explaining what this space is about. It makes sense to have it under xwiki-platform-rendering-wikimacro since it’s about providing a location for wiki macros.
3) Add a Rendering.WebHome page inside xwiki-platform-rendering-ui to explain what this space is about. The module is there and it’s just missing this page. BTW an alternative is to modify the Navigation panel algorithm to exclude spaces not having a top level WebHome page too. @Marius: any reason we’re not doing this already?

By default the Navigation panel hides top level pages that are not meant to be modified so this will remove Crypto, Macros & Rendering.

4) For Dashboard it’s a bit more complex. Ideally we would refactor Dashboard.WebHome to include a new Dashboard.WikiDashboard page that would contain the current content of Dashboard.WebHome. Thus the home page would appear as not modifiable and not appear in the Navigation panel. However, since users can have modified Dashboard.WebHome, this would cause an upgrade merge conflict. Thus, instead, I propose to do what we do for the Sandbox page and instead add Dashboard to the Exclude list of the Navigation panel.

WDYT?

Note: I’m going to do 4) right now since it’s a no-brainer.

Longer term
=========

This is *not* part of the proposal but we need to start a thread again about this and start doing something about it: Right now we have apps/extensions creating pages under the top level root. I don’t think this is good at all and we should reserve the top level root for user content. It would be much better to have a place under “XWiki”, such as “XWiki.Extensions.<extension name>.<sub spaces>.<pages>” where each extension could put its content.

We already started discussing this. The past thread(s) needs to be unearthed and the discussion resumed.

Thanks
-Vincent

Reply | Threaded
Open this post in threaded view
|

Re: [Proposal] Changes to remove Dashboard, Crypto, Macros, Rendering entries in the Navigation Panels

Thomas Mortagne
Administrator
On Sun, Feb 24, 2019 at 11:42 AM Vincent Massol <[hidden email]> wrote:

>
> Hi devs,
>
> On a standard XS, if you show hidden document you see some entries that you shouldn’t see and that should be hidden. See screenshot.
>
>
>
> Another problem is that clicking on the  Dashboard, Crypto, Macros, Rendering links lead to non-existing pages.
>
> I’m this proposing to:
>
> 1) Introduce a xwiki-platform-crypto-ui modules with a single Crypto.Webhome page and some one liner explaining what this space is about.

Or generate it since all the pages located in that space are generated
classes. But I guess we can come up with some UI for the crypto module
in the future even if it's a pity to introduce it just for that page.

> 2) Introduce a xwiki-platform-rendering-wikimacro-ui module with a single Macros.WebHome page and some one liner explaining what this space is about. It makes sense to have it under xwiki-platform-rendering-wikimacro since it’s about providing a location for wiki macros.

Sounds like we should move the page currently located at
XWiki.XWikiSyntaxMacrosList (xwiki-platform-help-ui) to
Macros.WebHome.

> 3) Add a Rendering.WebHome page inside xwiki-platform-rendering-ui to explain what this space is about. The module is there and it’s just missing this page. BTW an alternative is to modify the Navigation panel algorithm to exclude spaces not having a top level WebHome page too.

> @Marius: any reason we’re not doing this already?

See https://jira.xwiki.org/browse/XWIKI-15296.

>
> By default the Navigation panel hides top level pages that are not meant to be modified so this will remove Crypto, Macros & Rendering.
>
> 4) For Dashboard it’s a bit more complex. Ideally we would refactor Dashboard.WebHome to include a new Dashboard.WikiDashboard page that would contain the current content of Dashboard.WebHome. Thus the home page would appear as not modifiable and not appear in the Navigation panel. However, since users can have modified Dashboard.WebHome, this would cause an upgrade merge conflict. Thus, instead, I propose to do what we do for the Sandbox page and instead add Dashboard to the Exclude list of the Navigation panel.
>
> WDYT?
>
> Note: I’m going to do 4) right now since it’s a no-brainer.
>
> Longer term
> =========
>
> This is *not* part of the proposal but we need to start a thread again about this and start doing something about it: Right now we have apps/extensions creating pages under the top level root. I don’t think this is good at all and we should reserve the top level root for user content. It would be much better to have a place under “XWiki”, such as “XWiki.Extensions.<extension name>.<sub spaces>.<pages>” where each extension could put its content.
>
> We already started discussing this. The past thread(s) needs to be unearthed and the discussion resumed.
>
> Thanks
> -Vincent
>


--
Thomas Mortagne