Page History

<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"
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</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>