wiki插件开发说明-TechExcelCommunity.docVIP

Wiki插件开发说明 序言 在wiki框架中，除了核心组件外（见核心组件说明），还允许使用自定义的插件来满足不同的功能需求。本文档描述：如何自定义一个插件，一个插件有哪些模块组成，并且使用实例RKWS详细说明了每一个模块中参数的意义用法以及如何定义。 摘要 HYPERLINK \l _国际化支持（i18N） 自定义插件的国际化。 HYPERLINK \l _自定义插件的数据配置转换器（Convertor） 自定义插件的数据配置转换器(Convertor)。 HYPERLINK \l _自定义插件的数据模型（Model） 自定义插件的数据模型（Model）。 HYPERLINK \l _生成核心组件（component） 自定义插件的控件化（Component）。 通过实例讲解，组合上述的几个模块，使其成为一个可以演示的完整功能。 代码组织结构 Wiki文件夹，主要放置wiki的核心代码（见wiki开发说明）。 Wiki.ext文件夹，wiki的扩展组件包，包括两部分component、operation（见operation开发说明）。 Commponent文件夹，主要放置wiki的自定义插件（rkws----wiki的一个自定义插件样例），是本文档描述的重点。 Images文件夹，主要放置wiki自定义插件所需要的图片。 Lang文件夹，主要放置wiki自定义插件所支持的多国语言。 rkws文件夹，主要放置样例插件RKWS所需要的js文件。 default.css文件，为wiki自定义插件所需要的css。 国际化支持（i18N） 功能 Wiki提供了加载多国语言支持的简单有效的途径： 文件准备：提供多国语言支持文件并置于相关目录下。脚本样例参考Wiki/lang目录下的文件内容和组织方式。请注意，自定义控件的单句条目应当被置于名字空间：Wiki.I18N[语言代码].Ext[插件名称]，以避免出现命名空间重叠。 加载：在wiki.initialized的时候使用配置项“externalLangFiles”或者“externalJSFiles”指定需要加载多国语言支持脚本。脚本样例参考Wiki/lang目录下的文件内容和组织方式。为防止某种语言违背支持而出现的异常情况，应当同时加载标准语言脚本en.js和本地化语言脚本。 使用：在使用时可以使用Wiki提供的单句条目提取函数Wiki.i18n()。该函数接收多个参数，第一个参数为单据条目索引：例如：对Wiki.I18N.en.Ext.Rkws.model.title的条目提取方法为：Wiki.i18n(“Ext.Rkws.model.title”)。 具体使用情况可以参考实例说明。 自定义插件的数据配置转换器（Convertor） 功能 把一个通用的标准JSON对象（见 HYPERLINK \l _标准json样例 标准json样例），转换成一个wiki插件易于识别的JSON对象（见 HYPERLINK \l _自定义json样例（通过自定义转换器，转化后的json对象） 自定义json样例）。注意：具体的JSON结构可以自定义，并没有强制的规定，程序员可以根据代码习惯，和业务逻辑需要自行定义，甚至不进行转换直接使用。只需要在HYPERLINK \l _生成数据模型（model）自定义插件的数据模型（Model）中，使用正确的格式解析JSON即可。 样例 满足SDEP-XML的RKWS数据样例 rkws tag value=hello lkw id=14 type=4![CDATA[How to say hello ]]/lkw lkw id=15 type=2![CDATA[Not to say hello ]]/lkw lkw id=38 type=1![CDATA[Never to say hello ]]/lkw /tag tag value=how to do /tag /rkws 标准JSON样例 rkws rkws : [{ tag : [{ _attrs : { value : hello }, lkw : [{ _attrs : { id : 14, type : 4 }, _cdata : How to say hello },{ _attrs : { id : 15, type : 2 }, _cdata : Not to say hello },{ _attrs : { id : 38, type : 1 },