[xwiki-devs] [Brainstorming] Changing from "Wiki" to "SubWiki", is that good?
Hi devs, We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki" Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class… I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge) It's a bit everywhere and changing that seems too big a task IMO. Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc). WDYT? Thanks -Vincent
On Mon, Sep 2, 2013 at 1:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
As already stated in the previous workspace mails, I prefer the wiki + home variant. Thanks, Caty
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi Caty, On Sep 2, 2013, at 1:44 PM, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Mon, Sep 2, 2013 at 1:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
As already stated in the previous workspace mails, I prefer the wiki + home variant.
So in the Add menu we would have: Add > Wiki Home cannot represent the whole system IMO. It could possibly represent the main wiki but I don't see how it could represent the whole system. Said differently I have a hard time imagining a Home.java class representing the whole system. Am I the only one? Thanks -Vincent
Thanks, Caty
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Mon, Sep 2, 2013 at 2:52 PM, Vincent Massol <[email protected]> wrote:
Hi Caty,
On Sep 2, 2013, at 1:44 PM, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Mon, Sep 2, 2013 at 1:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
As already stated in the previous workspace mails, I prefer the wiki + home variant.
So in the Add menu we would have: Add > Wiki
Home cannot represent the whole system IMO. It could possibly represent the main wiki but I don't see how it could represent the whole system. Said differently I have a hard time imagining a Home.java class representing the whole system. Am I the only one?
You need to explain how you see the "whole system" exposed in the UI. Suppose we call it "Foo", what will the "Foo" link lead to? It has to be a document. With our current capabilities it can only be a document on the main wiki, so the main wiki _represents_ the whole system. It's not the whole system, it's just the entry point (Home) for the whole system. Same as the root node of a tree represents/defines the tree even if it's just a node in the tree like the rest and not the entire tree. To summarize, I think we can have Home in the UI and System in Java. I'm also for Add > Wiki Thanks, Marius
Thanks -Vincent
Thanks, Caty
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Sep 3, 2013, at 5:15 PM, Marius Dumitru Florea <[email protected]> wrote:
On Mon, Sep 2, 2013 at 2:52 PM, Vincent Massol <[email protected]> wrote:
Hi Caty,
On Sep 2, 2013, at 1:44 PM, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Mon, Sep 2, 2013 at 1:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
As already stated in the previous workspace mails, I prefer the wiki + home variant.
So in the Add menu we would have: Add > Wiki
Home cannot represent the whole system IMO. It could possibly represent the main wiki but I don't see how it could represent the whole system. Said differently I have a hard time imagining a Home.java class representing the whole system. Am I the only one?
You need to explain how you see the "whole system" exposed in the UI.
I don't think we need to have it exposed in the UI. I was thinking mostly about xwiki.org documentation and API (like the new model).
Suppose we call it "Foo", what will the "Foo" link lead to? It has to be a document. With our current capabilities it can only be a document on the main wiki, so the main wiki _represents_ the whole system. It's not the whole system, it's just the entry point (Home) for the whole system. Same as the root node of a tree represents/defines the tree even if it's just a node in the tree like the rest and not the entire tree.
To summarize, I think we can have Home in the UI and System in Java.
Ok. The other decision related to this is whether we stop calling the main wiki "the main wiki" in the API for example… That's a tough one since we're all so used to calling it the main wiki… Calling it the Home wiki and changing the API would take time ;) Any idea? Thanks -Vincent
I'm also for Add > Wiki
Thanks, Marius
Thanks -Vincent
Thanks, Caty
WDYT?
Thanks -Vincent
I prefer to stay with Wiki, changing this is a big change and I prefer "wiki" over "subwiki" anyway (I never agreed on this change). On Tue, Sep 3, 2013 at 5:35 PM, Vincent Massol <[email protected]> wrote:
On Sep 3, 2013, at 5:15 PM, Marius Dumitru Florea <[email protected]> wrote:
On Mon, Sep 2, 2013 at 2:52 PM, Vincent Massol <[email protected]> wrote:
Hi Caty,
On Sep 2, 2013, at 1:44 PM, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Mon, Sep 2, 2013 at 1:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
As already stated in the previous workspace mails, I prefer the wiki + home variant.
So in the Add menu we would have: Add > Wiki
Home cannot represent the whole system IMO. It could possibly represent the main wiki but I don't see how it could represent the whole system. Said differently I have a hard time imagining a Home.java class representing the whole system. Am I the only one?
You need to explain how you see the "whole system" exposed in the UI.
I don't think we need to have it exposed in the UI. I was thinking mostly about xwiki.org documentation and API (like the new model).
Suppose we call it "Foo", what will the "Foo" link lead to? It has to be a document. With our current capabilities it can only be a document on the main wiki, so the main wiki _represents_ the whole system. It's not the whole system, it's just the entry point (Home) for the whole system. Same as the root node of a tree represents/defines the tree even if it's just a node in the tree like the rest and not the entire tree.
To summarize, I think we can have Home in the UI and System in Java.
Ok.
The other decision related to this is whether we stop calling the main wiki "the main wiki" in the API for example… That's a tough one since we're all so used to calling it the main wiki… Calling it the Home wiki and changing the API would take time ;) Any idea?
Thanks -Vincent
I'm also for Add > Wiki
Thanks, Marius
Thanks -Vincent
Thanks, Caty
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
OK. Vincent is OK Caty is OK Marius is OK Thomas is OK Sergiu is OK (on IRC) I am OK. 6 peoples are OK (5 commiters), I now use "Wiki" instead of "SubWiki" in my Workspace Integration. I will update all my pull requests and make a new one to correct the one that has been merge to platform. Thanks, Guillaume 2013/9/4 Thomas Mortagne <[email protected]> > I prefer to stay with Wiki, changing this is a big change and I prefer > "wiki" over "subwiki" anyway (I never agreed on this change). > > On Tue, Sep 3, 2013 at 5:35 PM, Vincent Massol <[email protected]> wrote: > > > > On Sep 3, 2013, at 5:15 PM, Marius Dumitru Florea < > [email protected]> wrote: > > > >> On Mon, Sep 2, 2013 at 2:52 PM, Vincent Massol <[email protected]> > wrote: > >>> Hi Caty, > >>> > >>> On Sep 2, 2013, at 1:44 PM, Ecaterina Moraru (Valica) < > [email protected]> wrote: > >>> > >>>> On Mon, Sep 2, 2013 at 1:02 PM, Vincent Massol <[email protected]> > wrote: > >>>> > >>>>> Hi devs, > >>>>> > >>>>> We've recently discussed about renaming the notion of (sub)wiki from > >>>>> "wiki" to "subwiki". We've discussed this in the context of > integrating > >>>>> creation of (sub)wikis by default in the platform and in XE. So the > latest > >>>>> discussion seemed to agree about: > >>>>> * Calling the whole system a "Wiki" > >>>>> * Calling each (sub)wikis a "SubWiki" > >>>>> > >>>>> Now, I was working on updating the new model branch I have created to > >>>>> align to this and to rename my Server class to a Wiki class and my > existing > >>>>> Wiki class to a SubWiki class… > >>>>> > >>>>> I've realized that aligning our API on this is a huge task since we > have > >>>>> tons of APIs using the word "wiki". Just to cite 3: > >>>>> * WikiReference (reference) > >>>>> * WikiComponentScope.WIKI (wiki component) > >>>>> * WikiDeletedEvent (bridge) > >>>>> > >>>>> It's a bit everywhere and changing that seems too big a task IMO. > >>>>> > >>>>> Thus we have 2 real choices IMO: > >>>>> * Agree that the UI has a different wording than the API: SubWiki > for the > >>>>> UI and Wiki for the API > >>>>> * Don't use subwiki in the UI and keep using Wiki in the UI and find > >>>>> another word to represent the whole system (System/Portal/Wiki > System/WMS = > >>>>> Wiki Management System/Home/etc). > >>>>> > >>>> > >>>> As already stated in the previous workspace mails, I prefer the wiki > + home > >>>> variant. > >>> > >>> So in the Add menu we would have: > >>> Add > Wiki > >>> > >>> Home cannot represent the whole system IMO. It could possibly > represent the main wiki but I don't see how it could represent the whole > system. Said differently I have a hard time imagining a Home.java class > representing the whole system. Am I the only one? > >> > >> You need to explain how you see the "whole system" exposed in the UI. > > > > I don't think we need to have it exposed in the UI. I was thinking > mostly about xwiki.org documentation and API (like the new model). > > > >> Suppose we call it "Foo", what will the "Foo" link lead to? It has to > >> be a document. With our current capabilities it can only be a document > >> on the main wiki, so the main wiki _represents_ the whole system. It's > >> not the whole system, it's just the entry point (Home) for the whole > >> system. Same as the root node of a tree represents/defines the tree > >> even if it's just a node in the tree like the rest and not the entire > >> tree. > >> > >> To summarize, I think we can have Home in the UI and System in Java. > > > > Ok. > > > > The other decision related to this is whether we stop calling the main > wiki "the main wiki" in the API for example… That's a tough one since we're > all so used to calling it the main wiki… Calling it the Home wiki and > changing the API would take time ;) Any idea? > > > > Thanks > > -Vincent > > > >> I'm also for Add > Wiki > >> > >> Thanks, > >> Marius > >> > >>> > >>> Thanks > >>> -Vincent > >>>> > >>>> Thanks, > >>>> Caty > >>>> > >>>> > >>>>> > >>>>> WDYT? > >>>>> > >>>>> Thanks > >>>>> -Vincent > > > > _______________________________________________ > > 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 >
On Sep 2, 2013, at 12:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
3rd choice: * Use SubWiki whenever we create new APIs * Keep existing APIs unchanged * This means that progressively our API will move from "Wiki" to "SubWiki". This is maybe the more realistic solution, even if not perfect, WDYT? Thanks -Vincent
WDYT?
Thanks -Vincent
On Sep 3, 2013, at 2:54 PM, Vincent Massol <[email protected]> wrote:
On Sep 2, 2013, at 12:02 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We've recently discussed about renaming the notion of (sub)wiki from "wiki" to "subwiki". We've discussed this in the context of integrating creation of (sub)wikis by default in the platform and in XE. So the latest discussion seemed to agree about: * Calling the whole system a "Wiki" * Calling each (sub)wikis a "SubWiki"
Now, I was working on updating the new model branch I have created to align to this and to rename my Server class to a Wiki class and my existing Wiki class to a SubWiki class…
I've realized that aligning our API on this is a huge task since we have tons of APIs using the word "wiki". Just to cite 3: * WikiReference (reference) * WikiComponentScope.WIKI (wiki component) * WikiDeletedEvent (bridge)
It's a bit everywhere and changing that seems too big a task IMO.
Thus we have 2 real choices IMO: * Agree that the UI has a different wording than the API: SubWiki for the UI and Wiki for the API * Don't use subwiki in the UI and keep using Wiki in the UI and find another word to represent the whole system (System/Portal/Wiki System/WMS = Wiki Management System/Home/etc).
3rd choice: * Use SubWiki whenever we create new APIs * Keep existing APIs unchanged * This means that progressively our API will move from "Wiki" to "SubWiki".
This is maybe the more realistic solution, even if not perfect, WDYT?
Personally I'm fine to keep the "Wiki" terminology and thus have Add > Wiki. Thanks -Vincent
Thanks -Vincent
WDYT?
Thanks -Vincent
participants (5)
-
Ecaterina Moraru (Valica) -
Guillaume "Louis-Marie" Delhumeau -
Marius Dumitru Florea -
Thomas Mortagne -
Vincent Massol