文档常用模块通用格式

  • 文档创建者:Leo.Tsai
  • 编辑次数:5次
  • 最近更新:Leo.Tsai 于 2019-11-24
  • 1. 描述

    创建文档时,一些特定的文档模块需要使用通用的格式。下面将用图示的形式介绍通用格式的用法,附文字内容方便番薯们创建文档时可以直接拷贝过去使用。

    2. 格式

    1)插件安装

    每篇插件文档都需要说明插件安装的方法,插件下载的链接为帆软市场该插件的地址,通用格式如下图所示:

    Snag_7866c1.png

    附文字:

    点击下载插件:图片灯箱

    设计器插件安装方法参照 设计器插件管理

    服务器安装插件方法参照 服务器插件管理

    2)模板下载

    文档中有报表附件,需要提供报表下载和预览路径,通用格式如下图所示:

    Snag_823ee5.png

    附文字:

    已完成模板可参见:%FR_HOME%\webapps\webroot\WEB-INF\reportlets\

    点击下载模板:

    3)组件安装

    涉及到组件的文档,需要提供组件的安装方法,通用格式如下图所示:

    Snag_89641e.png

    附文字:

    点击下载深色系日历组件:深色系日历组件

    组件安装方法请参考:决策报表组件共享复用

    4)版本信息

    插件文档中需要在一开始就给出版本信息,插件的版本信息可从帆软市场该插件的介绍页面获得,通用格式如下图所示:

    Snag_938b0e.png

    附文字:

    报表服务器版本JAR 包版本 插件版本 
    10.02019-05-09V1.3.7
    9.02017-09-01V1.2.3
    8.02017-09-01V1.2.3

    3. 范例

    下面给出几篇标准文档的范例,希望番薯们在创建文档时可以按照这样的标准来写,只要满足了规范的基本要求就可以被评为优秀文档呦~

    1)插件文档:图片灯箱插件

    2)功能文档:日期控件

    3)JS 文档:大屏旋转星空背景

    附件列表


    主题: 下架文档
    • 有帮助
    • 没帮助
    • 只是浏览