[xwiki-devs] [proposal] Dashboard macro implementation - xwiki-devs@xwiki.org

Marius Dumitru Florea

25 Aug 25 Aug

11 a.m.

On 08/12/2010 06:43 PM, Anca Luca wrote:

Hi devs, knowing that gadgets will be xwiki macros instances (in any of the approaches) we need a way to add all these in a dashboard. Proposed options are at http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HDashboardMacr… . Currently implemented solution is 1/ which has a few drawbacks: it defines a meta syntax for its content and this syntax doesn't allow more complex layouts than a number of columns. The new proposal is 4) http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HOption429Colu… , which basically proposes to use nested column macros ( http://svn.xwiki.org/svnroot/xwiki/contrib/projects/xwiki-macro-column/ ) to do layouting and extend the section macro with a dashboard macro which would be used on the first level to mark that the columned content is a dashboard and not just regular wiki content. For more details about the approach see the description in the design page, as well as for the advantages of this proposal. my +1, I like this approach, I will try to prove the concept in the next days. WDYT?

+1 for solution 4 (extending column macro). Thanks, Marius

...

Thanks, Anca _______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs

Reply

Vincent Massol

15 Sep 15 Sep

5:02 p.m.

New subject: [xwiki-devs] [discussion] Dashboard macro implementation (edit mode)

Sounds ok but to be discussed with Thomas Mortagne... :) Thanks -Vincent On Sep 3, 2010, at 6:34 PM, Anca Luca wrote:

...

Hi devs, A I started to try to implement this idea, and I found 2 options for the editing the dashboard in "html mode" (not as wiki syntax but as the rendered html with nice UI). Editing will be based on the annotated html rendering of the dashboard, to be able to identify where one gadget macro starts and where it ends. There are 2 options: Short story: 1/ make a special parser to parse the wiki syntax content of the dashboard, column and nested section macros back from the edited xhtml. 2/ use operations to transmit the alterations to the server (move, delete, add, etc) and servers applies these operations on the XDOM built for the content of these macros. Long story: see http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HImplementation , especially the "edit mode" paragraph. B Also, there is a question about allowing and rendering any content in view mode in the dashboard macro (since normally a section/column macro allows any kind of content and for a dashboard we could limit it only to macro calls which are in the gadgets category). See http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HImplementation the "view mode" paragraph. I will start implementing A 1/ to see how it goes and allow anything for B. WDYT? Thanks, Anca On 08/12/2010 06:43 PM, Anca Luca wrote:

Hi devs, knowing that gadgets will be xwiki macros instances (in any of the approaches) we need a way to add all these in a dashboard. Proposed options are at http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HDashboardMacr… . Currently implemented solution is 1/ which has a few drawbacks: it defines a meta syntax for its content and this syntax doesn't allow more complex layouts than a number of columns. The new proposal is 4) http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HOption429Colu… , which basically proposes to use nested column macros ( http://svn.xwiki.org/svnroot/xwiki/contrib/projects/xwiki-macro-column/ ) to do layouting and extend the section macro with a dashboard macro which would be used on the first level to mark that the columned content is a dashboard and not just regular wiki content. For more details about the approach see the description in the design page, as well as for the advantages of this proposal. my +1, I like this approach, I will try to prove the concept in the next days. WDYT? Thanks, Anca _______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs

_______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs

Reply

Anca Luca

17 Sep 17 Sep

4:22 p.m.

New subject: [xwiki-devs] [discussion] Dashboard macro implementation (edit mode)

On 09/03/2010 06:34 PM, Anca Luca wrote:

...

Hi devs, A I started to try to implement this idea, and I found 2 options for the editing the dashboard in "html mode" (not as wiki syntax but as the rendered html with nice UI). Editing will be based on the annotated html rendering of the dashboard, to be able to identify where one gadget macro starts and where it ends. There are 2 options: Short story: 1/ make a special parser to parse the wiki syntax content of the dashboard, column and nested section macros back from the edited xhtml.

