[xwiki-devs] [Vote] Introduce a 'displayPageHeader' parameter in the query string in Flamingo
Hello. In Flamingo, we have a variable called $displayPageHeader, defined in layoutvars.vm. When it is set, the logo is not displayed in the top menu, but on a header under it. It is used by some clients, where they could also add some extra content. Example: http://tof.canardpc.com/view/83040d2d-79c4-4f1b-ab1b-af8ee5f3be62.jpg I'd like to expose this variable into the Flamingo Theme, see: http://jira.xwiki.org/secure/attachment/33074/33074_preview.png However, in order to enable the live preview in the theme editor, I need to be able to change the value of the $displayPageHeader variable on the fly, or at least by setting a parameter in the query string. This variable will be: displayPageHeader Possible values: "true", "false" Default value: Fallback to the Flamingo Theme, "false" if empty. I don't have other use-case to cover with this variable. Here is my +1. Thanks, -- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Hi Guillaume,
On 10 Oct 2016, at 16:43, Guillaume Delhumeau <[email protected]> wrote:
Hello.
In Flamingo, we have a variable called $displayPageHeader, defined in layoutvars.vm.
When it is set, the logo is not displayed in the top menu, but on a header under it. It is used by some clients, where they could also add some extra content.
hmmm… I’m wondering if this is the best way. We already a UIXP for page header so if some users want a custom header they can already do so. I don’t think it belongs to the theme. So instead I would have a boolean to decide whether to display the logo or not. Actually even that boolean could be avoided by deciding that if the logo field is empty then no logo is displayed. Am I missing something? Thanks -Vincent
Example: http://tof.canardpc.com/view/83040d2d-79c4-4f1b-ab1b-af8ee5f3be62.jpg
I'd like to expose this variable into the Flamingo Theme, see: http://jira.xwiki.org/secure/attachment/33074/33074_preview.png
However, in order to enable the live preview in the theme editor, I need to be able to change the value of the $displayPageHeader variable on the fly, or at least by setting a parameter in the query string.
This variable will be: displayPageHeader
Possible values: "true", "false"
Default value: Fallback to the Flamingo Theme, "false" if empty.
I don't have other use-case to cover with this variable.
Here is my +1.
Thanks,
-- Guillaume Delhumeau ([email protected])
Hi 2016-10-10 17:29 GMT+02:00 Vincent Massol <[email protected]>:
Hi Guillaume,
On 10 Oct 2016, at 16:43, Guillaume Delhumeau < [email protected]> wrote:
Hello.
In Flamingo, we have a variable called $displayPageHeader, defined in layoutvars.vm.
When it is set, the logo is not displayed in the top menu, but on a header under it. It is used by some clients, where they could also add some extra content.
hmmm… I’m wondering if this is the best way.
We already a UIXP for page header so if some users want a custom header they can already do so. I don’t think it belongs to the theme.
Indeed, adding content by modifying the header is not the best way. Anyway, I think it is still useful to have this option. In the header, the user have the ability to display a bigger logo for example, and a background corresponding to its visual identity. And it's easier than creating a UIX for this. Since Caty has created the issue http://jira.xwiki.org/browse/XWIKI-13160, maybe she has some example to show us.
So instead I would have a boolean to decide whether to display the logo or not. Actually even that boolean could be avoided by deciding that if the logo field is empty then no logo is displayed.
When no logo is chosen, the current behavior is to fallback to the XWiki default one.
Am I missing something?
Thanks -Vincent
For your information, the code I was working on is here: https://github.com/xwiki/xwiki-platform/compare/feature-theme-editor?expand=... and ready to be merged. Thanks, Guillaume
Example: http://tof.canardpc.com/view/83040d2d-79c4-4f1b-ab1b-af8ee5f3be62.jpg
I'd like to expose this variable into the Flamingo Theme, see: http://jira.xwiki.org/secure/attachment/33074/33074_preview.png
However, in order to enable the live preview in the theme editor, I need to be able to change the value of the $displayPageHeader variable on the fly, or at least by setting a parameter in the query string.
This variable will be: displayPageHeader
Possible values: "true", "false"
Default value: Fallback to the Flamingo Theme, "false" if empty.
I don't have other use-case to cover with this variable.
Here is my +1.
Thanks,
-- Guillaume Delhumeau ([email protected])
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
On Tue, Oct 11, 2016 at 11:22 AM, Guillaume Delhumeau < [email protected]> wrote:
Hi
2016-10-10 17:29 GMT+02:00 Vincent Massol <[email protected]>:
Hi Guillaume,
On 10 Oct 2016, at 16:43, Guillaume Delhumeau < [email protected]> wrote:
Hello.
In Flamingo, we have a variable called $displayPageHeader, defined in layoutvars.vm.
When it is set, the logo is not displayed in the top menu, but on a header under it. It is used by some clients, where they could also add some extra content.
hmmm… I’m wondering if this is the best way.
We already a UIXP for page header so if some users want a custom header they can already do so. I don’t think it belongs to the theme.
Indeed, adding content by modifying the header is not the best way.
Anyway, I think it is still useful to have this option. In the header, the user have the ability to display a bigger logo for example, and a background corresponding to its visual identity. And it's easier than creating a UIX for this.
Since Caty has created the issue http://jira.xwiki.org/browse/XWIKI-13160, maybe she has some example to show us.
We have this variable for backwards compatibility reasons, since in Colibri the logo was not in the navbar, but in the header area (+ also had different header colors depending on the color theme). Some users (especially those that upgrade from Colibri skin) prefer: - to have the logo in the header area or - provide multiple logos (for subwikis) or - have a logo and a background-image as header, etc. I created the issue because there was a bug with the setting of the value. Now the exposure in the Theme Editor was mostly a suggestion. The main problem is determining how advanced this usecase is and how used/needed it is. Currently I don't think is very needed since we didn't had someone creating an issue and requesting to change this from the Theme (as a normal user). But fixing the bug and making sure developers can change this is needed. Regarding the UIXP, the value of displayPageHeader is still needed, since if you add a custom header that contains the logo, you might want to disable the current logo from navbar. This variable controls that. So, although I suggested to add it to the Editor, I am not sure about this: because we should expose mostly the recommended/default values (not compatibility ones); the use case is kind of limited, but should be changed by a developer; it will increase the testing time / values in order to support the use case. Thanks, Caty
So instead I would have a boolean to decide whether to display the logo
or
not. Actually even that boolean could be avoided by deciding that if the logo field is empty then no logo is displayed.
When no logo is chosen, the current behavior is to fallback to the XWiki default one.
Am I missing something?
Thanks -Vincent
For your information, the code I was working on is here: https://github.com/xwiki/xwiki-platform/compare/ feature-theme-editor?expand=1 and ready to be merged.
Thanks, Guillaume
Example: http://tof.canardpc.com/view/83040d2d-79c4-4f1b-ab1b-af8ee5f3be62.jpg
I'd like to expose this variable into the Flamingo Theme, see: http://jira.xwiki.org/secure/attachment/33074/33074_preview.png
However, in order to enable the live preview in the theme editor, I
need
to
be able to change the value of the $displayPageHeader variable on the fly, or at least by setting a parameter in the query string.
This variable will be: displayPageHeader
Possible values: "true", "false"
Default value: Fallback to the Flamingo Theme, "false" if empty.
I don't have other use-case to cover with this variable.
Here is my +1.
Thanks,
-- Guillaume Delhumeau ([email protected])
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
participants (3)
-
Ecaterina Moraru (Valica) -
Guillaume Delhumeau -
Vincent Massol