ヘルプ:目次

提供: RAD Studio API Documentation
移動先: 案内、 検索

標準の Wikitext 早見表

http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet

API 編集手順

API ページを編集する際には、以下の手順を参照してください。

自動生成された API の内容

通常、API ページの先頭には、Delphi および C++ のコード シグネチャと、「プロパティ」セクションがあります。これはすべて、自動生成された次のテキストによって作成されます。 

 {{#lst:API:Controls.TDragControlObject|api}}

重要： この自動生成テキストは編集しないでください。

コード シグネチャと「プロパティ」セクションは、コンパイラから直接取り出した情報を基に、API スクリプトで自動生成されます。

ページが現在空である場合や（次のように表示されます）、

"このトピックには現在ドキュメントが存在しません。 「ノート」を利用してこのトピックの改良について話しあうことができます。"

継承した内容（置き換える対象）が表示されている場合には、編集モードで開くと「説明」のセクションは次のようになっています。 

==説明==
{{#lsth:API:Controls.TDragControlObject|説明}}

「説明」セクションに内容を追加するには、この API: の行を、継承の行、<short> タグの付いた概略説明、および詳細説明に置き換えます。これらについては、すべてこの後で説明します。

編集モードでこれらのセクションが既にページに含まれていて、内容の追加や変更だけを行いたい場合には、テキストだけを置き換え、形式は変えずに残してください。

「説明」セクションの編集

「説明」セクションには、人の手による情報が含められます。 これは次の 5 つのセクションに分かれています。

  • 関連する継承情報を表示する Wikiscript
  • 概略説明
  • 詳細説明
  • 関連項目
  • カテゴリ

Wikiscript の継承セクション

API ページに内容を追加するときに、下位クラスで内容を継承したい場合があります。 それには、次の InheritsFrom 句を追加する必要があります。 この句では現在のページを参照していることに注目してください。 これを下位クラスで使用すると、内容を検索して複製できるため有益です。 

==説明==
{{#ifeq: {{PAGENAME}} | Controls.TDragControlObject | |{{InheritsFrom|Controls.TDragControlObject}}}}

概略説明と詳細説明のセクション

概略説明は、この種類のページではいくらか繰り返しになりますが、「Controls」ページなどの一覧に表示されるため非常に重要です。

詳細説明には、API メンバの完全な説明を記述します。また、別のメンバを使用した方が適切であれば、そのメモも追加します。 開発者が知っておくべき "why" と "what" を考慮してください。

概略説明と詳細説明の間には、復帰文字が 1 つ余分に必要です。 

<section begin=short />[[Controls.TDragControlObject|TDragControlObject]] オブジェクトは，通常のドラッグアンドドロップ操作を管理します。<section end=short />

[[Controls.TDragControlObject|TDragControlObject]] オブジェクトは通常のドラッグアンドドロップ操作を実行します。[[Controls.TDragControlObject|TDragControlObject]] を使用すると，OnDragOver および OnDragDrop イベントはドラッグオブジェクト自体ではなくドラッグ中のコントロールを Sender として受け取ります。

<blockquote>'''メモ：'''  [[Controls.TDragControlObject|TDragControlObject]] は，ドラッグ動作の終了時に自動的に解放されません。自動的に解放されるドラッグオブジェクトが必要な場合は，かわりに [[Controls.TDragControlObjectEx|TDragControlObjectEx]] を使用してください。</blockquote>

関連項目セクション

「関連項目」の参照はできるだけ多く追加してください。 他の API メンバや、トピック、例にリンクします。

interwiki リンク構文を使ってトピックへリンクするには、次のように 'rad_ja:' を前に付けます。 

[[rad_ja:コントロールの利用：インデックス|コントロールの利用]]

コード例にリンクするには、次のように samp: を前に付けます。 

[[samp:ViewStyleProperty_(Delphi)|ViewStyleProperty_(Delphi)]]

別の API メンバに対するリンクには、interwiki リンク構文を使用しないでください。 

===関連項目===
 
* [[Controls.TDragDockObject|TDragDockObject]]
* [[Controls.TControl|TControl]]
* [[Controls.TDragControlObjectEx|TDragControlObjectEx]]

カテゴリ セクション

このカテゴリ セクションは、ページの最後に配置します。 

[[Category:API ドキュメント]]

保存と要約

ページを保存する前に、［Summary］フィールドに要約を追加してください。 それにより、wiki 監視者は、何が行われたかを把握して、記述頂いた情報のローカライズを手配することができます。

よろしくお願いいたします。 ご質問があれば documentation@embarcadero.com にご連絡ください。

「https://docwiki.embarcadero.com/Libraries/Athens/j/index.php?title=ヘルプ:目次&oldid=169685」から取得