[xwiki-devs] Gadgets & Dashboard roadmap
Hi all, I am now restarting the work on the gadgets & dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised). What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros, * also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A) * there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard. The big picture of the roadmap is that we should: 1/ have a fully working dashboard, that is implement add gadget and edit gadget settings 2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu 3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard 4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard 5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions 6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed. Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C) my +1 for (A), (B) and (C). Happy hacking, Anca
On Mon, Jun 21, 2010 at 16:10, Anca Luca <[email protected]> wrote:
Hi all,
I am now restarting the work on the gadgets & dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros, * also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
+1
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings 2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu 3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard 4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard 5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions 6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
Not sure what you mean in 6/
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
+1 sounds good
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1
my +1 for (A), (B) and (C).
Happy hacking, Anca
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
Hi Anca, Here are some rough mockups I did for Ana-Maria: http://incubator.myxwiki.org/xwiki/bin/view/Improvements/GadgetsDirectory http://incubator.myxwiki.org/xwiki/bin/view/Improvements/GadgetsDashboard Then lots of things were uncertain. It would be great to have some clear requirements for the macros (types, level of customization, etc) and provide also some feedback on those two proposals. Thanks, Caty On Mon, Jun 21, 2010 at 19:04, Thomas Mortagne <[email protected]>wrote:
On Mon, Jun 21, 2010 at 16:10, Anca Luca <[email protected]> wrote:
Hi all,
I am now restarting the work on the gadgets & dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros, * also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
+1
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings 2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu 3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard 4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard 5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions 6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
Not sure what you mean in 6/
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
+1 sounds good
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1
my +1 for (A), (B) and (C).
Happy hacking, Anca
_______________________________________________ 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 06/21/2010 07:04 PM, Thomas Mortagne wrote:
On Mon, Jun 21, 2010 at 16:10, Anca Luca<[email protected]> wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros, * also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
+1
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings 2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu 3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard 4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard 5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions 6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
Not sure what you mean in 6/
Publishing the XWiki gadgets ("most viewed pages", for example) as open social gadgets, so that they can be used anywhere where gadgets are supported (iGoogle, for example). Basically we would need to be able to (automatically) publish such thing http://code.google.com/apis/gadgets/docs/reference.html for all these gadgets. Thanks, Anca
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
+1 sounds good
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1
my +1 for (A), (B) and (C).
Happy hacking, Anca
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Tue, Jun 22, 2010 at 18:45, Anca Luca <[email protected]> wrote:
On 06/21/2010 07:04 PM, Thomas Mortagne wrote:
On Mon, Jun 21, 2010 at 16:10, Anca Luca<[email protected]> wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros, * also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
+1
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings 2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu 3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard 4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard 5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions 6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
Not sure what you mean in 6/
Publishing the XWiki gadgets ("most viewed pages", for example) as open social gadgets, so that they can be used anywhere where gadgets are supported (iGoogle, for example). Basically we would need to be able to (automatically) publish such thing http://code.google.com/apis/gadgets/docs/reference.html for all these gadgets.
Yep i finally got it with the answer Vincent gave to it but thanks :)
Thanks, Anca
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
+1 sounds good
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1
my +1 for (A), (B) and (C).
Happy hacking, Anca
_______________________________________________ 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
Hi Anca, On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets & dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets. Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}} As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}. If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6. Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
On 06/22/2010 10:04 AM, Vincent Massol wrote:
Hi Anca,
On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
The initial approach was to _import_ gadgets as wiki macros. This has the advantage that we can reuse tools from wiki macros and that gadgets become more wiki syntax friendly: {{clock width="50px"/}} vs. {{gadget url="http://gadgets.repository.com/misc/clock?width=50px"/}} Marius
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets.
Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}}
As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}.
If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6.
Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi Vincent, On 06/22/2010 10:04 AM, Vincent Massol wrote:
Hi Anca,
On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
See this thread http://markmail.org/message/f4gclxpff74vzu6t from around the place where I linked. That is a discussion around this design page http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HProposal2-Mult... from which the option which I anchored to was used.
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets.
Why? why not any macro? such that the dashboard is only about layouting, and attaching the appropriate js to do drag & drop, edits in place, etc. I think in this way we would be able to have easier integration of the xwiki content in the xwiki dashboard.
Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}}
As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}.
yes, the idea is to use xwiki structured data to specify such a gadget, and then automatically generate the open soc gadget XML from that. Jerome, what do you think of this approach? So as I see it there are 2 approaches to this: 1/ make xwiki an open social container working only with open social gadgets only and providing a mean to use xwiki content/macros in such a gadget 2/ have xwiki gadgets & dashboard work with macros and provide ways to import an OS gadget in an xwiki macro and export an xwiki macro as an open social gadget. We could discuss here pros and cons. WDYT? Thanks, Anca
If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6.
Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Jun 22, 2010, at 6:59 PM, Anca Luca wrote:
Hi Vincent,
On 06/22/2010 10:04 AM, Vincent Massol wrote:
Hi Anca,
On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
See this thread http://markmail.org/message/f4gclxpff74vzu6t from around the place where I linked. That is a discussion around this design page http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HProposal2-Mult... from which the option which I anchored to was used.
Ok I'll need some time to read this.
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets.
Why? why not any macro?
Why just macros? Why not any wiki syntax? I don't understand why you'd restrict it to macros?
such that the dashboard is only about layouting, and attaching the appropriate js to do drag & drop, edits in place, etc.
How do you specify the width and height + other gadget metadata (title, etc)? Thanks -Vincent
I think in this way we would be able to have easier integration of the xwiki content in the xwiki dashboard.
Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}}
As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}.
yes, the idea is to use xwiki structured data to specify such a gadget, and then automatically generate the open soc gadget XML from that.
Jerome, what do you think of this approach?
So as I see it there are 2 approaches to this: 1/ make xwiki an open social container working only with open social gadgets only and providing a mean to use xwiki content/macros in such a gadget 2/ have xwiki gadgets & dashboard work with macros and provide ways to import an OS gadget in an xwiki macro and export an xwiki macro as an open social gadget.
We could discuss here pros and cons.
WDYT?
Thanks, Anca
If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6.
Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
On 06/22/2010 08:03 PM, Vincent Massol wrote:
On Jun 22, 2010, at 6:59 PM, Anca Luca wrote:
Hi Vincent,
On 06/22/2010 10:04 AM, Vincent Massol wrote:
Hi Anca,
On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
See this thread http://markmail.org/message/f4gclxpff74vzu6t from around the place where I linked. That is a discussion around this design page http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HProposal2-Mult... from which the option which I anchored to was used.
Ok I'll need some time to read this.
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets.
Why? why not any macro?
Why just macros? Why not any wiki syntax? I don't understand why you'd restrict it to macros?
The question here is if we want to have generic stuff with generic parameters, such as: {{gadgetwrapper width="" height="" title=""}} dishwashing wiki code here {{/gadgetwrapper}} in which case when editing the settings you'd make the users edit the generic params and when you want to customize the dishwashing gadget you'd have to edit content, or provide (actually make developers provide): {{dishwashing numberofdishes="" detergentbrand="" ... }} maybe some code here {{/dishwashing}} in which case editing this gadget's settings would be about customizing the gadget itself, not about generic customizing. I'd go for second option, since it also allows first option, whereas the reverse does not hold. This is also in the spirit of importing google gadgets as macros instead of using just one macro with xml as param.
such that the dashboard is only about layouting, and attaching the appropriate js to do drag& drop, edits in place, etc.
How do you specify the width and height + other gadget metadata (title, etc)?
width & height == dashboard css title = could not exist, it's the macros responsibility what it displays in its box (as it's implemented right now on the incubator). Why would it have to be controlled at dashboard level? Thanks, Anca
Thanks -Vincent
I think in this way we would be able to have easier integration of the xwiki content in the xwiki dashboard.
Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}}
As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}.
yes, the idea is to use xwiki structured data to specify such a gadget, and then automatically generate the open soc gadget XML from that.
Jerome, what do you think of this approach?
So as I see it there are 2 approaches to this: 1/ make xwiki an open social container working only with open social gadgets only and providing a mean to use xwiki content/macros in such a gadget 2/ have xwiki gadgets& dashboard work with macros and provide ways to import an OS gadget in an xwiki macro and export an xwiki macro as an open social gadget.
We could discuss here pros and cons.
WDYT?
Thanks, Anca
If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6.
Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Jun 22, 2010, at 7:22 PM, Anca Luca wrote:
On 06/22/2010 08:03 PM, Vincent Massol wrote:
On Jun 22, 2010, at 6:59 PM, Anca Luca wrote:
Hi Vincent,
On 06/22/2010 10:04 AM, Vincent Massol wrote:
Hi Anca,
On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
See this thread http://markmail.org/message/f4gclxpff74vzu6t from around the place where I linked. That is a discussion around this design page http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HProposal2-Mult... from which the option which I anchored to was used.
Ok I'll need some time to read this.
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets.
Why? why not any macro?
Why just macros? Why not any wiki syntax? I don't understand why you'd restrict it to macros?
The question here is if we want to have generic stuff with generic parameters, such as:
{{gadgetwrapper width="" height="" title=""}} dishwashing wiki code here {{/gadgetwrapper}}
in which case when editing the settings you'd make the users edit the generic params and when you want to customize the dishwashing gadget you'd have to edit content,
or provide (actually make developers provide):
{{dishwashing numberofdishes="" detergentbrand="" ... }} maybe some code here {{/dishwashing}}
in which case editing this gadget's settings would be about customizing the gadget itself, not about generic customizing.
I'd go for second option, since it also allows first option, whereas the reverse does not hold. This is also in the spirit of importing google gadgets as macros instead of using just one macro with xml as param.
If you take the second option then you just cannot convert any wiki content into a gadget. You'll need to write specific code for that. The point of the gadgetwrapper is to allow *any* wiki syntax to become a gadget. As I said in my first mail if we don't want this then we should have a Gadget object that you add to a gadget content page and a Gadget sheet to generate the XML.
such that the dashboard is only about layouting, and attaching the appropriate js to do drag& drop, edits in place, etc.
How do you specify the width and height + other gadget metadata (title, etc)?
width & height == dashboard css
I'm not talking about dashboard width and height but about gadget's width and height. Have a look at the current dashboard as an example and you'll see that the various portions of the screen don't have the same width and height. Having always the same width & height make it very unnatural since some content require more space than others, some scale better horizontally than others, same for vertical, etc.
title = could not exist, it's the macros responsibility what it displays in its box (as it's implemented right now on the incubator). Why would it have to be controlled at dashboard level?
It should not be controlled at dashboard level but at gadget level. That's the reason for the gadget macro.... What's inside the gadget can be anything and don't have any relationship with gadgets. What makes it a gadget is the wrapping with a gadgetwrapper macro. Thus you need add gadget metadata somehow and that wrapper could provide it. It also makes a container so that you can put any wiki syntax inside it which is not possible otherwise. Last it allows to output additional divs/span which provide hooks for CSS styling. Thanks -Vincent PS: I still haven't read the docs you pointed me to.
Thanks, Anca
Thanks -Vincent
I think in this way we would be able to have easier integration of the xwiki content in the xwiki dashboard.
Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}}
As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}.
yes, the idea is to use xwiki structured data to specify such a gadget, and then automatically generate the open soc gadget XML from that.
Jerome, what do you think of this approach?
So as I see it there are 2 approaches to this: 1/ make xwiki an open social container working only with open social gadgets only and providing a mean to use xwiki content/macros in such a gadget 2/ have xwiki gadgets& dashboard work with macros and provide ways to import an OS gadget in an xwiki macro and export an xwiki macro as an open social gadget.
We could discuss here pros and cons.
WDYT?
Thanks, Anca
If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6.
Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
On 06/22/2010 10:54 PM, Vincent Massol wrote:
On Jun 22, 2010, at 7:22 PM, Anca Luca wrote:
On 06/22/2010 08:03 PM, Vincent Massol wrote:
On Jun 22, 2010, at 6:59 PM, Anca Luca wrote:
Hi Vincent,
On 06/22/2010 10:04 AM, Vincent Massol wrote:
Hi Anca,
On Jun 21, 2010, at 4:10 PM, Anca Luca wrote:
Hi all,
I am now restarting the work on the gadgets& dashboard project, documented here http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration (however documentation needs to be slightly revised).
What is done already can be summarized as: * gadgets are implemented as macros and there is a script to import google gadgets as xwiki macros,
WDYM by script? Isn't there's simple a {{gadget url="..."}} macro with a URL pointing to the gadget xml URL?
See this thread http://markmail.org/message/f4gclxpff74vzu6t from around the place where I linked. That is a discussion around this design page http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HProposal2-Mult... from which the option which I anchored to was used.
Ok I'll need some time to read this.
* also, right now, gadgets are implemented as xwiki macros and can be used anywhere just like a regular wiki macro, and any wiki macro can be seen/used as a gadget so **there is no difference between macros and gadgets** . WDYT about this? should we keep it like that? (A)
I think there are differences. One of them is the preferred size (width, height). IMO the {{dashboard}} macro should only accept {{gadget}} macros (real open social gadgets) and {{gadgetwrapper}} macros (wrapper around any wiki syntax), and for {{gadgetwrapper}} you could specify additional metadata such as preferred width, height and whatever the opensocial spec offers for gadgets.
Why? why not any macro?
Why just macros? Why not any wiki syntax? I don't understand why you'd restrict it to macros?
The question here is if we want to have generic stuff with generic parameters, such as:
{{gadgetwrapper width="" height="" title=""}} dishwashing wiki code here {{/gadgetwrapper}}
in which case when editing the settings you'd make the users edit the generic params and when you want to customize the dishwashing gadget you'd have to edit content,
or provide (actually make developers provide):
{{dishwashing numberofdishes="" detergentbrand="" ... }} maybe some code here {{/dishwashing}}
in which case editing this gadget's settings would be about customizing the gadget itself, not about generic customizing.
I'd go for second option, since it also allows first option, whereas the reverse does not hold. This is also in the spirit of importing google gadgets as macros instead of using just one macro with xml as param.
If you take the second option then you just cannot convert any wiki content into a gadget. You'll need to write specific code for that. The point of the gadgetwrapper is to allow *any* wiki syntax to become a gadget. As I said in my first mail if we don't want this then we should have a Gadget object that you add to a gadget content page and a Gadget sheet to generate the XML.
We're either talking about different things or... My idea was that if you choose second option, that is use any macro as a gadget, and write macros as gadgets, then one of these gadgets / macros can be the gadgetwrapper macro which will allow any syntax inside, whereas if you say that all gadgets with wiki content will be in a gadgetwrapper macro, then you only have one generic method, with generic parameters for this macro, and there is no way to have specific gadgets with wiki content, configurable with specific params. I understand that if it's a gadgetwrapper macro then you can put the dishwashing macro in it (and anything else for that matter), but you cannot configure it directly through the params, you will have to edit the content (which yes, can be in turn considered as a parameter), instead of just passing some params to a macro. still in course of making it all clear in my head... Thanks, Anca
such that the dashboard is only about layouting, and attaching the appropriate js to do drag& drop, edits in place, etc.
How do you specify the width and height + other gadget metadata (title, etc)?
width& height == dashboard css
I'm not talking about dashboard width and height but about gadget's width and height. Have a look at the current dashboard as an example and you'll see that the various portions of the screen don't have the same width and height. Having always the same width& height make it very unnatural since some content require more space than others, some scale better horizontally than others, same for vertical, etc.
title = could not exist, it's the macros responsibility what it displays in its box (as it's implemented right now on the incubator). Why would it have to be controlled at dashboard level?
It should not be controlled at dashboard level but at gadget level. That's the reason for the gadget macro.... What's inside the gadget can be anything and don't have any relationship with gadgets. What makes it a gadget is the wrapping with a gadgetwrapper macro. Thus you need add gadget metadata somehow and that wrapper could provide it. It also makes a container so that you can put any wiki syntax inside it which is not possible otherwise. Last it allows to output additional divs/span which provide hooks for CSS styling.
Thanks -Vincent
PS: I still haven't read the docs you pointed me to.
Thanks, Anca
Thanks -Vincent
I think in this way we would be able to have easier integration of the xwiki content in the xwiki dashboard.
Something like: {{dashboard layout="..." ....}} {{gadget.../}} {{gadgetwrapper.../}} ... {{/dashboard}}
As for transforming a given wiki page into an open social gadget we could have a Gadget object you would add to a page and have a sheet that will generate the XML based on the content + the metadata from that object. Then you could use it directly inside the {{dashboard}} macro using a {{gadget url="url to the xwiki page which generates the xml"}}.
yes, the idea is to use xwiki structured data to specify such a gadget, and then automatically generate the open soc gadget XML from that.
Jerome, what do you think of this approach?
So as I see it there are 2 approaches to this: 1/ make xwiki an open social container working only with open social gadgets only and providing a mean to use xwiki content/macros in such a gadget 2/ have xwiki gadgets& dashboard work with macros and provide ways to import an OS gadget in an xwiki macro and export an xwiki macro as an open social gadget.
We could discuss here pros and cons.
WDYT?
Thanks, Anca
If we think it's too much work to have both, then I would be for dropping the {{gadgetwrapper}} macro and have only one {{gadget}} macro and force code to be put in separate pages with a Gadget object attached. We would need to migrate Panels to gadgets for this to work though, so introducing a {{gadgetwrapper}} is a nicer transition path IMO.
* there is a dashboard macro responsible with layouting a gadgets dashboard, which also provides specific editing features in inline mode (gadgets can be dragged around, toolboxes for gadgets in the top right) * there is a minimal macros directory, where one can see all the existing macros, descriptions, details about the parameters. * there is an PanelMacro macro, that displays an xwiki panel inside a document, which can be used to display xwiki panels as gadgets in a dashboard.
The big picture of the roadmap is that we should:
1/ have a fully working dashboard, that is implement add gadget and edit gadget settings
+1
2/ implement the main dashboard (Main.Dashboard) as a dashboard and fill it with the appropriate gadgets by default, and also to add a user specific dashboard ("My dashboard") where each user can configure his/her dashboard, and is available to a user from his / her profile or the user menu
+1 with the ability for a user to decide if the home page displays the default dashboard or his personal dashboard.
3/ have a nice macros directory where a user can navigate through existing gadgets and add one to a dashboard
+1
4/ have a "dashboard template", integrated with the document templates system to easily allow a user to create a dashboard
+1, and also add a Add Gadget template provider.
5/ also, since the xwiki panels can be seen as gadgets / macros, and can be implemented as such, somewhere in the future a refactoring should be made to integrate the 2 notions
+1
6/ be able to publish the gadgets in the wiki such that other apps can integrate this in their content
That's the solution I've proposed above.
WDYT about the order above? (B) with the mention that points 5 and 6 could eventually be infinitely postponed.
Whatever solution we choose we have to take 5 and 6 into account right now.
Also, after points 1 and 2 are implemented, the feature could be available with xwiki platform and integrated in XE by default. WDYT? (C)
+1 but provided we have a sound architecture that allows for 5 and 6.
Thanks -Vincent
my +1 for (A), (B) and (C).
Happy hacking, Anca
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
participants (5)
-
Anca Luca -
Ecaterina Valica -
Marius Dumitru Florea -
Thomas Mortagne -
Vincent Massol