Help:Contents

From RAD Studio API Documentation
Jump to: navigation, search

Standard Wikitext Cheatsheet

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

API Editing Instructions

Please refer to these instructions when you edit an API page.

Auto-Generated API Content

Normally, an API page starts with Delphi and C++ code signatures and a properties section that are all created by this auto-generated text:

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

IMPORTANT: DO NOT EDIT THE AUTO-GENERATED TEXTS.

The code signatures and properties section are automatically generated by our API scripts using information directly from the compiler.

If the page is currently empty:

"Embarcadero Technologies does not currently have any additional information. Please help us document this topic by using the Discussion page!"

or inheriting content that you want to replace, the Description section will look like this in edit mode:

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

If you want to add content to the description section, you should replace this API: line with the Inherits line, the short description tagged with <short>, and the long description, all described below.

If the page already contains these sections in edit mode, and you just want to add or change content, just replace the text and leave the format the same.

Editing the Description Section

The Description section contains the human-supplied information. It has five sections:

  • Wikiscript to provide relevant inheritance info
  • Short Description
  • Long Description
  • See Also
  • Category

Wikiscript Inheritance Section

In adding content to your API page, descendant classes may want to inherit your content. For this reason, you need to add this InheritsFrom clause. Notice that this clause references the current page. This is useful for descendant classes, which can then find and replicate your content.

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

Short and Long Description Section

The short description, while a bit repetitive on this type of page, is very important for populating the list tables such as on the [Controls] page.

The long description is where you fully explain the API member, sometimes adding notes about when another member is more appropriate. Think about "why" and "what" a developer needs to know.

An extra carriage return is required between the short and long descriptions.

<section begin=short />[[Controls.TDragControlObject|TDragControlObject]] object provides for normal drag-and-drop operations.<section end=short />

[[Controls.TDragControlObject|TDragControlObject]] object performs normal drag-and-drop operations. When [[Controls.TDragControlObject|TDragControlObject]] is used, the [[Controls.TControl.OnDragOver|OnDragOver]] and [[Controls.TControl.OnDragDrop|OnDragDrop]] events receive the control being dragged as the Sender, instead of the drag object itself. 

<blockquote>'''Note:'''  [[Controls.TDragControlObject|TDragControlObject]] is not automatically freed at the end of a drag operation. For a drag object that is automatically freed, use [[Controls.TDragControlObjectEx|TDragControlObjectEx]]. </blockquote>

See Also Section

Add as many See Also references as you can. Link to other API members and to Topics and Examples.

Use interwiki link syntax to link to the Topics; use the 'rad_en:' prefix:

[[rad_en:Working with Controls Index|Working With Controls]] 

To link to code samples, use the samp: prefix:

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

Do not use interwiki link syntax for links to other API members:

===See Also===

* [[Controls.TDragDockObject|TDragDockObject]]
* [[Controls.TControl|TControl]]
* [[Controls.TDragControlObjectEx|TDragControlObjectEx]]

Category Section

Category tags help to group related topics. All library pages have this category tag:

[[Category:API Documentation]]

Additional categories pertain to the technology. Here are some suggestions:

Floating-point classes and functions:

[[Category:Floating-Point]]

Classes and functions for multithreading:

[[Category:Multithreading]]

Docwiki Needs More Categories

If you see a need for a new category, check with your Lead Writer before tagging pages. Then after you tag a set of pages, make sure you edit the Category page itself, so that users find some general information about the category on the Category page.

Note: In the Topics wiki, FireMonkey subject-matter topics have the following tag:

[[Category:FMX]] 

In the Libraries wiki, this tag is redundant, since the unit scope for FireMonkey is FMX. Do not use the FMX category tag for FMX unit scope members in the Libraries wiki.

Saving and the Summary

Before you Save the page, please add a Summary. That way the wiki monitors will know more about what you did and can make arrangements for localizing the information you have generously provided.

Contact documentation@embarcadero.com for any questions. Thank you!

Click Help Feedback at the bottom of a displayed page of help (either in the docwiki or in the installed H2 help).