[xwiki-devs] [Proposal] Rule: one platform core module == one space
Hi devs, Now that we have support for Hidden documents, I'd like to propose a general rule where to put XAR pages in platform modules. The rule I'm proposing is: * Each top level module in xwiki-platform-core/ that has a UI submodule should put its pages in a single space, generally named after the module but with a pretty name Examples: * xwiki-platform-appwithinminutes --> AppWithinMinutes (could also have been "App Within Minutes") (currently using: "AppWithinMinutes") * xwiki-platform-index --> Index (currently using: "Main" and "XWiki") * xwiki-platform-ircbot --> IRC (or "IRC Bot" or "IRCBot") (currently using: "IRC") * xwiki-platform-livetable --> Livetable (currently using: "XWiki") * xwiki-platform-user --> User (currently using: "XWiki") etc What's important is the rule: one module == one dedicated space WDYT? Note 1: This means that we the "Main" space will not be really needed anymore but I think we should keep it as the space name for the XE application for now (or we could introduce an application for it in xwiki-platform-core). It could simply contain the current Main.WebHome. Note 2: When we add support for nested spaces, the rule would mean but we would be be able to better organize content in nested spaces. Thanks -Vincent
Hi Vincent, I'm very much in favor of an overhaul of all spaces names for platform (and ideally also for XE and XEM too). I'm not going to vote on the rule you propose just yet ; but I have a couple of (open) questions : * Quid of space pretty names (space titles) ? - I personally firmly think we need them * Can documents exists outside spaces ? (I don't know if the model module takes this in consideration or not) * How do we fix the doc.name vs. doc.title problem in terms of user experience? (pointers : looking at what Wordpress does for example, and introduce the notion of permalink) - this applies to space name vs. space title as well should we decide to have pretty space titles. BTW Last week I've thrown together a little module[1] for my own use, that for a "business" XClass offers a customizable page creation UI with flexible rules for how to generate the page name. I'll try to spend some times describing in more details the use cases behind this ; I think this can be interesting as input for the more general discussion of how we want to structure our UI modules in the future, and what good practices we want to promote for tiers extensions/applications. Just food for though... Jerome [1] https://github.com/jvelo/xwiki-platform-pagecreation On Sun, Apr 15, 2012 at 8:29 PM, Vincent Massol <vincent@massol.net> wrote:
Hi devs,
Now that we have support for Hidden documents, I'd like to propose a general rule where to put XAR pages in platform modules.
The rule I'm proposing is: * Each top level module in xwiki-platform-core/ that has a UI submodule should put its pages in a single space, generally named after the module but with a pretty name
Examples: * xwiki-platform-appwithinminutes --> AppWithinMinutes (could also have been "App Within Minutes") (currently using: "AppWithinMinutes") * xwiki-platform-index --> Index (currently using: "Main" and "XWiki") * xwiki-platform-ircbot --> IRC (or "IRC Bot" or "IRCBot") (currently using: "IRC") * xwiki-platform-livetable --> Livetable (currently using: "XWiki") * xwiki-platform-user --> User (currently using: "XWiki") etc
What's important is the rule: one module == one dedicated space
WDYT?
Note 1: This means that we the "Main" space will not be really needed anymore but I think we should keep it as the space name for the XE application for now (or we could introduce an application for it in xwiki-platform-core). It could simply contain the current Main.WebHome. Note 2: When we add support for nested spaces, the rule would mean but we would be be able to better organize content in nested spaces.
Thanks -Vincent _______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
-- Jérôme Velociter Winesquare http://www.winesquare.net/
Hi Jerome, On Apr 16, 2012, at 2:09 PM, Jerome Velociter wrote:
Hi Vincent,
I'm very much in favor of an overhaul of all spaces names for platform (and ideally also for XE and XEM too).
I'm not going to vote on the rule you propose just yet ; but I have a couple of (open) questions :
* Quid of space pretty names (space titles) ? - I personally firmly think we need them
Yep, this is orthogonal to this proposal.
* Can documents exists outside spaces ? (I don't know if the model module takes this in consideration or not)
No
* How do we fix the doc.name vs. doc.title problem in terms of user experience? (pointers : looking at what Wordpress does for example, and introduce the notion of permalink) - this applies to space name vs. space title as well should we decide to have pretty space titles.
This is also orthogonal to this proposal too.
BTW Last week I've thrown together a little module[1] for my own use, that for a "business" XClass offers a customizable page creation UI with flexible rules for how to generate the page name. I'll try to spend some times describing in more details the use cases behind this ; I think this can be interesting as input for the more general discussion of how we want to structure our UI modules in the future, and what good practices we want to promote for tiers extensions/applications.
Sounds interesting. Any screenshot to show? :) I think all your questions/ideas are good but they are independent of this proposal IMO. They can be added on top. Thanks -Vincent
Just food for though...
Jerome
[1] https://github.com/jvelo/xwiki-platform-pagecreation
On Sun, Apr 15, 2012 at 8:29 PM, Vincent Massol <vincent@massol.net> wrote:
Hi devs,
Now that we have support for Hidden documents, I'd like to propose a general rule where to put XAR pages in platform modules.
The rule I'm proposing is: * Each top level module in xwiki-platform-core/ that has a UI submodule should put its pages in a single space, generally named after the module but with a pretty name
Examples: * xwiki-platform-appwithinminutes --> AppWithinMinutes (could also have been "App Within Minutes") (currently using: "AppWithinMinutes") * xwiki-platform-index --> Index (currently using: "Main" and "XWiki") * xwiki-platform-ircbot --> IRC (or "IRC Bot" or "IRCBot") (currently using: "IRC") * xwiki-platform-livetable --> Livetable (currently using: "XWiki") * xwiki-platform-user --> User (currently using: "XWiki") etc
What's important is the rule: one module == one dedicated space
WDYT?
Note 1: This means that we the "Main" space will not be really needed anymore but I think we should keep it as the space name for the XE application for now (or we could introduce an application for it in xwiki-platform-core). It could simply contain the current Main.WebHome. Note 2: When we add support for nested spaces, the rule would mean but we would be be able to better organize content in nested spaces.
Thanks -Vincent
On Mon, Apr 16, 2012 at 2:23 PM, Vincent Massol <vincent@massol.net> wrote:
Hi Jerome,
On Apr 16, 2012, at 2:09 PM, Jerome Velociter wrote:
Hi Vincent,
I'm very much in favor of an overhaul of all spaces names for platform (and ideally also for XE and XEM too).
I'm not going to vote on the rule you propose just yet ; but I have a couple of (open) questions :
* Quid of space pretty names (space titles) ? - I personally firmly think we need them
Yep, this is orthogonal to this proposal.
Yes but to decide between "IRC Bot" and "IRCBot" as a space name it's better to know what's the plan concerning pretty names :)
* Can documents exists outside spaces ? (I don't know if the model module takes this in consideration or not)
No
OK.
* How do we fix the doc.name vs. doc.title problem in terms of user experience? (pointers : looking at what Wordpress does for example, and introduce the notion of permalink) - this applies to space name vs. space title as well should we decide to have pretty space titles.
This is also orthogonal to this proposal too.
BTW Last week I've thrown together a little module[1] for my own use, that for a "business" XClass offers a customizable page creation UI with flexible rules for how to generate the page name. I'll try to spend some times describing in more details the use cases behind this ; I think this can be interesting as input for the more general discussion of how we want to structure our UI modules in the future, and what good practices we want to promote for tiers extensions/applications.
Sounds interesting. Any screenshot to show? :)
No but I will try to make some, some time soon.
I think all your questions/ideas are good but they are independent of this proposal IMO. They can be added on top.
Thanks -Vincent
Just food for though...
Jerome
[1] https://github.com/jvelo/xwiki-platform-pagecreation
On Sun, Apr 15, 2012 at 8:29 PM, Vincent Massol <vincent@massol.net> wrote:
Hi devs,
Now that we have support for Hidden documents, I'd like to propose a general rule where to put XAR pages in platform modules.
The rule I'm proposing is: * Each top level module in xwiki-platform-core/ that has a UI submodule should put its pages in a single space, generally named after the module but with a pretty name
Examples: * xwiki-platform-appwithinminutes --> AppWithinMinutes (could also have been "App Within Minutes") (currently using: "AppWithinMinutes") * xwiki-platform-index --> Index (currently using: "Main" and "XWiki") * xwiki-platform-ircbot --> IRC (or "IRC Bot" or "IRCBot") (currently using: "IRC") * xwiki-platform-livetable --> Livetable (currently using: "XWiki") * xwiki-platform-user --> User (currently using: "XWiki") etc
What's important is the rule: one module == one dedicated space
WDYT?
Note 1: This means that we the "Main" space will not be really needed anymore but I think we should keep it as the space name for the XE application for now (or we could introduce an application for it in xwiki-platform-core). It could simply contain the current Main.WebHome. Note 2: When we add support for nested spaces, the rule would mean but we would be be able to better organize content in nested spaces.
Thanks -Vincent
_______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
-- Jérôme Velociter Winesquare http://www.winesquare.net/
participants (2)
-
Jerome Velociter -
Vincent Massol