[xwiki-devs] [Discussion] What the "templates" directory should contain?
Hi. Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri". Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin. Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira. Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent. What do you think about it? Thanks, -- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
The solution of putting anything *skin-dependent* in the 'skins' directories make sense. And then, let *.vm files that are *not skin-dependent* in the 'templates' directory. In JIRA[1], you argue that files in 'templates' may break one of the skin without noticing it (because you were testing on the other skin) but they shouldn't if they're truly *not skin-dependent*. Of course, at least at the beginning, this modification will probably bring us bugs about skins for files that are in 'templates' (even it they shouldn't), but it's will be temporary ;-) [1] http://jira.xwiki.org/browse/XWIKI-11027?focusedCommentId=82727&page=com.atl... On Wed, Oct 01, 2014 at 02:42:02PM +0200, Guillaume "Louis-Marie" Delhumeau wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Jean Simard [email protected] Research engineer at XWiki SAS http://www.xwiki.com Committer on the XWiki.org project http://www.xwiki.org
The location of this folder only make sense when it contains only generic content. All skins inherit from it and having Flamingo inherit from a partial Colibri (which is the current situation) does not make any sense. Having this folder not containing much is not an issue but having it filled with what is specific to a skin does not make any sense. Why bother even having a separated project for the skin in that case ? On Wed, Oct 1, 2014 at 2:42 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Thomas Mortagne
Hi, IMO /templates/ folder makes sense when there are multiple skins supported. Now that Colibri is not the default skin anymore, we should copy all the templates specific to Colibri in /colibri/ folder. Flamingo should contain just templates specific to it. /templates/ should contain templates shared both by Colibri and Flamingo. When we are going to deprecate Colibri, in the deprecation step we should copy the whole content of /templates/ and add it in Colibri, than move it to contrib. In the close future we might need to have multiple skins depending on the Flavor. This means we might use the templates folder much more (and Colibri will be deprecated in the meanwhile) because the new skins will probably fallback on the Flamingo skin. This means, when we deprecate Colibri we will need to copy all the templates from Flamingo and move them to /templates. When new skins appear we take the specific templates and put them in the desired skin folder while keeping the common templates in templates/. etc.etc.etc. This is the way we worked until now with the skins we had: albatross, toucan, colibri. Thanks, Caty On Wed, Oct 1, 2014 at 4:51 PM, Thomas Mortagne <[email protected]> wrote:
The location of this folder only make sense when it contains only generic content. All skins inherit from it and having Flamingo inherit from a partial Colibri (which is the current situation) does not make any sense.
Having this folder not containing much is not an issue but having it filled with what is specific to a skin does not make any sense. Why bother even having a separated project for the skin in that case ?
On Wed, Oct 1, 2014 at 2:42 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
2014-10-01 16:41 GMT+02:00 Ecaterina Moraru (Valica) <[email protected]>:
Hi,
IMO /templates/ folder makes sense when there are multiple skins supported. Now that Colibri is not the default skin anymore, we should copy all the templates specific to Colibri in /colibri/ folder. Flamingo should contain just templates specific to it.
/templates/ should contain templates shared both by Colibri and Flamingo.
When we are going to deprecate Colibri, in the deprecation step we should copy the whole content of /templates/ and add it in Colibri, than move it to contrib.
In the close future we might need to have multiple skins depending on the Flavor. This means we might use the templates folder much more (and Colibri will be deprecated in the meanwhile) because the new skins will probably fallback on the Flamingo skin.
Actually, if a new skin has "Flamingo" as "base skin", then it will failback to "flamingo" files anyway. We don't need the "templates" dir to achieve that.
This means, when we deprecate Colibri we will need to copy all the templates from Flamingo and move them to /templates. When new skins appear we take the specific templates and put them in the desired skin folder while keeping the common templates in templates/. etc.etc.etc.
This is the way we worked until now with the skins we had: albatross, toucan, colibri.
Thanks, Caty
On Wed, Oct 1, 2014 at 4:51 PM, Thomas Mortagne <[email protected]
wrote:
The location of this folder only make sense when it contains only generic content. All skins inherit from it and having Flamingo inherit from a partial Colibri (which is the current situation) does not make any sense.
Having this folder not containing much is not an issue but having it filled with what is specific to a skin does not make any sense. Why bother even having a separated project for the skin in that case ?
On Wed, Oct 1, 2014 at 2:42 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ 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 Wed, Oct 1, 2014 at 6:02 PM, Guillaume "Louis-Marie" Delhumeau < [email protected]> wrote:
2014-10-01 16:41 GMT+02:00 Ecaterina Moraru (Valica) <[email protected]>:
Hi,
IMO /templates/ folder makes sense when there are multiple skins supported. Now that Colibri is not the default skin anymore, we should copy all the templates specific to Colibri in /colibri/ folder. Flamingo should contain just templates specific to it.
/templates/ should contain templates shared both by Colibri and Flamingo.
When we are going to deprecate Colibri, in the deprecation step we should copy the whole content of /templates/ and add it in Colibri, than move it to contrib.
In the close future we might need to have multiple skins depending on the Flavor. This means we might use the templates folder much more (and Colibri will be deprecated in the meanwhile) because the new skins will probably fallback on the Flamingo skin.
Actually, if a new skin has "Flamingo" as "base skin", then it will failback to "flamingo" files anyway. We don't need the "templates" dir to achieve that.
How do we set 'base skin' at filesystem level? If we were to have multiple skins for Groupware, Public Website, etc. Flavors, and we implement them as file system skins, how do you make them fallback on the common templates? Thanks, Caty
This means, when we deprecate Colibri we will need to copy all the templates from Flamingo and move them to /templates. When new skins appear we take the specific templates and put them in the desired skin folder while keeping the common templates in templates/. etc.etc.etc.
This is the way we worked until now with the skins we had: albatross, toucan, colibri.
Thanks, Caty
On Wed, Oct 1, 2014 at 4:51 PM, Thomas Mortagne < [email protected]
wrote:
The location of this folder only make sense when it contains only generic content. All skins inherit from it and having Flamingo inherit from a partial Colibri (which is the current situation) does not make any sense.
Having this folder not containing much is not an issue but having it filled with what is specific to a skin does not make any sense. Why bother even having a separated project for the skin in that case ?
On Wed, Oct 1, 2014 at 2:42 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ 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
On Wed, Oct 1, 2014 at 5:43 PM, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Wed, Oct 1, 2014 at 6:02 PM, Guillaume "Louis-Marie" Delhumeau < [email protected]> wrote:
2014-10-01 16:41 GMT+02:00 Ecaterina Moraru (Valica) <[email protected]>:
Hi,
IMO /templates/ folder makes sense when there are multiple skins supported. Now that Colibri is not the default skin anymore, we should copy all the templates specific to Colibri in /colibri/ folder. Flamingo should contain just templates specific to it.
/templates/ should contain templates shared both by Colibri and Flamingo.
When we are going to deprecate Colibri, in the deprecation step we should copy the whole content of /templates/ and add it in Colibri, than move it to contrib.
In the close future we might need to have multiple skins depending on the Flavor. This means we might use the templates folder much more (and Colibri will be deprecated in the meanwhile) because the new skins will probably fallback on the Flamingo skin.
Actually, if a new skin has "Flamingo" as "base skin", then it will failback to "flamingo" files anyway. We don't need the "templates" dir to achieve that.
How do we set 'base skin' at filesystem level? If we were to have multiple skins for Groupware, Public Website, etc. Flavors, and we implement them as file system skins, how do you make them fallback on the common templates?
All filesystem skins inherit from the skin set as xwiki.defaultBaseSkin in xwiki.cfg.
Thanks, Caty
This means, when we deprecate Colibri we will need to copy all the templates from Flamingo and move them to /templates. When new skins appear we take the specific templates and put them in the desired skin folder while keeping the common templates in templates/. etc.etc.etc.
This is the way we worked until now with the skins we had: albatross, toucan, colibri.
Thanks, Caty
On Wed, Oct 1, 2014 at 4:51 PM, Thomas Mortagne < [email protected]
wrote:
The location of this folder only make sense when it contains only generic content. All skins inherit from it and having Flamingo inherit from a partial Colibri (which is the current situation) does not make any sense.
Having this folder not containing much is not an issue but having it filled with what is specific to a skin does not make any sense. Why bother even having a separated project for the skin in that case ?
On Wed, Oct 1, 2014 at 2:42 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ 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
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
(note that I'm currently working on a descriptor file to allow a skin to declare its own base skin but it's a surprise) On Wed, Oct 1, 2014 at 6:12 PM, Thomas Mortagne <[email protected]> wrote:
On Wed, Oct 1, 2014 at 5:43 PM, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Wed, Oct 1, 2014 at 6:02 PM, Guillaume "Louis-Marie" Delhumeau < [email protected]> wrote:
2014-10-01 16:41 GMT+02:00 Ecaterina Moraru (Valica) <[email protected]>:
Hi,
IMO /templates/ folder makes sense when there are multiple skins supported. Now that Colibri is not the default skin anymore, we should copy all the templates specific to Colibri in /colibri/ folder. Flamingo should contain just templates specific to it.
/templates/ should contain templates shared both by Colibri and Flamingo.
When we are going to deprecate Colibri, in the deprecation step we should copy the whole content of /templates/ and add it in Colibri, than move it to contrib.
In the close future we might need to have multiple skins depending on the Flavor. This means we might use the templates folder much more (and Colibri will be deprecated in the meanwhile) because the new skins will probably fallback on the Flamingo skin.
Actually, if a new skin has "Flamingo" as "base skin", then it will failback to "flamingo" files anyway. We don't need the "templates" dir to achieve that.
How do we set 'base skin' at filesystem level? If we were to have multiple skins for Groupware, Public Website, etc. Flavors, and we implement them as file system skins, how do you make them fallback on the common templates?
All filesystem skins inherit from the skin set as xwiki.defaultBaseSkin in xwiki.cfg.
Thanks, Caty
This means, when we deprecate Colibri we will need to copy all the templates from Flamingo and move them to /templates. When new skins appear we take the specific templates and put them in the desired skin folder while keeping the common templates in templates/. etc.etc.etc.
This is the way we worked until now with the skins we had: albatross, toucan, colibri.
Thanks, Caty
On Wed, Oct 1, 2014 at 4:51 PM, Thomas Mortagne < [email protected]
wrote:
The location of this folder only make sense when it contains only generic content. All skins inherit from it and having Flamingo inherit from a partial Colibri (which is the current situation) does not make any sense.
Having this folder not containing much is not an issue but having it filled with what is specific to a skin does not make any sense. Why bother even having a separated project for the skin in that case ?
On Wed, Oct 1, 2014 at 2:42 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hi.
Since 6.2, we have the following issue: http://jira.xwiki.org/browse/XWIKI-11027 "The templates directory has VMs from Colibri".
Until now, we used to have all *.vm files in this directory, and nothing in the "colibri" one, because Colibri was the default skin.
Now that Flamingo is the default skin, we have to decide what we do with this directory. Should we move all Flamingo's files in that directory? Should we only put the files that Colibri & Flamingo have in common? I have reported a list of problems that these decisions make, on the Jira.
Actually, the "templates" directory seems to mean that we should put only "generic" templates. But what does it mean? Most of the files depends on the skin, so they are not generic. Except some files for the Distribution Wizard that should not be skin-dependent.
What do you think about it?
Thanks,
-- 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
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ 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
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
-- Thomas Mortagne
My conclusions. We should keep in the /templates/ directory the files that are sufficiently generic to be shared with nearly all skins. For example: extensions.vm, accessdenied.vm, addnewgroup.vm, etc... Then, we move all other files to the /colibri/ and the /flamingo/ folders. Finally, we rely on the new skin descriptor that Thomas is working on to be able to specify a base skin for every file system skins. WDYT? Guillaume
Sounds good to me, at least with my level of comprehension :-) On Wed, Oct 08, 2014 at 12:27:02PM +0200, Guillaume "Louis-Marie" Delhumeau wrote:
My conclusions.
We should keep in the /templates/ directory the files that are sufficiently generic to be shared with nearly all skins.
For example: extensions.vm, accessdenied.vm, addnewgroup.vm, etc...
Then, we move all other files to the /colibri/ and the /flamingo/ folders.
Finally, we rely on the new skin descriptor that Thomas is working on to be able to specify a base skin for every file system skins.
WDYT?
Guillaume _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Jean Simard [email protected] Research engineer at XWiki SAS http://www.xwiki.com Committer on the XWiki.org project http://www.xwiki.org
On Wed, Oct 8, 2014 at 12:27 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
My conclusions.
We should keep in the /templates/ directory the files that are sufficiently generic to be shared with nearly all skins.
For example: extensions.vm, accessdenied.vm, addnewgroup.vm, etc...
Then, we move all other files to the /colibri/ and the /flamingo/ folders.
Finally, we rely on the new skin descriptor that Thomas is working on to be able to specify a base skin for every file system skins.
And as I said you can already define a base skin for all filesystem skins, but the same one.
WDYT?
Guillaume _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
Yes. I rephrase: we rely on the new skin descriptor that Thomas is working on to be able to specify a *different* base skin for every file system skins ;) 2014-10-08 13:26 GMT+02:00 Thomas Mortagne <[email protected]>:
On Wed, Oct 8, 2014 at 12:27 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
My conclusions.
We should keep in the /templates/ directory the files that are sufficiently generic to be shared with nearly all skins.
For example: extensions.vm, accessdenied.vm, addnewgroup.vm, etc...
Then, we move all other files to the /colibri/ and the /flamingo/ folders.
Finally, we rely on the new skin descriptor that Thomas is working on to be able to specify a base skin for every file system skins.
And as I said you can already define a base skin for all filesystem skins, but the same one.
WDYT?
Guillaume _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ 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
participants (4)
-
Ecaterina Moraru (Valica) -
Guillaume "Louis-Marie" Delhumeau -
Jean SIMARD -
Thomas Mortagne