Wiki source code of Source Repositories

Version 25.4 by Sergiu Dumitriu on 2011/08/09 04:22

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 All XWiki sources are stored in [[Git>>http://git-scm.com/]] repositories on [[GitHub>>https://github.com/xwiki]]. XWiki is an [[OW2 project>>http://forge.objectweb.org/projects/xwiki/]], but we're using GitHub to store our sources.
6
7 You can browse the source repositories and download/clone the sources by using [[GitHub>>https://github.com/xwiki]].
8
9 = Top Level Projects =
10
11 XWiki is not a single product, but an ecosystem of [[top-level projects>>https://github.com/xwiki]].
12
13 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 :
14
15 |=Git Repository name|=Description
16 |[[xwiki-commons>>commons:Main.WebHome]]|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.
17 |[[xwiki-eclipse>>xeclipse:Main.WebHome]]|Desktop application targeted to developers for productivity/offline editing of XWiki pages.
18 |[[xwiki-enterprise>>enterprise:Main.WebHome]]|A professional wiki with enterprise features.
19 |[[xwiki-manager>>manager:Main.WebHome]]|Manages farms of XWiki Enterprise instances.
20 |[[xwiki-office>>xoffice:Main.WebHome]]|An add-in to edit XWiki pages from MS Word.
21 |[[xwiki-platform>>platform:Main.WebHome]]|Reusable components/parts used by other top level projects, making up a wiki runtime. Uses xwiki-commons and xwiki-rendering.
22 |[[xwiki-rendering>>rendering:Main.WebHome]]|Rendering library to convert some input syntax into another output syntax. Can be used by projects outside of the XWiki ecosystem. Uses xwiki-commons.
23 |[[xwiki-watch>>watch:Main.WebHome]]|Collaborative RSS Feed Reader.
24
25 {{info}}In order to better understand the relationships between the Platform and other top level projects, check how XWiki is [[Architected>>platform:DevGuide.Architecture]].{{/info}}
26
27 {{warning}}
28 We've migrated from Subversion to Git not too long ago and the following projects have not been migrated yet and are still available on our old subversion instance at http://svn.xwiki.org/svnroot/xwiki/ :
29
30 |=Directory name|=Description
31 |[[curriki>>curriki:Main.WebHome]]|A collaborative platform to help create and share educational resources.
32 {{/warning}}
33
34 = Contrib Projects =
35
36 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>>https://github.com/xwiki-contrib]] organization on GitHub where everyone could contribute easily to XWiki-related projects (If you're interested see the [[documentation for Contrib projects>>http://contrib.xwiki.org/]]).
37
38 = Project Structure =
39
40 == XWiki Commons Structure ==
41
42 |=Directory name|=Description
43 |xwiki-commons/xwiki-commons-pom|The top level Maven build descriptor (a.k.a POM). It's referenced by all other build modules.
44 |xwiki-commons/xwiki-commons-core|Commons libraries (JARs)
45 |xwiki-commons/xwiki-commons-tools|Build tools used to build other commons modules.
46
47 == XWiki Rendering Structure ==
48
49 See the [[Rendering Project>>rendering:Main.WebHome]].
50
51 == XWiki Platform Structure ==
52
53 |=Directory name|=Description
54 |xwiki-platform/xwiki-platform-core|All core modules (JARs, skins, extensions, Web, etc)
55 |xwiki-platform/xwiki-platform-tools|Build tools and various other misc. tools.
56
57 == XWiki Enterprise Structure ==
58
59 |=Directory name|=Description
60 |xwiki-enterprise/xwiki-enterprise-wiki|Default XWiki Enterprise XAR.
61 |xwiki-enterprise/xwiki-enterprise-database|Loads the XWiki Enterprise XAR into target databases.
62 |xwiki-enterprise/xwiki-enterprise-distribution|Generates distributions for given Servlet container and given Databases.
63 |xwiki-enterprise/xwiki-enterprise-test|Functional tests.
64 |xwiki-enterprise/xwiki-enterprise-installers|Generates generic and Windows installers based on generated distributions.
65 |xwiki-enterprise/xwiki-enterprise-web|Generates the XWiki Enterprise WAR.
66
67 = Getting Sources =
68
69 Go to [[GitHub>>https://github.com/xwiki/]], select the repository you wish to get and follow the GitHub instructions.
70
71 Then [[build>>Community.Building]] the sources.

Get Connected