語句をマークアップする

DITAでは、語句の見え方にアクセントを付けるためのマークアップが用意されています。これらのマークアップを使うことにより、読者が特別な意味を持った語句を識別しやくなります。

DITAには、語句の書体を指定するためのマークアップがあります。書体を指定するためのマークアップは、HTMLのマークアップと同様です。

表 1. 語句の書体を指定するためのマークアップ
要素名 用途
b 語句をボールド表示(強調表示)にします。
i 語句をイタリック表示(斜体表示)にします。
sub 語句を下付表示にします。
sup 語句を上付き表示にします。
tt 語句を等幅フォントで表示します。
u 語句をアンダーライン付き(下線付き)で表示します。

ソフトウェアに関連する語句を識別するためのマークアップを以下に示します。

表 2. ソフトウェア関連の語句を識別するためのマークアップ
要素名 用途
filepath ファイル・パスを表します。
msgph アプリケーションによって生成されるメッセージを表します。
systemoutput コマンドを実行したときなどに、システムによって表示されるメッセージを表します。
userinput コマンド・プロンプトやフォームのフィールドに、ユーザーが入力する文字列を表します。

msgphとsystemoutpuの使い分けの大まかなルールを説明します。ユーザーの入力(userinput)に対する応答を書く場合は、systemoutputを使います。それ以外のシステムが自動的に表示するメッセージを書く場合は、msgphを使います。

ユーザー・インターフェイスに関連する語句を識別するためのマークアップを以下に示します。

表 3. ユーザー・インターフェイス関連の語句を識別するためのマークアップ
要素名 用途
menucascade 階層的に選択する一連のメニュー項目を表します。
uicontrol ボタン、入力フィールド、メニュー項目などの、ユーザー・インターフェイスのラベルを表します。

ソフトウェアやユーザー・インターフェイスに関連する語句を識別するためのマークアップは、書体を指定するマークアップを特殊化することによって作られています。このため、DITA Open Toolkitをカスタマイズしていない場合、書体を指定するマークアップで示された語句と、ソフトウェアやユーザー・インターフェイスに関連する語句の見分けがつかないことがあります。

menucascade要素の記述例

下図に示したようなメニュー選択の説明を書く場合に、menucascade要素を使用します。

記述例:
<p>すべてのタグを属性値を含めて表示させるには、メインメニューから<menucascade><uicontrol>DITA</uicontrol><uicontrol>タグの表示モード</uicontrol><uicontrol>フル タグ</uicontrol>を選択します。</menucascade></p>
出力例:
すべてのタグを属性値を含めて表示させるには、メインメニューからDITA > タグの表示モード > フル タグを選択します。