コマンドや関数の構文を書く <refsyn>

リファレンス・トピックのコマンドや関数の構文(refsyn要素)には、コマンド・ライン・インターフェイスにおけるコマンドの書き方や、プログラミングにおける関数の呼び出し方など、構文や記法を記述します。

DITAには、構文を書くためのsyntaxdiagram要素がありますが、この要素を使って構文を書くことは推奨しません。理由は、syntaxdiagram要素を使って構文を書くのは、煩雑で手間がかかる割に、構文に厳格なタグ付けをしてもあまり効果がないためです。syntaxdiagram要素の代わりに、codeblock要素を使って構文を書くことを推奨します。

構文の記述例

簡単な構文の記述例を以下に示します。
  <refbody>
    <refsyn>
      <title>記述例</title>
      <codeblock>&lt;fo:external-graphic <b>content-width="scale-down-to-fit"</b> src="url(pdf_customize\img\pdf2_minitoc.jpg)" <b>width="100%"</b>/&gt;</codeblock>
    </refsyn>
        :
        :
  </refbody>