Adding a manual

A manual page allows including documentation directly in a ecf script to be viewed in ecflow_ui.

The manual page is the concatenation of all the text within the %manual and :code`%end` directives.

To include the manual for task t2, modify t2.ecf to include the following:

Listing 20 $HOME/course/test/f1/t2.ecf
%manual
   Manual for task t2
   Operations: if this task fails, set it to complete and report next working day
   Analyst:    Check something ?
%end

%include "../head.h"
echo "I am part of a suite that lives in %ECF_HOME%"
%include "../tail.h"

%manual

   There can be multiple manual pages in the same file.
   When viewed they are simply concatenated.
%end

A manual page can also be added to a family and suite node.

To add a manual page for family f1, create a file named f1.man with the following content in the directory {HOME}/course/test:

Listing 21 $HOME/course/test/f1.man (Family Manual Page)
This manual is for family %FAMILY%
It can have any text and will also have variable substitution
Notice that this does not have manual..end since the whole file is a manual page.

To add a manual page for suite test, create a file named test.man` with the following content in the directory {HOME}/course:

Listing 22 $HOME/course/test.man (Suite Manual Page)
%manual
This is the manual page for the %SUITE% suite.
It lives in %ECF_HOME%
%end
This text is not visible in the man page since it is out side of the %manual..%end

Important

Notice that for family and suite nodes, the enclosure in %manual ... %end is not strictly necessary. However, adding %manual ... %end allows to decide what parts are made visible when using ecflow_ui.

What to do

  1. Add the task manual to t2.ecf script

  2. Add the file f1.man

  3. Add the file test.man

  4. View the manual page for task t2 in ecflow_ui

  5. View the manual page for family f1 in ecflow_ui

  6. View the manual page for suite test in ecflow_ui