XWiki Development Zone » Source Repositories

Source Repositories

Last modified by Vincent Massol on 2013/04/21 17:38

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.

You can also browse/search our sources using the following tools but they're currently plugged to our old Subversion repository while our sources have been moved to Git so you'll only find oldish data in there:

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 at https://github.com/xwiki :

Git Repository nameDescription
xwiki-commonsTechnical 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-eclipseDesktop application targeted to developers for productivity/offline editing of XWiki pages.
xwiki-enterpriseA professional wiki with enterprise features.
xwiki-managerManages farms of XWiki Enterprise instances.
xwiki-officeAn add-in to edit XWiki pages from MS Word.
xwiki-platformReusable components/parts used by other top level projects, making up a wiki runtime. Uses xwiki-commons and xwiki-rendering.
xwiki-renderingRendering library to convert some input syntax into another output syntax. Can be used by projects outside of the XWiki ecosystem. Uses xwiki-commons.
In order to better understand the relationships between the Platform and other top level projects, check how XWiki is Architected.

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).

Note that GitHub offers free hosting for open source projects for every registered user, so you don't have to ask for access to the xwiki-contrib repositories if you just want to host your own code. That said we would love for you to put your project on xwiki-contrib since it makes it easy for users/developers to find xwiki-related projects under a single location (it also makes better advertising for your own project). By using xwiki-contrib you also gain a wiki and a JIRA project if you want to.

Project Structure

XWiki Commons Structure

Directory nameDescription
xwiki-commons/xwiki-commons-pomThe top level Maven build descriptor (a.k.a POM). It's referenced by all other build modules.
xwiki-commons/xwiki-commons-coreCommons libraries (JARs)
xwiki-commons/xwiki-commons-toolsBuild tools used to build other commons modules.

XWiki Rendering Structure

See the Rendering Project.

XWiki Platform Structure

Directory nameDescription
xwiki-platform/xwiki-platform-coreAll core modules (JARs, skins, extensions, Web, etc)
xwiki-platform/xwiki-platform-toolsBuild tools and various other misc. tools.

XWiki Enterprise Structure

Directory nameDescription
xwiki-enterprise/xwiki-enterprise-wikiDefault XWiki Enterprise XAR.
xwiki-enterprise/xwiki-enterprise-databaseLoads the XWiki Enterprise XAR into target databases.
xwiki-enterprise/xwiki-enterprise-distributionGenerates distributions for given Servlet container and given Databases.
xwiki-enterprise/xwiki-enterprise-testFunctional tests.
xwiki-enterprise/xwiki-enterprise-installersGenerates generic and Windows installers based on generated distributions.
xwiki-enterprise/xwiki-enterprise-webGenerates 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.

Alternatively, locate the XWiki artifact for which you wish to get the sources of in our Maven Repository and download the associated source JAR. For example to get the sources for the "XWiki Commons Component API" module, get the JAR file ending with -sources here.

Branches and Tags

Check our Versioning and Release practices.

Tags:
Created by vmassol on 2006/12/11 17:49

Get Connected