Hilfe:Inhaltsverzeichnis

Schnellübersicht für Wiki-Standardtext

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

Anleitungen für die Bearbeitung der API

Bitte halten Sie sich bei der Bearbeitung einer API-Seite an diese Anweisungen.

Automatisch erzeugter API-Inhalt

Normalerweise beginnt eine API-Seite mit den Delphi- und C++-Codesignaturen sowie einem Abschnitt mit den Eigenschaften. Diese Abschnitte werden von dem folgenden automatisch generierten Text erzeugt:

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

WICHTIG: BEARBEITEN SIE DIE AUTOMATISCH GENERIERTEN TEXTE NICHT.

Die Codesignaturen und der Eigenschaftsabschnitt werden automatisch von API-Skripten anhand von direkt vom Compiler übergebenen Informationen erzeugt.

Wenn die Seite momentan leer ist:

"Embarcadero Technologies verfügt zurzeit über keine zusätzlichen Informationen. Bitte unterstützen Sie uns bei der Dokumentation dieses Themas, indem Sie Ihre Kommentare auf der Diskussionsseite eingeben."

Oder wenn Sie geerbten Inhalt ersetzen möchten, würde der Beschreibungsabschnitt im Bearbeitungsmodus Folgendes enthalten:

 ==Beschreibung==
 {{#lsth:API:Controls.TDragControlObject|Beschreibung}}

Wenn Sie dem Beschreibungsabschnitt Inhalt hinzufügen möchten, müssen Sie diese API:-Zeile durch die "Inherits"-Zeile, die Kurzbeschreibung mit den <short>-Tags und die lange Beschreibung ersetzen (werden im Folgenden beschrieben).

Enthält die Seite im Bearbeitungsmodus bereits diese Abschnitte, und Sie nur Inhalt hinzufügen oder ändern möchten, ersetzen Sie einfach den Text und belassen das vorhandene Format.

Bearbeiten des Beschreibungsabschnitts

Der Beschreibungsabschnitt enthält die folgenden Informationen, die nicht automatisch erzeugt, sondern eingegeben werden. Er gliedert sich in fünf Abschnitte:

• Wikiscript für relevante Vererbungsinformationen
• Kurzbeschreibung
• Lange Beschreibung
• Siehe auch
• Kategorie

Abschnitt "Wikiscript-Vererbung"

Wenn Sie einer API-Seite Inhalt hinzufügen, kann es sein, dass abgeleitete Klassen diesen Inhalt erben sollten. Deshalb müssen Sie diese InheritsFrom-Klausel hinzufügen. Beachten Sie bitte, dass diese Klausel die aktuelle Seite referenziert. Dies ist für abgeleitete Klassen hilfreich, die dann Ihren Inhalt finden und kopieren können.

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

Abschnitte "Kurzbeschreibung" und "Lange Beschreibung"

Die Kurzbeschreibung, die bei diesem Seitentyp meist redundanten Text enthält, ist zum Füllen der Listentabellen, wie z.B. der Seite [Controls], sehr wichtig.

In der langen Beschreibung erläutern Sie den API-Member vollständig und fügen Hinweise hinzu, falls ein anderer Member geeigneter ist. Überlegen Sie sich "warum" und "was" ein Entwickler wissen muss.

Zwischen der Kurz- und der langen Beschreibung müssen Sie ein zusätzlichen Wagenrücklauf (Absatz) einfügen.

<section begin=short />[[Controls.TDragControlObject|TDragControlObject]] wird für normale Drag-and-Drop-Operationen genutzt.<section end=short />

Das Objekt [[Controls.TDragControlObject|TDragControlObject]] dient zur Ausführung normaler Drag-and-Drop-Operationen. Wenn [[Controls.TDragControlObject|TDragControlObject]] verwendet wird, empfangen die Ereignisse OnDragOver und OnDragDrop das gezogene Steuerelement als Sender, nicht das gezogene Objekt selbst.

<blockquote>'''Anmerkung:''' [[Controls.TDragControlObject|TDragControlObject]] wird am Ende einer Drag-Operation nicht automatisch freigegeben. Wenn Sie ein Objekt benötigen, das automatisch freigegeben wird, verwenden Sie stattdessen [[Controls.TDragControlObjectEx|TDragControlObjectEx]].</blockquote>

Abschnitt "Siehe auch"

Fügen Sie so viele "Siehe auch"-Verweise wie möglich hinzu. Verknüpfen Sie zu anderen API-Membern und zu Themen und Beispielen.

Verwenden Sie für Verweise zu Themen die Interwiki-Verknüpfungssyntax mit dem Präfix 'rad_de:'

 [[rad_de:Mit Steuerelementen arbeiten - Index|Mit Steuerelementen arbeiten]]

Für Links zu Codebeispielen verwenden Sie das Präfix samp:

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

Verwenden Sie die Interwiki-Verknüpfungssyntax nicht für Links zu anderen API-Membern:

 ===Siehe auch===
 
 * [[Controls.TDragDockObject|TDragDockObject]]
 * [[Controls.TControl|TControl]]
 * [[Controls.TDragControlObjectEx|TDragControlObjectEx]]

Abschnitt "Kategorie"

Fügen Sie diesen Kategorieabschnitt am Ende der Seite ein.

 [[Category:API-Dokumentation]]

Speichern und kurze Zusammenfassung der Änderung

Fügen Sie bitte vor dem Speichern der Seite eine kurze Zusammenfassung hinzu. Auf diese Weise können die Wiki-Prüfer schneller erkennen, was Sie geändert haben, und Vorkehrungen für das Lokalisieren der von Ihnen dankenswerterweise zur Verfügung gestellten Informationen treffen.

Vielen Dank! Wenden Sie sich bei Fragen bitte an documentation@embarcadero.com.