Add Manual

A manual page allows documentation in a ecf script to be viewable in ecflow_ui.

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

Modify t2.ecf to have the following:

Listing 18 $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. Create a file called f1.man` in $HOME/course/test as the FAMILY man page.

Listing 19 $HOME/course/test/f1.man ( FAMILY MAN 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.

Now create the file test.man` in $HOME/course as the SUITE man page:

Listing 20 $HOME/course/test.man ( SUITE MAN 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

Notice that for family and suite nodes that the addition %manual..%end is not strictly necessary. However by adding %manual..%end you can decide what parts are made visible to the GUI.

What to do

  1. Modify $HOME/course/test/t2.ecf script

  2. Add the file $HOME/course/test/f1.man

  3. Add the file $HOME/course/test.man

  4. View the manual page for task t2 in ecflow_ui

  5. View the manual page for family test/f1 in ecflow_ui

  6. View the manual page for suite test in ecflow_ui