[xwiki-devs] [Proposal] Naming scheme for e.x.o extensions
Hi, I'd like to propose to use the following naming conventions for the extensions from commons/rendering/platform that are exposed on e.x.o: - "API" suffix for api modules. e.g. "Text API" , "Velocity API" instead of currently "Text Module", "Velocity Module", etc - "Application" suffix for ui modules, e.g. "Wiki Manager Application", "Logging Application", "IRC Bot Application", etc - "Macro" suffix, e.g. "JIRA Macro", etc Technically this means using the following in pom.xml: <properties> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Wiki Component API</xwiki.extension.name> </properties> WDYT? Thanks -Vincent
On 02/12/2013 06:03 AM, Vincent Massol wrote:
Hi,
I'd like to propose to use the following naming conventions for the extensions from commons/rendering/platform that are exposed on e.x.o:
- "API" suffix for api modules. e.g. "Text API" , "Velocity API" instead of currently "Text Module", "Velocity Module", etc - "Application" suffix for ui modules, e.g. "Wiki Manager Application", "Logging Application", "IRC Bot Application", etc - "Macro" suffix, e.g. "JIRA Macro", etc
Technically this means using the following in pom.xml:
<properties> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Wiki Component API</xwiki.extension.name> </properties>
WDYT?
Thanks -Vincent
Sounds good. What about implementations, for example the portlet and servlet containers? -- Sergiu Dumitriu http://purl.org/net/sergiu
On Feb 12, 2013, at 2:24 PM, Sergiu Dumitriu <[email protected]> wrote:
On 02/12/2013 06:03 AM, Vincent Massol wrote:
Hi,
I'd like to propose to use the following naming conventions for the extensions from commons/rendering/platform that are exposed on e.x.o:
- "API" suffix for api modules. e.g. "Text API" , "Velocity API" instead of currently "Text Module", "Velocity Module", etc - "Application" suffix for ui modules, e.g. "Wiki Manager Application", "Logging Application", "IRC Bot Application", etc - "Macro" suffix, e.g. "JIRA Macro", etc
Technically this means using the following in pom.xml:
<properties> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Wiki Component API</xwiki.extension.name> </properties>
WDYT?
Thanks -Vincent
Sounds good. What about implementations, for example the portlet and servlet containers?
Good question. What I've done today for Extension submodule is: <artifactId>xwiki-commons-extension-repository-xwiki</artifactId> <name>XWiki Commons - Extension - Repository - XWiki</name> <packaging>jar</packaging> <description>Allows accessing extensions located in an XWiki instance</description> <properties> <xwiki.jacoco.instructionRatio>0</xwiki.jacoco.instructionRatio> <!-- Old names of this module used for retro compatibility when resolving dependencies of old extensions --> <xwiki.extension.features>org.xwiki.platform:xwiki-platform-extension-repository-xwiki-handler,org.xwiki.commons:xwiki-commons-extension-repository-xwiki-handler</xwiki.extension.features> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Repository Module - XWiki support</xwiki.extension.name> </properties> So we could do the same, use something like: "Container API - Servlet support" "Container API - Portlet support" or we can just keep using "Module" in places where it's not an API... Thanks -Vincent
On 02/12/2013 08:48 AM, Vincent Massol wrote:
On Feb 12, 2013, at 2:24 PM, Sergiu Dumitriu <[email protected]> wrote:
On 02/12/2013 06:03 AM, Vincent Massol wrote:
Hi,
I'd like to propose to use the following naming conventions for the extensions from commons/rendering/platform that are exposed on e.x.o:
- "API" suffix for api modules. e.g. "Text API" , "Velocity API" instead of currently "Text Module", "Velocity Module", etc - "Application" suffix for ui modules, e.g. "Wiki Manager Application", "Logging Application", "IRC Bot Application", etc - "Macro" suffix, e.g. "JIRA Macro", etc
Technically this means using the following in pom.xml:
<properties> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Wiki Component API</xwiki.extension.name> </properties>
WDYT?
Thanks -Vincent
Sounds good. What about implementations, for example the portlet and servlet containers?
Good question.
What I've done today for Extension submodule is:
<artifactId>xwiki-commons-extension-repository-xwiki</artifactId> <name>XWiki Commons - Extension - Repository - XWiki</name> <packaging>jar</packaging> <description>Allows accessing extensions located in an XWiki instance</description> <properties> <xwiki.jacoco.instructionRatio>0</xwiki.jacoco.instructionRatio> <!-- Old names of this module used for retro compatibility when resolving dependencies of old extensions --> <xwiki.extension.features>org.xwiki.platform:xwiki-platform-extension-repository-xwiki-handler,org.xwiki.commons:xwiki-commons-extension-repository-xwiki-handler</xwiki.extension.features> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Repository Module - XWiki support</xwiki.extension.name> </properties>
So we could do the same, use something like:
"Container API - Servlet support" "Container API - Portlet support"
OK, but maybe "support" should be replaced with something more appropriate for each type of implementation, like "backend", or "-based implementation".
or we can just keep using "Module" in places where it's not an API...
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu
On Tue, Feb 12, 2013 at 3:02 PM, Sergiu Dumitriu <[email protected]> wrote:
On 02/12/2013 08:48 AM, Vincent Massol wrote:
On Feb 12, 2013, at 2:24 PM, Sergiu Dumitriu <[email protected]> wrote:
On 02/12/2013 06:03 AM, Vincent Massol wrote:
Hi,
I'd like to propose to use the following naming conventions for the extensions from commons/rendering/platform that are exposed on e.x.o:
- "API" suffix for api modules. e.g. "Text API" , "Velocity API" instead of currently "Text Module", "Velocity Module", etc - "Application" suffix for ui modules, e.g. "Wiki Manager Application", "Logging Application", "IRC Bot Application", etc - "Macro" suffix, e.g. "JIRA Macro", etc
Technically this means using the following in pom.xml:
<properties> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Wiki Component API</xwiki.extension.name> </properties>
WDYT?
Thanks -Vincent
Sounds good. What about implementations, for example the portlet and servlet containers?
Good question.
What I've done today for Extension submodule is:
<artifactId>xwiki-commons-extension-repository-xwiki</artifactId> <name>XWiki Commons - Extension - Repository - XWiki</name> <packaging>jar</packaging> <description>Allows accessing extensions located in an XWiki instance</description> <properties> <xwiki.jacoco.instructionRatio>0</xwiki.jacoco.instructionRatio> <!-- Old names of this module used for retro compatibility when resolving dependencies of old extensions --> <xwiki.extension.features>org.xwiki.platform:xwiki-platform-extension-repository-xwiki-handler,org.xwiki.commons:xwiki-commons-extension-repository-xwiki-handler</xwiki.extension.features> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Repository Module - XWiki support</xwiki.extension.name> </properties>
So we could do the same, use something like:
"Container API - Servlet support" "Container API - Portlet support"
OK, but maybe "support" should be replaced with something more appropriate for each type of implementation, like "backend", or "-based implementation".
This module is a client module for "xwiki" type of repository, it's not something based on XWiki (it's actually very generic otherwise it would not be on xwiki-commons).
or we can just keep using "Module" in places where it's not an API...
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
On Feb 12, 2013, at 4:24 PM, Thomas Mortagne <[email protected]> wrote:
On Tue, Feb 12, 2013 at 3:02 PM, Sergiu Dumitriu <[email protected]> wrote:
On 02/12/2013 08:48 AM, Vincent Massol wrote:
On Feb 12, 2013, at 2:24 PM, Sergiu Dumitriu <[email protected]> wrote:
On 02/12/2013 06:03 AM, Vincent Massol wrote:
Hi,
I'd like to propose to use the following naming conventions for the extensions from commons/rendering/platform that are exposed on e.x.o:
- "API" suffix for api modules. e.g. "Text API" , "Velocity API" instead of currently "Text Module", "Velocity Module", etc - "Application" suffix for ui modules, e.g. "Wiki Manager Application", "Logging Application", "IRC Bot Application", etc - "Macro" suffix, e.g. "JIRA Macro", etc
Technically this means using the following in pom.xml:
<properties> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Wiki Component API</xwiki.extension.name> </properties>
WDYT?
Thanks -Vincent
Sounds good. What about implementations, for example the portlet and servlet containers?
Good question.
What I've done today for Extension submodule is:
<artifactId>xwiki-commons-extension-repository-xwiki</artifactId> <name>XWiki Commons - Extension - Repository - XWiki</name> <packaging>jar</packaging> <description>Allows accessing extensions located in an XWiki instance</description> <properties> <xwiki.jacoco.instructionRatio>0</xwiki.jacoco.instructionRatio> <!-- Old names of this module used for retro compatibility when resolving dependencies of old extensions --> <xwiki.extension.features>org.xwiki.platform:xwiki-platform-extension-repository-xwiki-handler,org.xwiki.commons:xwiki-commons-extension-repository-xwiki-handler</xwiki.extension.features> <!-- Name to display by the Extension Manager --> <xwiki.extension.name>Repository Module - XWiki support</xwiki.extension.name> </properties>
So we could do the same, use something like:
"Container API - Servlet support" "Container API - Portlet support"
OK, but maybe "support" should be replaced with something more appropriate for each type of implementation, like "backend", or "-based implementation".
This module is a client module for "xwiki" type of repository, it's not something based on XWiki (it's actually very generic otherwise it would not be on xwiki-commons).
my bad, fixed. Thanks -Vincent
or we can just keep using "Module" in places where it's not an API...
Thanks -Vincent
participants (3)
-
Sergiu Dumitriu -
Thomas Mortagne -
Vincent Massol