タスクの実行例を書く <example>

タスクの実行例(example要素)には、実際にタスクを実行した例や、タスク実行の説明を補うための例を記述します。

タスクの実行手順を説明するとき、文章で事細かに説明するよりも、実際の実行例を示した方が分かりやすい場合があります。タスクの実行例をテキストで示すことができる場合は、番号付きリストを使って実行例を記述します。出版物がオンライン・マニュアルだけの場合は、example要素の中にobject要素を挿入することにより、Flashなどの動画で実行例を示すこともできます。印刷物の場合は、動画を直接埋め込む代わり、タスクの実行例が見られるWEBサイトのURLを記述する方法もあります。

example要素の記述例

<task id="flagcontent" xml:lang="ja-jp">
    :
  <taskbody>
    <prereq> ... </prereq>
    <context> ... </context>
    <steps>
      <step>
        <cmd> ... </cmd>
        <info> ... </info>
        <stepxmp> ... </stepxmp>
        <stepresult> ... </stepresult>
      </step>
      :
    </steps>
    <result>1つの属性に付与されたいずれかの値が、フラグ付け対象に指定された値と一致した場合、その要素にフラグが付きます。フラグ付け対象がマップの中で見つかった場合、関係するトピック参照(topicref)を元に作られるリンクに、フラグが付きます。</result>
    <example>
      <title>フラグ付けの指定例</title>
        <dl>
            <dlentry>
                <dt>&lt;p audience="admin programmer"></dt>
                <dd>
                    <p>adminがフラグ付けの対象に指定された場合、admin向けの情報を識別するための画像が段落の前に表示されます。</p>
                    <p>adminとprogrammerの両方がフラグ付けの対象に指定された場合、両方の画像が段落の前に表示されます。</p>
                </dd>
            </dlentry>
            <dlentry>
                <dt>&lt;topicref platform="linux" href="abc.dita"></dt>
                <dd>linuxがフラグ付けの対象に指定された場合、トピック<filepath>abc.dita</filepath>に対するすべてのリンクにフラグが付きます。さらに、このtopicrefの子要素についても同様に、トピックに対するすべてのリンクにフラグが付きます(メタデータ属性は子要素に継承されるため)。</dd>
            </dlentry>
        </dl>
    </example>
  </taskbody>
</task>