タスク・トピックの構造

タスク・トピック(task要素)は、タイトル(title要素)、ショート・デスクリプション(shortdesc要素)、プロローグ(prolog要素)、本文(taskbody要素)、および関連リンク(related-links要素)から構成されます。これらのトピックを構成する要素のうち、必須なのはタイトルだけです。

タスク・トピックの本文(taskbody要素)は、手順の説明に特化した厳格な文書構造を有します。

タスク・トピックの構造を下図に示します。



タスク・トピックの構造

タスク・トピックの本文(taskbody要素)には、以下の要素を記述できます。

prereq要素
タスクを実行するのに必要な、事前条件を記述します。
context要素
タスクの背景情報や予備知識を記述します。
steps要素(必須の要素)
タスクを完了するために、ユーザーが行う一連の手順を記述します。
result要素
タスクを完了したときの、期待される結果を記述します。
example要素
タスクの実行例、または、タスク実行の説明を補助するための例を記述します。
postreq要素
タスクを完了した後に、次に行うべきこと記述します。

タスク・トピックの記述例

タスク・トピックの簡単な記述例を下記に示します。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
"http://docs.oasis-open.org/dita/v1.1/OS/dtd/task.dtd">
<task id="installing_htmlhelp_workshop" xml:lang="ja-jp">
  <title>HTML Help Workshopをインストールする</title>
  <shortdesc>DITA Open Toolkitを使ってHTML Helpを生成する場合は、HTML Help Workshopをインストールする必要があります。HTML Help Workshopには、HTMLファイルをCHMファイルに変換するための、HTML Helpコンパイラが含まれています。HTML Help Workshopは、マイクロソフトのWebサイトからダウンロードできます。</shortdesc>
  <taskbody>
    <prereq>HTML Help Workshopをインストールするには、HDDの空き容量が8MB以上必要です。</prereq>
    <context>HTML Help Workshopは、MS Visual Studio、MS Officeリソース・キットなどに含まれています。これらのソフトウェアをインストールするときに、HTML Help     Workshopもインストールしている場合は、本タスクを実行する必要はありません。<filepath>C:\Program Files\HTML Help Workshop</filepath>フォルダーがある場合は、HTML Help Workshopがインストールされています。</context>
    <steps>
      <step>
        <cmd>Webブラウザを起動し、マイクロソフト社のHTML Help Workshopのダウンロード・サイトにアクセスします。</cmd>
        <info><p>HTML Help Workshop ダウンロード・サイト URL:<codeblock><xref format="html" href="http://msdn.microsoft.com/en-us/library/ms669985.aspx" scope="external">http://msdn.microsoft.com/en-us/library/ms669985.aspx</xref></codeblock></p></info>
      </step>
      <step>
        <cmd><uicontrol>Download Htmlhelp.exe</uicontrol>のリンクをクリックします。</cmd>
      </step>
      <step>
        <cmd>デスクトップなどの適当な場所に、<filepath>htmlhelp.exe</filepath>を保存します。</cmd>
      </step>
      <step>
        <cmd><filepath>htmlhelp.exe</filepath>をダブルクリックし、HTML Help Workshopのインストーラーを起動します。</cmd>
      </step>
      <step>
        <cmd>インストーラーの指示に従って、HTML Help Workshopのインストールを完了します。</cmd>
      </step>
    </steps>
    <result>HTML Help Workshopのインストールが正常に完了すると、Windowsのスタート・メニューにHTML Help Workshopのメニューができます。</result>
  </taskbody>
</task>