[xwiki-devs] [Proposal] Group wiki macro & it's parameters into a single wiki page (one wiki page, one wiki macro)
Hi Devs, This is because of several reasons, 1. Having one wiki macro per wiki page makes it clean to group a single WikiMacroClass object and several WikiMacroParameterClass objects together and we do not need to keep a reference from WikiMacroParameterClass objects as to which macro in belongs to. 2. It makes the wiki macro registration / updating easy. I mean we only need to track document save / update events involving WikiMacroClass objects. On the other hand if we allow WikiMacros to have their parameters defined in some other documents, things get a little complex. 3. This will make wiki macro presentation easy. We can define a sheet that will present a single wiki macro (inside a single wiki page) in a unque manner to the user. This sheet will not have to bother about other wiki macros in the same document or worry about wiki macro parameters located elsewhere. WDYT? Thanks. - Asiri
Yes, +1, they _should_ be in the same page :) Jerome. Asiri Rathnayake wrote:
Hi Devs,
This is because of several reasons,
1. Having one wiki macro per wiki page makes it clean to group a single WikiMacroClass object and several WikiMacroParameterClass objects together and we do not need to keep a reference from WikiMacroParameterClass objects as to which macro in belongs to.
2. It makes the wiki macro registration / updating easy. I mean we only need to track document save / update events involving WikiMacroClass objects. On the other hand if we allow WikiMacros to have their parameters defined in some other documents, things get a little complex.
3. This will make wiki macro presentation easy. We can define a sheet that will present a single wiki macro (inside a single wiki page) in a unque manner to the user. This sheet will not have to bother about other wiki macros in the same document or worry about wiki macro parameters located elsewhere.
WDYT?
Thanks.
- Asiri _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
+1 I don't see any use case where having only one macro by wiki page is a real issue. On Fri, Jul 10, 2009 at 11:20, Asiri Rathnayake<[email protected]> wrote:
Hi Devs,
This is because of several reasons,
1. Having one wiki macro per wiki page makes it clean to group a single WikiMacroClass object and several WikiMacroParameterClass objects together and we do not need to keep a reference from WikiMacroParameterClass objects as to which macro in belongs to.
2. It makes the wiki macro registration / updating easy. I mean we only need to track document save / update events involving WikiMacroClass objects. On the other hand if we allow WikiMacros to have their parameters defined in some other documents, things get a little complex.
3. This will make wiki macro presentation easy. We can define a sheet that will present a single wiki macro (inside a single wiki page) in a unque manner to the user. This sheet will not have to bother about other wiki macros in the same document or worry about wiki macro parameters located elsewhere.
WDYT?
Thanks.
- Asiri _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
+1 Sounds natural to have the macro and its parameters on the same page. Thanks, Marius Asiri Rathnayake wrote:
Hi Devs,
This is because of several reasons,
1. Having one wiki macro per wiki page makes it clean to group a single WikiMacroClass object and several WikiMacroParameterClass objects together and we do not need to keep a reference from WikiMacroParameterClass objects as to which macro in belongs to.
2. It makes the wiki macro registration / updating easy. I mean we only need to track document save / update events involving WikiMacroClass objects. On the other hand if we allow WikiMacros to have their parameters defined in some other documents, things get a little complex.
3. This will make wiki macro presentation easy. We can define a sheet that will present a single wiki macro (inside a single wiki page) in a unque manner to the user. This sheet will not have to bother about other wiki macros in the same document or worry about wiki macro parameters located elsewhere.
WDYT?
Thanks.
- Asiri _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Asiri Rathnayake wrote:
Hi Devs,
This is because of several reasons,
1. Having one wiki macro per wiki page makes it clean to group a single WikiMacroClass object and several WikiMacroParameterClass objects together and we do not need to keep a reference from WikiMacroParameterClass objects as to which macro in belongs to.
2. It makes the wiki macro registration / updating easy. I mean we only need to track document save / update events involving WikiMacroClass objects. On the other hand if we allow WikiMacros to have their parameters defined in some other documents, things get a little complex.
3. This will make wiki macro presentation easy. We can define a sheet that will present a single wiki macro (inside a single wiki page) in a unque manner to the user. This sheet will not have to bother about other wiki macros in the same document or worry about wiki macro parameters located elsewhere.
WDYT?
+1, when was it decided to be otherwise? This is the only natural approach. -- Sergiu Dumitriu http://purl.org/net/sergiu/
participants (5)
-
Asiri Rathnayake -
Jerome Velociter -
Marius Dumitru Florea -
Sergiu Dumitriu -
Thomas Mortagne