Source Repositories
All XWiki sources are stored in Git repositories on GitHub. XWiki is an OW2 project, but we're using GitHub to store our sources.
You can browse the source repositories and download/clone the sources by using GitHub.
Top Level Projects
XWiki is not a single product, but an ecosystem of top-level projects.
Here's the list of repositories (one repository per top level project) you should see if you browse the Git repositories on https://github.com/xwiki :
| Git Repository name | Description |
|---|---|
| xwiki-commons | Technical libraries common to several other top level projects. Can be used by projects outside of the XWiki ecosystem; not related to the wiki domain. |
| xwiki-eclipse | Desktop application targeted to developers for productivity/offline editing of XWiki pages. |
| xwiki-enterprise | A professional wiki with enterprise features. |
| xwiki-manager | Manages farms of XWiki Enterprise instances. |
| xwiki-office | An add-in to edit XWiki pages from MS Word. |
| xwiki-platform | Reusable components/parts used by other top level projects, making up a wiki runtime. Uses xwiki-commons and xwiki-rendering. |
| xwiki-rendering | Rendering library to convert some input syntax into another output syntax. Can be used by projects outside of the XWiki ecosystem. Uses xwiki-commons. |
| xwiki-watch | Collaborative RSS Feed Reader. |
Contrib Projects
In addition to the Top Level Projects mentioned above (and for which only XWiki committers have the rights to commit to), we've also created an XWiki Contrib organization on GitHub where everyone could contribute easily to XWiki-related projects (If you're interested see the documentation for Contrib projects).
Project Structure
XWiki Commons Structure
| Directory name | Description |
|---|---|
| xwiki-commons/xwiki-commons-pom | The top level Maven build descriptor (a.k.a POM). It's referenced by all other build modules. |
| xwiki-commons/xwiki-commons-core | Commons libraries (JARs) |
| xwiki-commons/xwiki-commons-tools | Build tools used to build other commons modules. |
XWiki Rendering Structure
See the Rendering Project.
XWiki Platform Structure
| Directory name | Description |
|---|---|
| xwiki-platform/xwiki-platform-core | All core modules (JARs, skins, extensions, Web, etc) |
| xwiki-platform/xwiki-platform-tools | Build tools and various other misc. tools. |
XWiki Enterprise Structure
| Directory name | Description |
|---|---|
| xwiki-enterprise/xwiki-enterprise-wiki | Default XWiki Enterprise XAR. |
| xwiki-enterprise/xwiki-enterprise-database | Loads the XWiki Enterprise XAR into target databases. |
| xwiki-enterprise/xwiki-enterprise-distribution | Generates distributions for given Servlet container and given Databases. |
| xwiki-enterprise/xwiki-enterprise-test | Functional tests. |
| xwiki-enterprise/xwiki-enterprise-installers | Generates generic and Windows installers based on generated distributions. |
| xwiki-enterprise/xwiki-enterprise-web | Generates the XWiki Enterprise WAR. |
Getting Sources
Go to GitHub, select the repository you wish to get and follow the GitHub instructions.
Then build the sources.