However, I just realized, it would be very hard (if not impossible in the current architecture) for a special parser to work fine with a dashboard macro generated by velocity script, for example: {{velocity}} {{dashboard}} {{column}} #if($someCondition) {{gadget1 /}} #end {{/column}} {{/dashboard}} {{/velocity}} Namely, the problem would be that a parser wouldn't be able to reconstruct the velocity syntax around the generation of the dashboard macro. My idea for this is to **not allow dashboard macros nested in other macros** (are there other macros than scripting macros?) to be edited, since it doesn't make that much sense anyway (for example assume $someCondition is true for user X and not true for user Y. When user Y edits the dashboard, what would user X see?). Since the editing is supposed to be wysiwyg, generated dashboards cannot be edited correctly in all situations. WDYT? Thanks, Anca

...

2/ use operations to transmit the alterations to the server (move, delete, add, etc) and servers applies these operations on the XDOM built for the content of these macros. Long story: see http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HImplementation , especially the "edit mode" paragraph. B Also, there is a question about allowing and rendering any content in view mode in the dashboard macro (since normally a section/column macro allows any kind of content and for a dashboard we could limit it only to macro calls which are in the gadgets category). See http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HImplementation the "view mode" paragraph. I will start implementing A 1/ to see how it goes and allow anything for B. WDYT? Thanks, Anca On 08/12/2010 06:43 PM, Anca Luca wrote:

Hi devs, knowing that gadgets will be xwiki macros instances (in any of the approaches) we need a way to add all these in a dashboard. Proposed options are at http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HDashboardMacr… . Currently implemented solution is 1/ which has a few drawbacks: it defines a meta syntax for its content and this syntax doesn't allow more complex layouts than a number of columns. The new proposal is 4) http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HOption429Colu… , which basically proposes to use nested column macros ( http://svn.xwiki.org/svnroot/xwiki/contrib/projects/xwiki-macro-column/ ) to do layouting and extend the section macro with a dashboard macro which would be used on the first level to mark that the columned content is a dashboard and not just regular wiki content. For more details about the approach see the description in the design page, as well as for the advantages of this proposal. my +1, I like this approach, I will try to prove the concept in the next days. WDYT? Thanks, Anca _______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs

_______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs

Reply

Vincent Massol

15 Sep 15 Sep

5:01 p.m.

Sounds ok to me. Thanks -Vincent On Aug 12, 2010, at 5:43 PM, Anca Luca wrote:

...

Hi devs, knowing that gadgets will be xwiki macros instances (in any of the approaches) we need a way to add all these in a dashboard. Proposed options are at http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HDashboardMacr… . Currently implemented solution is 1/ which has a few drawbacks: it defines a meta syntax for its content and this syntax doesn't allow more complex layouts than a number of columns. The new proposal is 4) http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HOption429Colu… , which basically proposes to use nested column macros ( http://svn.xwiki.org/svnroot/xwiki/contrib/projects/xwiki-macro-column/ ) to do layouting and extend the section macro with a dashboard macro which would be used on the first level to mark that the columned content is a dashboard and not just regular wiki content. For more details about the approach see the description in the design page, as well as for the advantages of this proposal. my +1, I like this approach, I will try to prove the concept in the next days. WDYT? Thanks, Anca

Reply

Thomas Mortagne

6:10 p.m.

+1 for 4 On Thu, Aug 12, 2010 at 17:43, Anca Luca <lucaa(a)xwiki.com> wrote:

...

Hi devs, knowing that gadgets will be xwiki macros instances (in any of the approaches) we need a way to add all these in a dashboard. Proposed options are at http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HDashboardMacr… . Currently implemented solution is 1/ which has a few drawbacks: it defines a meta syntax for its content and this syntax doesn't allow more complex layouts than a number of columns. The new proposal is 4) http://dev.xwiki.org/xwiki/bin/view/Design/GadgetIntegration#HOption429Colu… , which basically proposes to use nested column macros ( http://svn.xwiki.org/svnroot/xwiki/contrib/projects/xwiki-macro-column/ ) to do layouting and extend the section macro with a dashboard macro which would be used on the first level to mark that the columned content is a dashboard and not just regular wiki content. For more details about the approach see the description in the design page, as well as for the advantages of this proposal. my +1, I like this approach, I will try to prove the concept in the next days. WDYT? Thanks, Anca _______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs

-- Thomas Mortagne

Reply