[xwiki-devs] Google Gadgets Integration - Status & Request for Feedback
Hi devs, I wanted to show you what work has been done until now on the Google Gadgets Integration, talk a bit about the next steps and ask for feedback. I put up the gadgets work on the incubator, so you can take a quick look. Mostly I'm interested in the minimum subset of features and changes that I need to make in order to have something worth integrating in a future release. Macro Directory: (for all Wiki Macros and Java Macros) http://incubator.myxwiki.org/xwiki/bin/view/Macros/ Macro Description Page: http://incubator.myxwiki.org/xwiki/bin/view/Macros/Macro?id=wc99 Dashboard Macro Test: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest The dashboard example contains 3 macros imported from Panels, like Last Members, My Recent Modifications and Blog Categories, and 1 macro imported from a Google Gadget: World Clocks. (I named it w99) Import Google Gadget as Macro Form: http://incubator.myxwiki.org/xwiki/bin/view/Macros/GoogleGadgetsImport WYSIWYG Integration: - easily edit all Google Gadget Macros parameters/user preferences (if inserted alone on the page) - if a macro is inside the Dashboard macro, you don't have access to editing its parameters. Ideally, in the future this kind of interaction would be nice to have: http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... (Test both of the above here: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest) I'm planning to work next on: - AJAX requests to update dashboard state after each drag&drop action (modify the content of the dashboard to reflect the new order of the gadgets - Add Thumbnail and Screenshots support for Macros - Nice UI for Dashboard and Macros Directory (already asked Caty for help here) More work after that: - Add Macros(Gadgets) to a Dashboard (either from the Directory and/or through WYSIWYG editor) - Convert all Panels to Wiki Macros (Question here: What happens with the panel headers? Do I transform them into headings like in the Last Members, My Recent Modifications, Blog Categories examples? If so, how would they be placed on the side, in the empty shell containers to keep looking like they do now? ( http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... or http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... ?) - Create types for Wiki Macro parameters: boolean, enum, (int), string (very inconvenient right now for enum types for gadgets with a lot of options -- e.g. see time zone parameters (up_tz1) for World Clock macro --> problem would be nicely solved with a Select) - Allow custom number of columns for Dashboard Questions: - Should dashboard cells have titles? If so, what happens to the titles of Panel origin Macros? (see discussion a little more above) - Is the current syntax of dashboards OK? {{dashboard}} 1 {{members/}} 1 {{myrecentmodifications/}} 2 {{blogcategories/}} 3 {{wc99 title='Another Clock Gadget' w='280' h='280' up_tz1name='Bucharest' up_tz2name='Paris' up_tz1='RO' up_tz2='FR'/}} {{/dashboard}} , where each line represents a cell, the first number being the column number, one blank space and the the content of the cell. For a given column, the order of appearance is important, being treated as a stack (one cell above another). * Keep in mind: - the lines need to be easily update by many AJAX requests issued at each Drag&Drop on the dashboard (both their order, and also the column numbers) - content available in wiki editor - currently does not allow multiple lines for one cell (would a lot more complicated for the AJAX updates) - currently has no title - do we need a title?? SVN: - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/xwiki-gadgets/ (Java Components) - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/gadgets/ (XAR) Thanks for the feedback, Anamaria
Hi Anamaria, Thanks for this email to let us know about the status! See below On Mar 23, 2010, at 1:37 PM, Anamaria Stoica wrote:
Hi devs,
I wanted to show you what work has been done until now on the Google Gadgets Integration, talk a bit about the next steps and ask for feedback. I put up the gadgets work on the incubator, so you can take a quick look.
Mostly I'm interested in the minimum subset of features and changes that I need to make in order to have something worth integrating in a future release.
some feedback.
Macro Directory: (for all Wiki Macros and Java Macros) http://incubator.myxwiki.org/xwiki/bin/view/Macros/
I think it would be better displayed as a livetable with several columns: - Description - Category - Action column Not sure we need the type displayed. However I think that for Wiki macro the action column should propose to edit/delete the macro. Question: Where should this macro directory be displayed in the wiki? In AllDocs as a new tab? Somewhere else? Only for admins in the admin page?
Macro Description Page: http://incubator.myxwiki.org/xwiki/bin/view/Macros/Macro?id=wc99
I wonder if both the macro directory and this description page pages should be located in the wiki macro application. There's already a I'll send another email later on to try to provide feedback on the stuff below. Thanks -Vincent
Dashboard Macro Test: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest
The dashboard example contains 3 macros imported from Panels, like Last Members, My Recent Modifications and Blog Categories, and 1 macro imported from a Google Gadget: World Clocks. (I named it w99)
Import Google Gadget as Macro Form: http://incubator.myxwiki.org/xwiki/bin/view/Macros/GoogleGadgetsImport
WYSIWYG Integration: - easily edit all Google Gadget Macros parameters/user preferences (if inserted alone on the page) - if a macro is inside the Dashboard macro, you don't have access to editing its parameters. Ideally, in the future this kind of interaction would be nice to have: http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... (Test both of the above here: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest)
I'm planning to work next on: - AJAX requests to update dashboard state after each drag&drop action (modify the content of the dashboard to reflect the new order of the gadgets - Add Thumbnail and Screenshots support for Macros - Nice UI for Dashboard and Macros Directory (already asked Caty for help here)
More work after that: - Add Macros(Gadgets) to a Dashboard (either from the Directory and/or through WYSIWYG editor) - Convert all Panels to Wiki Macros (Question here: What happens with the panel headers? Do I transform them into headings like in the Last Members, My Recent Modifications, Blog Categories examples? If so, how would they be placed on the side, in the empty shell containers to keep looking like they do now? ( http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... or http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... ?) - Create types for Wiki Macro parameters: boolean, enum, (int), string (very inconvenient right now for enum types for gadgets with a lot of options -- e.g. see time zone parameters (up_tz1) for World Clock macro --> problem would be nicely solved with a Select) - Allow custom number of columns for Dashboard
Questions: - Should dashboard cells have titles? If so, what happens to the titles of Panel origin Macros? (see discussion a little more above) - Is the current syntax of dashboards OK? {{dashboard}} 1 {{members/}} 1 {{myrecentmodifications/}} 2 {{blogcategories/}} 3 {{wc99 title='Another Clock Gadget' w='280' h='280' up_tz1name='Bucharest' up_tz2name='Paris' up_tz1='RO' up_tz2='FR'/}} {{/dashboard}} , where each line represents a cell, the first number being the column number, one blank space and the the content of the cell. For a given column, the order of appearance is important, being treated as a stack (one cell above another). * Keep in mind: - the lines need to be easily update by many AJAX requests issued at each Drag&Drop on the dashboard (both their order, and also the column numbers) - content available in wiki editor - currently does not allow multiple lines for one cell (would a lot more complicated for the AJAX updates) - currently has no title - do we need a title??
SVN: - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/xwiki-gadgets/ (Java Components) - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/gadgets/ (XAR)
Thanks for the feedback, Anamaria
Hi Vincent, On Tue, Mar 23, 2010 at 3:01 PM, Vincent Massol <vincent@massol.net> wrote:
Hi Anamaria,
Thanks for this email to let us know about the status!
See below
On Mar 23, 2010, at 1:37 PM, Anamaria Stoica wrote:
Hi devs,
I wanted to show you what work has been done until now on the Google Gadgets Integration, talk a bit about the next steps and ask for feedback. I put up the gadgets work on the incubator, so you can take a quick look.
Mostly I'm interested in the minimum subset of features and changes that I need to make in order to have something worth integrating in a future release.
some feedback.
Macro Directory: (for all Wiki Macros and Java Macros) http://incubator.myxwiki.org/xwiki/bin/view/Macros/
I think it would be better displayed as a livetable with several columns: - Description - Category - Action column
Not sure we need the type displayed. However I think that for Wiki macro the action column should propose to edit/delete the macro.
A edit/delete displayed to next of each macro is definitely needed, displayed only for Admins. Question: what happens for Java Macros? (can they be deleted, edited?)
Question: Where should this macro directory be displayed in the wiki? In AllDocs as a new tab? Somewhere else? Only for admins in the admin page?
The macro directory needs to be somewhere accessible to everyone. All users should be able to easily browse it, and check out the macros. Also a *Add to dashboard* button should be displayed next to each of the macros. Should look something like this: http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... And when adding a Macro to a dashboard, something like this: http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... I think only Admins should be able to: import Google Gadgets as Macros, edit, delete macros. Thanks, Anamaria
Macro Description Page: http://incubator.myxwiki.org/xwiki/bin/view/Macros/Macro?id=wc99
I wonder if both the macro directory and this description page pages should be located in the wiki macro application. There's already a
I'll send another email later on to try to provide feedback on the stuff below.
Thanks -Vincent
Dashboard Macro Test: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest
The dashboard example contains 3 macros imported from Panels, like Last Members, My Recent Modifications and Blog Categories, and 1 macro imported from a Google Gadget: World Clocks. (I named it w99)
Import Google Gadget as Macro Form: http://incubator.myxwiki.org/xwiki/bin/view/Macros/GoogleGadgetsImport
WYSIWYG Integration: - easily edit all Google Gadget Macros parameters/user preferences (if inserted alone on the page) - if a macro is inside the Dashboard macro, you don't have access to editing its parameters. Ideally, in the future this kind of interaction would be nice to have: http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... (Test both of the above here: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest)
I'm planning to work next on: - AJAX requests to update dashboard state after each drag&drop action (modify the content of the dashboard to reflect the new order of the gadgets - Add Thumbnail and Screenshots support for Macros - Nice UI for Dashboard and Macros Directory (already asked Caty for help here)
More work after that: - Add Macros(Gadgets) to a Dashboard (either from the Directory and/or through WYSIWYG editor) - Convert all Panels to Wiki Macros (Question here: What happens with the panel headers? Do I transform them into headings like in the Last Members, My Recent Modifications, Blog Categories examples? If so, how would they be placed on the side, in the empty shell containers to keep looking like they do now? ( http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... or http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... ?) - Create types for Wiki Macro parameters: boolean, enum, (int), string (very inconvenient right now for enum types for gadgets with a lot of options -- e.g. see time zone parameters (up_tz1) for World Clock macro --> problem would be nicely solved with a Select) - Allow custom number of columns for Dashboard
Questions: - Should dashboard cells have titles? If so, what happens to the titles of Panel origin Macros? (see discussion a little more above) - Is the current syntax of dashboards OK? {{dashboard}} 1 {{members/}} 1 {{myrecentmodifications/}} 2 {{blogcategories/}} 3 {{wc99 title='Another Clock Gadget' w='280' h='280' up_tz1name='Bucharest' up_tz2name='Paris' up_tz1='RO' up_tz2='FR'/}} {{/dashboard}} , where each line represents a cell, the first number being the column number, one blank space and the the content of the cell. For a given column, the order of appearance is important, being treated as a stack (one cell above another). * Keep in mind: - the lines need to be easily update by many AJAX requests issued at each Drag&Drop on the dashboard (both their order, and also the column numbers) - content available in wiki editor - currently does not allow multiple lines for one cell (would a lot more complicated for the AJAX updates) - currently has no title - do we need a title??
SVN: - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/xwiki-gadgets/ (Java Components) - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/gadgets/ (XAR)
Thanks for the feedback, Anamaria
devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
Hi Anamaria,
Thanks for this email to let us know about the status!
See below
On Mar 23, 2010, at 1:37 PM, Anamaria Stoica wrote:
Hi devs,
I wanted to show you what work has been done until now on the Google Gadgets Integration, talk a bit about the next steps and ask for feedback. I put up the gadgets work on the incubator, so you can take a quick look.
Mostly I'm interested in the minimum subset of features and changes that I need to make in order to have something worth integrating in a future release.
some feedback.
Macro Directory: (for all Wiki Macros and Java Macros) http://incubator.myxwiki.org/xwiki/bin/view/Macros/
I think it would be better displayed as a livetable with several columns: - Description - Category - Action column
Not sure we need the type displayed. However I think that for Wiki macro the action column should propose to edit/delete the macro.
Question: Where should this macro directory be displayed in the wiki? In AllDocs as a new tab? Somewhere else? Only for admins in the admin page?
I think it should not be in the AllDocs UI. Linked from the QuickLinks as "Macro Directory" maybe? Possibly from the WYSIWYG insert macro dialog UI, with a open in new window link, WDYT ?
Macro Description Page: http://incubator.myxwiki.org/xwiki/bin/view/Macros/Macro?id=wc99
I wonder if both the macro directory and this description page pages should be located in the wiki macro application.
The description page should be IMO the macro page itself as much as possible (with a MacroClassSheet) That's the XWiki way of applications and it allows to have the edit button which brings the macro in inline edition mode. For non-wiki macros, we can either say there is no such page - or use a generic page with a parameter like you did with Macro?id=XXX. Jerome. There's already a
I'll send another email later on to try to provide feedback on the stuff below.
Thanks -Vincent
Dashboard Macro Test: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest
The dashboard example contains 3 macros imported from Panels, like Last Members, My Recent Modifications and Blog Categories, and 1 macro imported from a Google Gadget: World Clocks. (I named it w99)
Import Google Gadget as Macro Form: http://incubator.myxwiki.org/xwiki/bin/view/Macros/GoogleGadgetsImport
WYSIWYG Integration: - easily edit all Google Gadget Macros parameters/user preferences (if inserted alone on the page) - if a macro is inside the Dashboard macro, you don't have access to editing its parameters. Ideally, in the future this kind of interaction would be nice to have: http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... (Test both of the above here: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest)
I'm planning to work next on: - AJAX requests to update dashboard state after each drag&drop action (modify the content of the dashboard to reflect the new order of the gadgets - Add Thumbnail and Screenshots support for Macros - Nice UI for Dashboard and Macros Directory (already asked Caty for help here)
More work after that: - Add Macros(Gadgets) to a Dashboard (either from the Directory and/or through WYSIWYG editor) - Convert all Panels to Wiki Macros (Question here: What happens with the panel headers? Do I transform them into headings like in the Last Members, My Recent Modifications, Blog Categories examples? If so, how would they be placed on the side, in the empty shell containers to keep looking like they do now? ( http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... or http://incubator.myxwiki.org/xwiki/bin/view/Mockups/GadgetsIntegrationPropos... ?) - Create types for Wiki Macro parameters: boolean, enum, (int), string (very inconvenient right now for enum types for gadgets with a lot of options -- e.g. see time zone parameters (up_tz1) for World Clock macro --> problem would be nicely solved with a Select) - Allow custom number of columns for Dashboard
Questions: - Should dashboard cells have titles? If so, what happens to the titles of Panel origin Macros? (see discussion a little more above) - Is the current syntax of dashboards OK? {{dashboard}} 1 {{members/}} 1 {{myrecentmodifications/}} 2 {{blogcategories/}} 3 {{wc99 title='Another Clock Gadget' w='280' h='280' up_tz1name='Bucharest' up_tz2name='Paris' up_tz1='RO' up_tz2='FR'/}} {{/dashboard}} , where each line represents a cell, the first number being the column number, one blank space and the the content of the cell. For a given column, the order of appearance is important, being treated as a stack (one cell above another). * Keep in mind: - the lines need to be easily update by many AJAX requests issued at each Drag&Drop on the dashboard (both their order, and also the column numbers) - content available in wiki editor - currently does not allow multiple lines for one cell (would a lot more complicated for the AJAX updates) - currently has no title - do we need a title??
SVN: - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/xwiki-gadgets/ (Java Components) - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/gadgets/ (XAR)
Thanks for the feedback, Anamaria
devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
Hi devs,
Hello Ana,
I wanted to show you what work has been done until now on the Google Gadgets Integration, talk a bit about the next steps and ask for feedback. I put up the gadgets work on the incubator, so you can take a quick look.
[snip]
SVN: - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/xwiki-gadgets/ (Java Components)
Quick feedback on the code in xwiki-gadgets/ (I only read it so far, I did not run it yet) * You can get rid of the VelocityContextInitializers classes, now XWiki supports script services. Just implement the ScriptService component role with your service name as a hint and you will have access to the binding in scripts under $services.yourServiceName (so gadgets and macros in your case). * Some classes are missing a minimal javadoc, to describe what the classes does. For example I opened the UserPrefs class and had no clue what preferences it was about (By the way I think you could go for the full name : UserPreferences rather than using abbrs.) What you can do is enable the checkstyle plugin in your build; this way you are forced to document as you write your code and not postpone it until the moment when you have too much to document and it becomes discouraging. It also can help detect early certain design issues. Jerome.
- https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/gadgets/ (XAR)
Thanks for the feedback, Anamaria _______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
Hi devs, I updated the test I put up on the incubator so that the Dashboard also saves the state of the gadgets on the dashboard after drag&drop now. In view mode, I display a button/link called >> Customize dashboard << (which is only visible for users with edit rights or admins), which takes the user to the inline edit mode. Only there you can start drag&dropping the gadgets on the dashboard. The state is saved only after clicking Save&Continue or Save&View buttons. The dashboard test is here: http://incubator.myxwiki.org/xwiki/bin/view/MacrosTest/DashboardTest Sergiu, could I also get some feedback on my code which does the update of the content, it's located in the JSX objected attached to the dashboard macro page (http://incubator.myxwiki.org/xwiki/bin/view/Macros/Dashboard). Thanks, Anamaria On Tue, Mar 23, 2010 at 7:45 PM, Jerome Velociter <jerome@xwiki.com> wrote:
Hi devs,
Hello Ana,
I wanted to show you what work has been done until now on the Google Gadgets Integration, talk a bit about the next steps and ask for feedback. I put up the gadgets work on the incubator, so you can take a quick look.
[snip]
SVN: - https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/xwiki-gadgets/ (Java Components)
Quick feedback on the code in xwiki-gadgets/ (I only read it so far, I did not run it yet)
* You can get rid of the VelocityContextInitializers classes, now XWiki supports script services. Just implement the ScriptService component role with your service name as a hint and you will have access to the binding in scripts under $services.yourServiceName (so gadgets and macros in your case).
* Some classes are missing a minimal javadoc, to describe what the classes does. For example I opened the UserPrefs class and had no clue what preferences it was about (By the way I think you could go for the full name : UserPreferences rather than using abbrs.) What you can do is enable the checkstyle plugin in your build; this way you are forced to document as you write your code and not postpone it until the moment when you have too much to document and it becomes discouraging. It also can help detect early certain design issues.
Jerome.
- https://svn.xwiki.org/svnroot/xwiki/contrib/sandbox/gadgets/ (XAR)
Thanks for the feedback, Anamaria _______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
On 03/26/2010 02:06 PM, Anamaria Stoica wrote:
Sergiu, could I also get some feedback on my code which does the update of the content, it's located in the JSX objected attached to the dashboard macro page (http://incubator.myxwiki.org/xwiki/bin/view/Macros/Dashboard).
Did a quick cleanup. -- Sergiu Dumitriu http://purl.org/net/sergiu/
participants (4)
-
Anamaria Stoica -
Jerome Velociter -
Sergiu Dumitriu -
Vincent Massol