キーワードをマークアップする

DITAでは、プログラミング、ソフトウェア、ユーザー・インターフェイスなどで使われるキーワードを識別するためのマークアップが用意されています。

文書中のキーワードをマークアップすることにより、以下のようなメリットが得られます。

プログラミングに関連するキーワードを識別するためのマークアップを以下に示します。

表 1. プログラミング関連キーワードを識別するためのマークアップ
要素名 用途
apiname アプリケーション・プログラミング・インターフェイス(API)の名称を表します。
option コマンドなどに指定するパラメーターの中で、省略可能なパラメーターを表します。
parmname APIなどの、パラメーターを表します。

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

表 2. ソフトウェア関連キーワードを識別するためのマークアップ
要素名 用途
cmdname コマンド名を表します。
msgnum アプリケーション・プログラムが出力するメッセージの識別番号を表します。
varname コマンドなどを入力するときに、ユーザーが任意に指定できるパラメーターを表します。

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

表 3. ユーザー・インターフェイス関連キーワードを識別するためのマークアップ
要素名 用途
shortcut ソフトウェアのメニュー操作やウィンドウ操作のショートカット・キーを表します。
wintitle ソフトウェアのウィンドウやダイアログ・ボックスのタイトルを表します。