Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
%manual
 OPERATORS: If this task fails, set it complete and report
 next working day
 ANALYST: Check something or do something clever! %end
 ls -l pwd hostname %manual Rest of the manual page is placed here, closer to the code
 %end


There can be multiple manual sections in the same file. When viewed they are simply concatenated. This helps in maintaining the manual pages. It is good practice to modify the manual pages when the script is changed.
Viewing manual page from the above ecFlow script would look something like
OPERATORS: If this task fails, set it complete and report
next working day
ANALYST: Check something or do something clever!
Rest of the manual page is placed here, closer to the code
After %manual all pre-processor symbols are ignored until %end is found. Thus you cannot use %comment - %end to un-comment manual pages. Manual pages may have include statements like in the following extract:

Code Block
%manual
 OPERATORS: If this task fails, set it complete and report
 and next working day 
 ANALYST: Check something or do something clever! 
 %include <manual/foo.bar>
 %end 
 ls -l
 pwd
 hostname 
 %manual
 Rest of the manual page is placed here
 %end


For example standard instructions for operators could be placed in a single file and then included in every task (like contact phone numbers etc.) How the include file is found is explained in the next section.
Suites and families can also have manual pages. However, these are separate files placed in the suite/family directories e.g. the manual page for a family family1 is a file family1.man in the relevant directory.