beautypg.com

Document an add-on instruction – Rockwell Automation Logix5000 Controllers Add-on Instructions Programming Manual User Manual

Page 64

background image

Chapter 2

Defining Add-On Instructions

This is an example of the Extended Description Text field in the Help tab on the
Add-On Instruction Definition Editor. This area lets you create directions on
how to use and troubleshoot your instruction. The Instruction Help Preview

window shows how your text will look as generated instruction help.

Tip:

When you are typing your text into the Extended Description Text field, you can use returns and tabs in

the field to format the text, and if you copy and paste text into the field tabs are preserved.

Document an Add-On Instruction

Follow these steps to create custom help for an instruction.

1. Right-click an Add-On Instruction and select Open Definition.

2. On the General tab, in the Extended Description Text box, type a

description and a revision note for the Add-On Instruction to explain the

purpose of the instruction.

3. Click the Parameters tab in the Description box, type a meaningful

description for each Parameter.

4. Right-click each routine located below the Add-On Instruction in the

Controller Organizer and select Properties.

5. In the Description box, type a description for execution of each routine.

64

Rockwell Automation Publication 1756-PM010F-EN-P - October 2014