ユーザー操作の実例を書く <stepxmp>

stepxmp要素には、ユーザー操作の実例を示します。

例えば、ユーザーが何かを入力する操作を説明している場合、入力項目に「任意の文字列を入力します。」と書くよりも、入力項目が氏名ならば氏名らしいデータを、住所ならば住所らしいデータを示した方が、やらなければいけないことを読者が直感的に理解できるようになります。このようなユーザー操作の実例を示すときに、stepxmp要素を使います。

stepxmp要素の記述例

<task id="execute_by_ant" xml:lang="ja-jp">
    :
  <taskbody>
    <prereq> ... </prereq>
    <context> ... </context>
    <steps>
       :
      <step>
        <cmd>DITA Open Toolkitを実行するために、コマンドプロンプトに以下のコマンドを入力します。</cmd>
        <info><screen>&gt;<userinput>ant -f <varname>xxxx_xhtml</varname>.xml</userinput></screen>
          <parml>
            <plentry>
              <pt><varname>xxxx_xhtml</varname>.xml</pt>
              <pd>Antスクリプト・ファイルのファイル名</pd>
            </plentry>
          </parml>
        </info>
        <stepxmp>実行例:<screen>C:\DITA-OT1.4.3\doc\userguide&gt;<userinput>ant -f DITA-userguide_xhtml.xml</userinput></screen></stepxmp>
        :
      </step>
      :
    </steps>
    :
  </taskbody>
</task>