添加说明

manual page 使 ecf script 中的文档可以在 ecflow_ui 中看到。

说明页是指令 %manual 和 %end 之前的所有文本的组合。

修改 t2.ecf：

  1. %manual
  2.    Manual for task t2
  3.    Operations: if this task fails, set it to complete and report next working day
  4.    Analyst:    Check something ?
  5. %end
  7. %include <head.h>
  8. echo "I am part of a suite that lives in %ECF_HOME%"
  9. %include <tail.h>
  11. %manual
  12.    There can be multiple manual pages in the same file.
  13.    When viewed they are simply concatenated.
  14. %end

添加说明 - 图1

manual 也可以添加到 family 和 suite 节点。

在 $ECF_HOME/test 创建 f1.man：

  1. This manual is for family %FAMILY%
  2. It can have any text and will also have variable substitution
  3. Notice that this does not have manual..end since the whole file is a manual page.

添加说明 - 图2

在 $ECF_HOME 创建 test.man：

  1. %manual
  2. This is the manual page for the %SUITE% suite.
  3. It lives in %ECF_HOME%
  4. %end
  5. This text is not visible in the man page since it is out side of the %manual..%end

添加说明 - 图3

注意对于 family 和 suite 节点，附加的 %manual...%end 不是必须的，但可以通过添加 %manual...%end 来决定在 GUI 中显示哪些部分的说明。

任务

  1. 修改 $ECF_HOME/test/f1/t2.ecf 脚本
  2. 添加 $ECF_HOME/test/f1.man 文件
  3. 添加 `$ECF_HOME/test.man 文件
  4. 在 ecflow_ui 中查看 task t2、family f1、suite test 的说明页