Re: [xwiki-devs] [Proposal] Wiki Macros vs Java Macros in the default XE distribution
On Jun 3, 2010, at 12:20 PM, Ludovic Dubost wrote:
Le 03/06/10 11:33, Vincent Massol a écrit :
On Jun 3, 2010, at 10:31 AM, Vincent Massol wrote:
Hi devs,
We have avoided this discussion but it's time to settle it. We need to decide if there are candidate macros that we should write as wiki macros in our default XE distribution. And if so what are the rule for deciding whether a macro should be written as a wiki macro or as a java macro.
Some ideas: - java macros are much easier to test - java macros are easier to develop since you have a full-fledged IDE (debugging, syntax coloring, code validation, etc) - java macros can obey styling rule, such as checkstyle passing - wiki macros can be removed so users can't be sure the wiki macro will always be there since it's only provided with the default XAR
Proposal =======
- If the macro is a generic macro then it should be written as a Java macro - If the macro is application-specific (for ex a macro specific to the Blog application) then it can be written as a Wiki macro
WDYT?
ok, I've been convinced that there's no simple solution and thus that we need to decide whether a macro should be implemented in java or as a wiki page on a case by case basis.
Thus I propose that when a macro is implemented as a wiki macro, we put in SVN in platform/applications as an application by itself (ie a XAR). In the same manner as java macros are a JAR by themselves.
We should avoid having one application per macro, otherwise it's going to be a mess.
In what sense? JIRA-wise? Release-wise?
I think we should categorize the wiki macros so that we have one application by big category.
Also we'll soon have the ability to download and install them from the internet, making it easy to install extensions. Providing superpackages is possible with the new extension manager, simply by having an extension that has dependencies on individual artifacts. But yes I agree we need to think about macro explosion and how we handle this, whether we want a single JIRA module for macros for exemple and release them all together. JIRA + release are the only issues I can think of since we're talking about macros bundled by default. Note: We also need to agree on a space where to put them. Thanks -Vincent
Le 03/06/10 12:48, Vincent Massol a écrit :
On Jun 3, 2010, at 12:20 PM, Ludovic Dubost wrote:
Le 03/06/10 11:33, Vincent Massol a écrit :
On Jun 3, 2010, at 10:31 AM, Vincent Massol wrote:
Hi devs,
We have avoided this discussion but it's time to settle it. We need to decide if there are candidate macros that we should write as wiki macros in our default XE distribution. And if so what are the rule for deciding whether a macro should be written as a wiki macro or as a java macro.
Some ideas: - java macros are much easier to test - java macros are easier to develop since you have a full-fledged IDE (debugging, syntax coloring, code validation, etc) - java macros can obey styling rule, such as checkstyle passing - wiki macros can be removed so users can't be sure the wiki macro will always be there since it's only provided with the default XAR
Proposal =======
- If the macro is a generic macro then it should be written as a Java macro - If the macro is application-specific (for ex a macro specific to the Blog application) then it can be written as a Wiki macro
WDYT?
ok, I've been convinced that there's no simple solution and thus that we need to decide whether a macro should be implemented in java or as a wiki page on a case by case basis.
Thus I propose that when a macro is implemented as a wiki macro, we put in SVN in platform/applications as an application by itself (ie a XAR). In the same manner as java macros are a JAR by themselves.
We should avoid having one application per macro, otherwise it's going to be a mess.
In what sense?
JIRA-wise? Release-wise?
It's going to be way to segmented in SVN, JIRA and in terms of multiple XARs I think we should see it as a package of Macros more than a package of each macro Ludovic
I think we should categorize the wiki macros so that we have one application by big category.
Also we'll soon have the ability to download and install them from the internet, making it easy to install extensions. Providing superpackages is possible with the new extension manager, simply by having an extension that has dependencies on individual artifacts.
But yes I agree we need to think about macro explosion and how we handle this, whether we want a single JIRA module for macros for exemple and release them all together. JIRA + release are the only issues I can think of since we're talking about macros bundled by default.
Note: We also need to agree on a space where to put them.
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Ludovic Dubost Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
participants (2)
-
Ludovic Dubost -
Vincent Massol