Open topic with navigation

TIBCO ActiveMatrix BusinessWorks™ Plug-in Development Kit 6.3.1

# Creating Documentation

BusinessWorks Plug-in Development Kit generates a documentation template based on the activities that you have created. You can update the documentation template to guide your plug-in users, and configure the documentation for online help.

A doc folder is generated under the project folder after generating the plug-in activities. Open the index.html, the created documentation template is displayed.

The documentation template contains a user's guide and an installation guide. In the user's guide, BusinessWorks Plug-in Development Kit automatically creates reference topics for the created palette and activities.

You can update the documentation template based on your requirements. For example, add a description for the SayHello activity.

After updating the documentation, you can enable the online help function for the created palette, as described in How to Add Online Help for a Palette.

After configuring the online help settings, in the process editor, right-click the activity and click Help > Reference Page. The help content for the activity is displayed in the Reference view.

Caution: Any changes to the documentation files will be lost if you edit the palette and re-generate the source code. Save the modified version and replace the re-generated files with it.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO ActiveMatrix BusinessWorks™ Plug-in Development Kit

Copyright © 2014-2022. TIBCO Software Inc. All Rights Reserved.