ヘルプの使い方： docwiki
目次 |
ファースト ステップ
［ノート］ページを編集するには、ログインする必要があります。メインページを編集する権限を取得するには、documentation@embarcadero.com にご連絡ください。
- ［ノート］タブをクリックすると、トピックに関する質問をしたり質問に答えることができます。
- ［編集］タブをクリックすると、Wiki マークアップが表示され、表示トピックを任意で編集することができます。
編集時または作成時に使用する基本的な Wiki タグ
箇条書き
箇条書き段落を作成するには、先頭にアスタリスク（*）を入力します。レベルがネストする場合は、以下のように複数のアスタリスクを使用します。
- アスタリスクを 1 つ（*）付けると、この例のように第 1 レベルになります。
- アスタリスクを 2 つ（**）付けると、この例のように第 2 レベルになります。
- アスタリスクを 3 つ（***）付けると、この例のように第 3 レベルになります。
- アスタリスクを 2 つ（**）付けると、この例のように第 2 レベルになります。
リンク
docwiki に含まれている別のトピックへのハイパーリンクを作成するには、以下のようにトピック名を二重の角かっこで囲みます。
[[［オブジェクト インスペクタ］]] = ［オブジェクト インスペクタ］
Wiki 間のリンク
実際には、トピック、API リファレンス、コード例の 3 つの docwik があり、それらの相互リンクをたやすく作成できます。
- API リファレンスへのハイパーリンクを作成するには、'lib_en:' プレフィックスを付けます。英語以外の言語の場合は、lib_de、lib_fr、lib_ja を使用します。"|" を使ってタイトルを指定すると、以下のように、リンクにプレフィックスが表示されないようにすることができます。
- [[lib_ja:Vcl.Forms.TForm|Vcl.Forms.TForm]] = Vcl.Forms.TForm
- 別の docwiki からトピック docwiki にリンクするには、次のように 'rad_ja:' プレフィックスを付けます。
- [[rad_ja:［オブジェクト インスペクタ］|［オブジェクト インスペクタ］]] = ［オブジェクト インスペクタ］
- コード例 docwiki にリンクするには、以下のように samp: プレフィックスを使用します。
- [[samp:TrySystemTimeToDateTime (Delphi)|TrySystemTimeToDateTime (Delphi)]] = TrySystemTimeToDateTime (Delphi)
見出し
さまざまなレベルの見出しを作成するには、その行を 1 つ以上の等号（=）で囲みます。第 1 レベル見出しの場合は等号が 1 つで、下位見出しの場合は以下のように等号が複数になります。
== Sample Heading 2 ==
上記の場合は、以下のような第 2 レベル見出しが作成されます。
第 2 レベル見出しの例
=== Sample Heading 3 ===
上記の場合は、以下のような第 3 レベル見出しが作成されます。
第 3 レベル見出しの例
docwiki へのページの追加
- 関連トピック（作成するトピックにリンクする必要があるトピック）で、新しいトピックへのリンクを以下のように追加します。
- [[新規トピック]]
- ページを保存します。
- 新規トピックへの（赤い）リンクをクリックします。
- これで、新規トピックの作成を開始できます。
- 冒頭に、以下のように親タグ（H2 ヘルプでの［～への移動］リンクを提供するもの）を追加します。
- {{parent|上位トピック}}
- これは、ヘルプ構成（目次）で現在のトピックの上位に位置するトピックを指します。
- メモ： どれが親トピックか不明な場合は、khouser@embarcadero.com にお問い合わせください。
- 本文の末尾に、以下のような「関連項目」リストを任意で追加します。
- ==関連項目==
Wiki カテゴリ タグの追加
カテゴリ タグは、関連するトピックをグループ化するのに役立ちます。docwiki に現在存在するカテゴリの一覧を調べるには、「http://docwiki.embarcadero.com/RADStudio/XE2/ja/特別:カテゴリ」を参照してください。
どのページにも、以下のタグのいずれかが少なくとも 1 つ必要です。
- 言語タグ（Delphi か C++ のどちらか、またはその両方）
- バージョン タグ
- 技術タグ（任意指定）
- 編成タグ（たとえば、「Delphi 言語ガイド」や「RAD Studio リファレンス」など）
以下に例をいくつか示します。
Delphi のみの場合：
[[Category: Delphi]]
C++ のみの場合：
[[Category: C++]]
両方に該当する場合：
[[Category: C++]][[Category: Delphi]]
各ページには、初出時または、更新され新しいバージョンでテストされたときのバージョン（2010、XE、XE2 など）を示すタグを付ける必要があります。
[[Category: XE2]]
2010 の場合：
[[Category:2010]]
複数に該当する場合：
[[Category:XE]][[Category:2010]]
他に、技術に関連するカテゴリがあります。以下に案をいくつか示します。
FireMonkey ライブラリの場合：
[[Category:FMX]]
RTTI ライブラリの場合：
[[Category:RTTI]]