IcCube - 如何在自定义小部件/自定义单元格渲染器上添加帮助？

Question

我使用 IcCube 报告 V8 (ic3-reporting-api) 创建了一些自定义小部件类型和单元格渲染器。 有没有办法将一些帮助链接到这些，因为它存在于原始组件中？

自定义小部件：

自定义单元格渲染器：

Answer 1

小部件

您可以添加一些文档/帮助，这些文档/帮助将通过 (?) 图标在编辑器中提供。该框架正在服务器 Docs 中搜索位于 ic3-reporting/app-local 文件夹或官方文档文件夹（即 ic3-reporting/doc）中的 MD 文件。

该文件的名称是从小部件模板构建的，如下所示：

"widgets." + pluginId + "." + templateType + "." + templateId

因此，假设您在名为 MyPluginJS 的插件中创建了一个名为 SimpleTable 的自定义表格小部件，并将此小部件注册到 chart 部分，那么 MD 文件名将是：

widgets.MyPluginJS.chart.SimpleTable.md

然后将此名称翻译成路径：

widgets/MyPluginJS/chart/SimpleTable.md

它首先在ic3-reporting/app-local 中搜索，首先使用用户的语言环境，然后使用英语：

/icCube/report/ic3-reporting/app-local/doc/
    fr/widgets/MyPluginJS/chart/SimpleTable.md
    en/widgets/MyPluginJS/chart/SimpleTable.md

最终，在 ic3-reporting/doc 文件夹中仅搜索英语语言环境：

/icCube/report/ic3-reporting/doc/
    en/widgets/MyPluginJS/chart/SimpleTable.md

但是，不建议将文档添加到 ic3-reporting/doc 文件夹，因为每次安装新版本的报告应用程序时都会覆盖此目录。

转换

相同的机制用于转换。路径如下：

tidyTable/transformations/MyPluginJS/SimpleRenderer.md

请注意，pluginId 未用于 v8.2.2 中的转换路径（这将在 v8.3 中修复）。

编辑：忘记提及 app-local/ic3report-config.js 必须更新如下：

// extra. doc. localization folder
options.appDocUrlEx = "doc";