1. Documentation
2. 10.1 (Latest)10.09.109.99.89.79.69.59.49.39.29.19.08.28.18.07.6
3. Developers
4. Creating your own extension
5. Providing operator documentation

提供操作文档

It's natural to add documentation to program code, but this does not help the end user who never sees any part of the program code.

You have already configured the filesOperatorsNAME.xmlandOperatorsDocNAME.xmlto provide the operator with an icon and name.

The extension template contains an example of operator documentation. The XML file is placed in the folderNAME.example_group, where 'NAME' is the extension name. You should create one folder, calledNAME.group_name, per operator group, and add one XML file per operator to the respective group folder.

In this example, the folder is named我的test.operator_test, because the extension name is 'MyTest' and the group ID is 'operator_test'. The file is called我的_own_operator.xml, because the operator key is 'my_own_operator'.

Now, copy the sample file content and adapt it to your needs:

    
 This is an example Operator. It writes to the Log View when being executed.   First paragraph. Second paragraph.    Input port description.     Output port description.      Description here       Tutorial description here.    ...        

Change the content between the tags to describe your operator, ports and parameters.

You can add a tutorial process. To do so, complete the tutorial description and exchange the process tags with the process XML of your tutorial process.

Congratulations for your first complete operator, repeat steps 3 through 6 of this guide for each operator that you want included in your extension.

Then,publish your extensionif you want to provide it to the Community or check out whichadvanced enhancementsyou can build for RapidMiner Studio.