Aide:Accueil

Cheatsheet wikitext standard

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

Instructions d'édition de l'API

Reportez-vous à ces instructions quand vous éditez une page API.

Sommaire de l'API généré automatiquement

Normalement, une page API commence avec les signatures de code Delphi et C++ et une section propriétés qui sont toutes créées par ce texte généré automatiquement :

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

IMPORTANT : NE MODIFIEZ PAS LES TEXTES GENERES AUTOMATIQUEMENT.

Les signatures de code et la section propriétés sont automatiquement générées par nos scripts API en utilisant des informations directement depuis le compilateur.

Si la page est actuellement vide :

"Embarcadero Technologies ne dispose pas actuellement d'informations supplémentaires. Veuillez nous aider à documenter cette rubrique en utilisant la page Discussion !"

ou en héritant du contenu que vous voulez remplacer, la section Description ressemblera à ceci en mode édition :

 ==Description==
 {{#lsth:API:Controls.TDragControlObject|description}}

Si vous voulez ajouter du contenu à la section description, vous devez remplacer cette ligne API: par la ligne 'Inherits', la description courte balisée par <short> et la description longue, toutes décrites ci-dessous.

Si la page contient déjà ces sections en mode édition, et que vous voulez seulement ajouter ou changer du contenu, remplacez simplement le texte et laissez le format tel quel.

Edition de la section Description

La section Description contient des informations fournies par des ressources humaines. Elle comprend cinq sections :

• Wikiscript pour fournir des informations d'héritage pertinentes
• Description courte
• Description longue
• Voir aussi
• Catégorie

Section Héritage Wikiscript

En ajoutant du contenu à votre page API, les classes descendantes peuvent vouloir hériter de votre contenu. Pour cette raison, vous devez ajouter cette clause InheritsFrom. Notez que cette clause référence la page en cours. Ceci est utile pour les classes descendantes, qui peuvent ensuite trouver et dupliquer votre contenu.

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

Sections Description courte et Description longue

La description courte, tout en étant quelque peu répétitive sur ce type de page, est très importante pour le remplissage des tableaux de listes, comme sur la page [Controls].

La description longue est l'endroit où vous expliquez en détail le membre de l'API, en ajoutant parfois des remarques sur la disponibilité d'un autre membre plus approprié. Pensez à : "pourquoi" et "ce qu'un" développeur doit savoir.

Un retour chariot supplémentaire est requis entre la description courte et la description longue.

<section begin=short />Les objets [[Controls.TDragControlObject|TDragControlObject]] permettent d'effectuer les opérations de glisser-déplacer normales.<section end=short />

L'objet [[Controls.TDragControlObject|TDragControlObject]] effectue une opération normale de glisser-déplacer. Si [[Controls.TDragControlObject|TDragControlObject]] est utilisé, les événements OnDragOver et OnDragDrop reçoivent le contrôle en train de glisser dans la propriété Sender et non l'objet déplacement.
<blockquote>'''Remarque :'''  [[Controls.TDragControlObject|TDragControlObject]] n'est pas libéré automatiquement à la fin d'une opération de déplacement. Pour un objet déplacement automatiquement libéré, utilisez plutôt [[Controls.TDragControlObjectEx|TDragControlObjectEx]].</blockquote>

Section Voir aussi

Ajoutez autant de références Voir aussi que vous le pouvez. Définissez des liens sur d'autres membres de l'API, et sur des rubriques et exemples.

Utilisez la syntaxe de liens interwiki pour définir des liens sur les rubriques ; utilisez le préfixe 'rad_fr:' :

 [[rad_fr:Manipulation des contrôles - Index|Manipulation des contrôles]]

Pour définir des liens sur des exemples de code, utilisez le préfixe 'samp:' :

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

N'utilisez pas la syntaxe des liens interwiki pour des liens vers d'autres membres de l'API :

 ===Voir aussi===
 
 * [[Controls.TDragDockObject|TDragDockObject]]
 * [[Controls.TControl|TControl]]
 * [[Controls.TDragControlObjectEx|TDragControlObjectEx]]

Section Catégorie

Placez cette section Catégorie à la fin de la page.

 [[Category:Documentation API]]

Sommaire et enregistrement

Avant d'enregistrer la page, veuillez ajouter un sommaire. De cette façon les moniteurs wiki en sauront plus sur ce que vous avez fait, et peuvent ainsi organiser la localisation des informations que vous avez généreusement fournies.

Tous nos remerciements ! Contactez documentation@embarcadero.com pour toute question.