ecFlow's documentation is now on readthedocs!

Please go to https://ecflow.readthedocs.io/en/latest/index.html

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

This page contains macros or features from a plugin which requires a valid license.

You will need to contact your administrator.

Previous Up Next

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 $HOME/course/test/f1/t2.ecf  to have the following:

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

f1.man
This manual is for family %FAMILY%
It can have any text and will also have variable substitution

Now create the file test.man in  $HOME/course

This is manual page for the test suite.
It lives in %ECF_HOME%


What to do

  1. Modify $HOME/course/test/f1/t2.ecf script
  2. Add the file $HOME/course/test/f1.man
  3. View the manual page for task test/f1/t2  in ecflow_ui
  4. View the manual page for family test/f1 in ecflow_ui
  5. View the manual page for suite test in ecflow_ui

 

 

 

  • No labels