1 功能简介
【页面帮助文字】功能提示方式受制于篇幅(至多100个字符),只能够尽量简短地进行描述。作为在线帮助还远远不够,有时需要链接到更加详细的帮助页面进行说明,且最好链接的帮助页面可以由表单设计者在某个模板中集中维护。
故乐创者在页面帮助文字的基础上定义了帮助模版功能,帮助模板可以由应用设计者自行设计和维护,支持使用跨设备表单和报表模板。启用帮助模板后,在原有跨设备表单页面帮助文字点击“查看更多”,可按帮助模板中配置传参条件链接至帮助模板的指定页面。
2 配置说明
(1)创建帮助模板
要想使用此功能,前面提到需要设计者自行维护一个跨设备表单或报表的帮助模板。
打个比方,我们需要根据跨设备表单的不同页面来呈现不同的页面详细帮助,那在我们创建数据库表和元数据时就需要提前定义好几个必要的系统变量参数字段如 应用内部名称、模版文件内部名称、页面类型、文本内容等,其他模板就可以根据表单设计人员自行设计了。如下图所示,教程按最基础的要求设计了一个表结构。
在创建元数据时,将文本内容help字段定义成富文本控件,基本可以满足我们帮助文档内容编写的一般需求。
在元数据中将“应用内部名称”、“模版文件内部名称”、“页面类型”字段指定为查询参数,并创建表单模板,用于维护详细帮助信息。
如下图所示就是一个最基础的帮助模板维护业务表单。设计人员可以在该模板中对页面详细帮助信息进行维护和管理。
帮助模板系统变量字段值的维护,如下图所示。
- 应用内部名称:模版来源的应用在确定需要引用哪个模版后是可以确定的,可以通过系统管理员身份登录门户在应用管理中查看应用的应用内部名称。
- 模版文件内部名称:即需要显示帮助信息的模版内部名称,一般情况下是可以确定的,可以在维护时写死,具体可以前往设计器模板右键“属性-高级-内部名称”查看
- 页面类型:需要显示的模版页面,在维护帮助信息文本时也是可以确定的,跨设备表单页面类型各页面参数值分别是:列表页面“list”、新增页面“insert”、修改页面“update”、详情页面“detail”;报表页面类型为“view”。
(2)配置帮助模版
在设计器【应用-高级配置-帮助模版】中启用配置项【启用帮助模板】,如下图所示。
选择模板类型及文件。【模板类型】下拉列表支持选择:“跨设备表单”/“报表”,默认选中“跨设备表单”,切换模板类型会清空已选的表单文件和参数配置。
选择跨设备表单,选择页面类型,支持“智能识别/详情页面/列表页面”,默认选中“智能识别”。
智能模式规则说明:
①无记录时,跳转错误页面,错误提示默认值“暂无更多帮助信息”,支持自定义,支持表达式;
②一条记录时,默认跳转详情页面,支持配置跳转错误页面,支持自定义错误提示,错误提示内容默认为空,支持表达式;
③多条记录时,默认跳转列表页面,支持配置跳转错误页面,支持自定义错误提示,错误提示内容默认为空,支持表达式。③多条记录时,默认跳转列表页面,支持配置跳转错误页面,支持自定义错误提示,错误提示内容默认为空,支持表达式。选择报表时默认普通模式,仅支持查看。
参数值配置:支持常量、表达式;支持下拉选择系统变量(下拉列表选项不允许重复选择),应用内部名称(@appName)、模板内部名称(@fileName)、页面类型(@pageType)。
我们使用第一步中提前准备的帮助模版,配置如下:
3 显示与执行
PC端
启用帮助模板时,表单显示页面帮助文字的页面后显示“查看更多”按钮,如下图所示。
点击查看更多,使用当前表单应用内部名称、文件内部名称、页面类型等系统变量取值传参查询帮助模板在右侧弹窗中显示相应的帮助模板页面,如下图所示(当前页面为列表页面,显示列表详细帮助信息)
相应的如果由详情页面的页面帮助文字的点开“查看更多”会跳转页面类型为detail的详细帮助页面,新增页面和修改页面亦是如此。
移动端
启用帮助模板时,原帮助文字信息展示区域呈现为可点击的样式。
点击页面帮助文字区域跳转所配置的帮助模板的对应页面。
最后编辑:Eric 更新时间:2025-04-24 13:55
