| Horizontal Navigation Bar |
|---|
| Button Group |
|---|
| Button Hyperlink |
|---|
| title | Previous |
|---|
| type | standard |
|---|
| url | https://confluence.ecmwf.int/display/ECFLOW/Families |
|---|
|
| Button Hyperlink |
|---|
| title | Up |
|---|
| type | standard |
|---|
| url | https://confluence.ecmwf.int/display/ECFLOW/Going+Further |
|---|
|
| Button Hyperlink |
|---|
| title | Next |
|---|
| type | standard |
|---|
| url | https://confluence.ecmwf.int/display/ECFLOW/ecFlow+variables |
|---|
|
|
|
A manual page allows documentation in an 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:
| Code Block |
|---|
| language | bash |
|---|
| title | $HOME/course/test/f1/t2.ecf |
|---|
|
%manual |
| HTML |
|---|
<div class="section" id="add-manual">
<span id="manual"></span><span id="index-0"></span>
<p>A <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-manual-page"><em class="xref std std-term">manual page</em></a> allows documentation <strong>in</strong> a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> to be viewable in <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a>.</p>
<p>The manual page is the concatenation of all the text within the %manual and %end <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-directives"><em class="xref std std-term">directives</em></a>.</p>
<p>Modify <tt class="file docutils literal"><span class="pre">t2.ecf</span></tt> to have the following:</p>
<div class="highlight-python"><pre>%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"<head.h>
echo "I am part of a suite that lives in %ECF_HOME%"
%include "../tail.h"<tail.h>
%manual
There can be multiple manual pages in the same file.
When viewed they are simply concatenated.
%end</pre>
</div>
<p><strong>What to do:</strong></p>
<ol class="arabic simple">
<li>Modify <tt class="file docutils literal"><span class="pre">$HOME/course/test/t2.ecf</span></tt> script</li>
<li>Replace the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a></li>
<li>View the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-manual-page"><em class="xref std std-term">manual page</em></a> for <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> t2 in <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a></li>
</ol>
</div>
%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
| Code Block |
|---|
| language | bash |
|---|
| title | $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
| Code Block |
|---|
| language | bash |
|---|
| title | $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
- Modify $HOME/course/test/f1/t2.ecf script
- Add the file $HOME/course/test/f1.man
- Add the file $HOME/course/test.man
- View the manual page for task test/f1/t2 in ecflow_ui
- View the manual page for family test/f1 in ecflow_ui
- View the manual page for suite test in ecflow_ui
| Horizontal Navigation Bar |
|---|
| Button Group |
|---|
| Button Hyperlink |
|---|
| title | Previous |
|---|
| type | standard |
|---|
| url | https://confluence.ecmwf.int/display/ECFLOW/Families |
|---|
|
| Button Hyperlink |
|---|
| title | Up |
|---|
| type | standard |
|---|
| url | https://confluence.ecmwf.int/display/ECFLOW/Going+Further |
|---|
|
| Button Hyperlink |
|---|
| title | Next |
|---|
| type | standard |
|---|
| url | https://confluence.ecmwf.int/display/ECFLOW/ecFlow+variables |
|---|
|
|
|
