xwiki源码介绍

绝地灬酷狼 2022-05-24 02:05 247阅读 0赞

所有XWiki源码都托管在 [GitHub][]。XWiki 是 [OW2 项目][OW2]，但我们使用的GitHub来存储我们的源码。

你可以在GitHub浏览代码库以及下载/克隆源码

你也可以用以下工具浏览/搜索我们的源码，但他们已被转移到Git，所以你只能找到老数据：

*  [SVN Search][]

# 顶级项目 #

XWiki不是一个单一的产品，而是多个项目组成的生态系统。

这些是由xwiki开发团队(又名XWiki Committers)维护，你可以通过[https://github.com/xwiki][GitHub] 浏览。

<table> 
 <tbody> 
  <tr> 
   <th style="vertical-align:top;">Git仓库名称</th> 
   <th style="vertical-align:top;">描述</th> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-commons&nbsp;</td> 
   <td style="vertical-align:top;">为其他顶级项目提供常用技术库。可以用于XWiki生态系统以外的项目，与wiki方面无关的项目</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-rendering</td> 
   <td style="vertical-align:top;">渲染库，将一些输入语法转化为另一个输出语法。可以用于XWiki生态系统以外的项目。依赖xwiki-commons</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-platform</td> 
   <td style="vertical-align:top;">其他顶级项目使用的可重用的组件/组件部分。依赖&nbsp;xwiki-commons，xwiki-rendering</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise</td> 
   <td style="vertical-align:top;">一个具有企业功能的专业的wiki。依赖&nbsp;xwiki-commons，xwiki-rendering，xwiki-platform</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-dev-tools</td> 
   <td style="vertical-align:top;">各种有助于开发的内部子项目(发布脚本, 实现轻松的在eclipse里debug等)</td> 
  </tr> 
 </tbody> 
</table>

为了更好地理解平台(Platform)和其他项目之间的关系，请查看[XWiki架构][XWiki]。

# 贡献项目 #

除了上面提到的顶级项目（只有xwiki开发团队有权提交代码），我们还在github上创建一个[xwiki Contrib][]组织来方便每个人为xwiki相关的项目做贡献

注意，github为每个注册用户的开源项目提供免费托管，所以如果你只是想托管你自己的代码没必要申请xwiki-contrib库。我们很乐意你把你的项目放在xwiki-contrib，因为它很容易让用户/开发者找到XWiki相关的项目（等于说也为你的项目做了广告）

# 项目结构 #

## XWiki Commons 结构 ##

<table> 
 <tbody> 
  <tr> 
   <th style="vertical-align:top;">目录名</th> 
   <th style="vertical-align:top;">描述</th> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-commons/xwiki-commons-pom</td> 
   <td style="vertical-align:top;">顶层Maven构建描述符（又名POM）。所有其他构建模块引用它</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-commons/xwiki-commons-core</td> 
   <td style="vertical-align:top;">通用库(JARs)</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-commons/xwiki-commons-tools</td> 
   <td style="vertical-align:top;">编译用的工具，用于编译其他模块</td> 
  </tr> 
 </tbody> 
</table>

## XWiki Platform 结构 ##

<table> 
 <tbody> 
  <tr> 
   <th style="vertical-align:top;">目录名</th> 
   <th style="vertical-align:top;">描述</th> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-platform/xwiki-platform-core</td> 
   <td style="vertical-align:top;">所有的核心模块(JARs, skins, extensions, Web等等)</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-platform/xwiki-platform-tools</td> 
   <td style="vertical-align:top;">编译工具和其他杂七杂八工具</td> 
  </tr> 
 </tbody> 
</table>

## XWiki Enterprise 结构 ##

<table> 
 <tbody> 
  <tr> 
   <th style="vertical-align:top;">目录名</th> 
   <th style="vertical-align:top;">描述</th> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise/xwiki-enterprise-ui</td> 
   <td style="vertical-align:top;">生成XWiki Enterprise默认需要的XAR</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise/xwiki-enterprise-data</td> 
   <td style="vertical-align:top;">加载XWiki Enterprise的XAR到目标数据库</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise/xwiki-enterprise-distribution</td> 
   <td style="vertical-align:top;">生成zip包含特定的Servlet容器、数据库</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise/xwiki-enterprise-test</td> 
   <td style="vertical-align:top;">功能测试</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise/xwiki-enterprise-installers</td> 
   <td style="vertical-align:top;">生成通用和Windows安装程序</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;">xwiki-enterprise/xwiki-enterprise-web</td> 
   <td style="vertical-align:top;">生成xwiki企业war包</td> 
  </tr> 
 </tbody> 
</table>

# 获得源码 #

访问[GitHub][], 利用github命令获取你想要的库

另外, 可以从我们的[Maven Repository][]找到你想要的xwiki artifact（项目产生物）以及下载相关的sources.jar等。例如，想获得"XWiki Commons Component API" 模块的相关jar和源码，请访问[这里][Link 1]

# 分支和标签 #

查看[Versioning and Release practices][]。

[GitHub]: https://github.com/xwiki
[OW2]: http://forge.ow2.org/projects/xwiki/
[SVN Search]: http://svnsearch.org/svnsearch/repos/XWIKI/search
[XWiki]: https://blog.csdn.net/qq_33873431/article/details/80361157
[xwiki Contrib]: https://github.com/xwiki-contrib
[Maven Repository]: http://maven.xwiki.org/
[Link 1]: http://maven.xwiki.org/releases/org/xwiki/commons/xwiki-commons-component-api/4.5.2/
[Versioning and Release practices]: http://dev.xwiki.org/xwiki/bin/view/Community/VersioningAndReleasePractices