Wiki source code of XWiki Enterprise Archetype
Last modified by Thomas Mortagne on 2017/03/02 18:34
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{warning}} | ||
| 2 | The archetype moved to https://github.com/xwiki-contrib/xwiki-enterprise-archetype after 9.1 and is not sync with XE versions anymore. | ||
| 3 | {{/warning}} | ||
| 4 | |||
| 5 | A new archetype is now available to easily create your own product based on XWiki Enterprise. To use: | ||
| 6 | |||
| 7 | {{code language="none"}} | ||
| 8 | mvn archetype:generate \ | ||
| 9 | -DarchetypeArtifactId=xwiki-enterprise-archetype \ | ||
| 10 | -DarchetypeGroupId=org.xwiki.enterprise \ | ||
| 11 | -DarchetypeVersion=5.3-milestone-1 | ||
| 12 | {{/code}} | ||
| 13 | |||
| 14 | You'll get asked several questions. For example: | ||
| 15 | |||
| 16 | {{code language="none"}} | ||
| 17 | ... | ||
| 18 | Define value for property 'groupId': : com.acme | ||
| 19 | Define value for property 'artifactId': : myproject | ||
| 20 | Define value for property 'version': 1.0-SNAPSHOT: : | ||
| 21 | Define value for property 'package': com.acme: : | ||
| 22 | Define value for property 'projectName': : My Extra Project | ||
| 23 | Define value for property 'xwikiVersion': : 5.2 | ||
| 24 | ... | ||
| 25 | {{/code}} | ||
| 26 | |||
| 27 | Note that the ##xwikiVersion## is the version of XE you wish to depend on. | ||
| 28 | |||
| 29 | This generates a project with the following structure: | ||
| 30 | |||
| 31 | {{code language="none"}} | ||
| 32 | |-myproject | ||
| 33 | |---myproject-data | ||
| 34 | |-----myproject-data-hsqldb | ||
| 35 | |-------src | ||
| 36 | |---------assemble | ||
| 37 | |---myproject-distribution | ||
| 38 | |-----myproject-jetty | ||
| 39 | |-------myproject-jetty-hsqldb | ||
| 40 | |---------src | ||
| 41 | |-----------assemble | ||
| 42 | |---myproject-ui | ||
| 43 | |-----myproject-ui-common | ||
| 44 | |-----myproject-ui-mainwiki | ||
| 45 | |-----myproject-ui-wiki | ||
| 46 | |---myproject-web | ||
| 47 | {{/code}} | ||
| 48 | |||
| 49 | {{todo}} | ||
| 50 | Modify the archetype to also generate a ##myproject-ui-wiki-all## module that will have the following in its ##pom.xml##: | ||
| 51 | |||
| 52 | {{code language="xml"}} | ||
| 53 | <xwiki.extension.features> | ||
| 54 | ${xe.ui.wiki.all.features}, | ||
| 55 | com.acme:myproject-ui-wiki, | ||
| 56 | com.acme:myproject-ui-common | ||
| 57 | </xwiki.extension.features> | ||
| 58 | {{/code}} | ||
| 59 | {{/todo}} |
