一般的なマークアップのガイドライン
オンライン・ヘルプは通常のテキスト・ファイルで記述されています。特殊コード、またはタグを使用して、情報内の要素にマークを付けます。タグは、ヘルプタグと呼ばれるマークアップ言語を形成します。標準のテキスト・エディタを使用する場合、ヘルプタグ・マークアップが入力されます。または、エディタがマクロ・パッケージを提供している場合、タグはコマンド・キーを使用すると保存および挿入できます。ヘルプタグ・マークアップは構造化エディタを使用して生成することもできます (「正規マークアップ」を参照してください)。
ヘルプタグ・マークアップ言語は、章、セクション、サブセクションなどのハイレベル要素と、段落、リスト、および強調された語などのローレベル要素を定義する要素の階層を定義します。
ソース・ファイル内のマークアップ
ほとんどの要素のマークアップは、開始タグと終了タグで構成されます。開始タグは、三角括弧 (< と >) の間に要素名を入れて入力されます。終了タグも同様ですが、要素名の先頭に ¥ (バックスラッシュ) または 促 (円記号) が付きます。
<element> ... text ... <¥element>
たとえば、本のタイトルの始めと終わりをマークするには、次のようにマークアップを使用します。
<book>Geographical Survey of Northern Wisconsin<¥book>
<book> は開始タグで、<¥book> は終了タグになります。
簡易マークアップ
簡易マークアップは、標準テキスト・エディタを使用して手動でタグ付けする設計者向けに設計されたむだを省いたタグ・セットです。簡易マークアップにはいくつかの省略方法が用意されています。まず、終了タグの使用を最小化します。たとえば、章、節、または段落には終了タグを入力する必要はありません。さらに可能であれば、中間タグは自動的に想定されます。たとえば、章と節の要素により <head> タグを省略できます。したがって、ヘッダを入力するだけで済みます。
簡易マークアップは、文体の変更だけでなく多くのインライン要素へのマークアップも簡単にできます。テキストを区切るには、開始と終了のタグを入力するよりも、次のように縦線が使用されます。
<element| ... text ... |
たとえば、次の例は前に表示した <book> 要素の略式です。
<book| Geographical Survey of Northern Wisconsin|
要素にパラメータがある場合、要素とパラメータは次のように最初の縦線の前に入力します。
<element parameters| ... text ... |
開始と終了のタグを特殊な 2 文字のショートカットで置き換えるようなさらに略した形式をサポートしている要素もあります。たとえば、<emph> (強調表示) 要素の場合、その通常の形式は次のようになります。
<emph> ... text ... <¥emph>
上記の形式は、次のように簡易形式を使用して入力することもできます。
!! ... text ... !!
第 3 章「ヘルプ・トピックの記述」 では、簡易マークアップを紹介し、最も頻繁に使用される要素の例を示しています。第 5 章「ヘルプタグ・マークアップのリファレンス」では、要素をアルファベット順に並べて、各要素について詳細に説明しています。
正規マークアップ
正規マークアップを使用する場合は、パート II で説明されている情報を理解しておく必要があります。また、正規マークアップの詳細は、第 8 章「ヘルプタグ文書型定義の読み方」を参照してください。
ヘルプタグ記号の表示
時には、テキスト文字として < (左三角括弧)、¥ (バックスラッシュ)、または & (アンド記号) を使用する必要がある場合もあります。その場合は、各文字の先頭にアンド記号を付けてください (&<、&¥、または &)。
- © 2010, Oracle Corporation and/or its affiliates