提供操作人员文档
向程序代码中添加文档是很自然的,但这对从未见过程序代码任何部分的最终用户没有帮助。
您已经配置了这些文件OperatorsNAME.xml
和OperatorsDocNAME.xml
为操作员提供图标和名称。
扩展模板包含一个操作符文档示例。XML文件放在文件夹中NAME.example_group
,其中'NAME'是扩展名。您应该创建一个文件夹,名为NAME.group_name
为每个操作符组添加一个XML文件,并将每个操作符添加到各自的组文件夹中。
在本例中,文件夹命名为mytest.operator_test
,因为扩展名是'MyTest',组ID是'operator_test'。这个文件叫做my_own_operator.xml
,因为操作符键是'my_own_operator'。
现在,复制示例文件内容并根据您的需要进行调整:
<?xml version="1.0" encoding="UTF-8"?> < ?href type = " text / xml样式表xsl” ="../../../../../ rapidminerreferencemanual documentation2html.xsl”?> 我自己的操作符
< summary >这是一个示例操作符。它在执行时写入日志视图。 summary > 第一段。段落> <段落>第二段。 Description here Tutorial description here. ...
更改标签之间的内容,以描述操作符、端口和参数。
不要忘记调整本文档中的操作符密钥。否则,您的操作员图标将无法在操作员帮助中正确显示。
你可以添加一个教程过程。为此,完成教程描述并将过程标记与教程过程的过程XML交换。
- 构建您想要添加到文档中的RapidMiner进程。
- 然后,打开视图>显示面板> XML菜单。XML面板打开。
- 将XML面板移动到RapidMiner Studio中舒适的位置。您可以在面板中看到XML格式的流程。
- 复制完整的XML代码以提取流程。
祝贺你的第一个完整的操作,重复步骤3到6本指南的每个操作,你想要包括在您的扩展。