开发者指南

在2016/04/10 03:08上被superadmin修改

如果你有兴趣参与到XWiki项目开发或从源码构建它,你应该参阅开发社区
你还有问题吗?
订阅邮件列表!

XWiki是一个第二代wiki,提供了所有常见的基本内容管理和管理wiki功能以及更多。XWiki提供增强的特性和功能使wiki提高到全新的一个高度。使用XWiki,你可以建立简单的应用程序,通过自定义插件扩展平台,甚至建立复杂的Web应用程序。

快速开始

一分钟创建App
通过工具建立一个应用程序,甚至可以没有任何技术知识

参考文档

XWiki架构
了解XWiki架构以及如何扩展它。
XWiki数据模型
你应该了解XWiki数据模型:类,属性和对象。他们将需要在文档级别上构建应用程序。
XWiki脚本
一旦理解XWiki数据模型,你就可以直接在文档编辑里进行编程。XWiki集成Velocity和Groovy脚本。总之,类和脚本可以让你在XWiki文档的layer创建简单到复杂的Web应用程序,无需编译代码或部署软件组件。
XWiki API指南
主要对main XWiki API说明。快速访问XWiki API参考
扩展点列表
列出所有可用的扩展点。
前端资源
在XWiki使用的工具和框架的描述。你会找到关于如何使用外部的库,如YUI和SmartClient和xwiki内部库(用于开发application或者开发xwiki产品本身)。你还可以找到专门为XWiki项目创建的StyleSheet资源文档。
XWiki模块参考
XWiki各个模块的参考文档。
保存数据
在XWiki平台内保存数据
URL架构
说明XWiki url如何工作,标准URL Scheme格式和如何配置它们。

教程和指南

如何在XWiki页面使用Velocity
介绍如何在XWiki写应用程序(使用Velocity, XWiki Class system, API等)。
创建一个FAQ应用程序
介绍如何创建一个FAQ应用程序,或者使用Classes/Objects/Sheets/Templates和脚本或者使用一分钟创建App扩展程序来创建FAQ应用程序。任何人想要通过XWiki引擎在文档或者表现层创建自定义应用程序,建议先看此教程。
创建一个Groovy类
介绍如何把Groovy代码写一个页面中,然后在另一个页面使用。
编写一个事件监听器
介绍当在wiki发生一个事件如何编写事件监听器来执行某些操作。例如包括文档改变,对象修改,等等。
在XWiki创建一个TODO应用程序
另一个有用的教程是使用XWiki的类,velocity脚本,Hibernate查询创建一个dashboard。
展示XWiki强大之处。
创建一个带有校验和提示的表单
使用正则表达式和Groovy脚本来创建校验,以及提示
编写XWiki渲染宏
如何开发XWiki渲染宏(只适用XWiki语法2.0)
编写一个XWiki组件
使用新的XWiki组件架构:介绍这种新的设计,一步一步的指导来编写一个XWiki组件(这是创建XWiki插件推荐的方式)。
皮肤扩展
说明XWiki皮肤扩展机制,允许开发人员对所有的wiki页面pull额外的Javascript和stylesheet文件,而无需修改wiki模板和皮肤。
国际化应用程序
了解如何编写国际化应用程序。
创建新的XClass属性类型
如何使用新的自定义属性类型来简单扩展类编辑
自定义映射
当你需要让XWiki类映射到数据库表或者当需要对复杂的数据提供额外的性能时,如何使用自定义映射。
创建插件
在学习了如何在文档级别编写应用程序之后,你可能需要进一步用java编写插件来扩展XWiki视图引擎,以及添加钩子到核心引擎的不同部分。
在一分钟创建App应用程序里编写一个自定义SOLR搜索
教程展示如何在一分钟创建App里定制SOLR搜索。在这个例子中,我们使用了“Expense Report”应用程序。
集成JavaScript库
关于我们如何在XWiki使用WebJarsRequireJS整合JavaScript库的一个教程。此外,你会看到如何包装自己的JavaScript代码为WebJar,用于各种代码质量工具(静态代码分析jshint,集成测试Jasmine)。
执行异步任务
如何在XWiki使用作业模块来在后台线程执行长时间运行和费时的操作。
创建一个树视图
关于如何在XWiki创建任何结构的树视图的教程,使用Tree Macro
Master-Detail教程
如何实现主从视图(Master-Detail Views)
最佳实践
一套开发XWiki应用程序的最佳实践。

深入阅读

XWiki API参考
API作为JavaDoc。你可以使用脚本来访问对象和属性。
数据库Schema
对于喜欢什么都懂高级用户,可以查看关于XWiki数据库表的介绍。

起草文档

地址

标签: 教程
在2019/02/06 16:28上被superadmin创建
本网站中文版文档全部由XWiki中文网成员翻译整理,并全部遵循CC BY 2.0协议发布
闽ICP备15012477号
由 XWiki 7.1.4 构建