Help on Help - docwiki

From RAD Studio
Jump to: navigation, search

Go Up to Help on Help


The online help of RAD Studio is available in three separate wikis:

All RAD Studio users are invited to participate in the docwiki. You can create your own user account by clicking Log in \ Create account on any page in the docwiki.

Getting Started

You must log in to edit the Discussion page. For permission to edit the main pages, contact [email protected].

  • Click the Discussion tab to ask or answer a question about the topic.
  • Click the Edit tab to display the wiki markup and optionally edit the displayed topic.

Basic Wiki Tags When You are Editing or Writing

Bullets

To create a bulleted paragraph, enter a star or an asterisk (*) in the first column. Use multiple stars for nested levels, as follows:

  • * (one star) gives you a top-level bullet, like this one.
    • ** (two stars) give you a second-level bullet, like this one.
      • *** (three stars) give you a third-level bullet, like this one.

Linking

To create a hyperlink to another topic on the docwiki, enclose the topic name in double brackets, as follows: 

 [[Object Inspector]] = Object Inspector

Linking Between Wikis

There are actually three docwikis: Topics, Libraries, and Code Examples, and you can easily create links from one docwiki to another.

  • To create a hyperlink to the Libraries Reference, add the 'lib_en:' prefix. For other languages, use lib_de, _fr, and _ja. Specify the title using a "|" to eliminate the prefix from the link:
    [[lib_en:FMX.Forms.TForm|FMX.Forms.TForm]] = FMX.Forms.TForm
  • To link from another docwiki to the Topics docwiki, use the 'rad_en:' prefix:
    [[rad_en:Object Inspector|Object Inspector]] = Object Inspector
  • To link to the code examples docwiki, use the samp: prefix:
    [[samp:TrySystemTimeToDateTime ({{Delphi}})|TrySystemTimeToDateTime ({{Delphi}})]] = TrySystemTimeToDateTime (Delphi)

Headings

To create headings of various levels, start and end the line with one or more equals signs (=). A top-level heading has one equals sign, and lower headings have more equals signs, as shown below: 

== Sample Heading 2 ==

creates a Heading 2, like this:

Sample Heading 2

=== Sample Heading 3 ===

create a Heading 3, like this:

Sample Heading 3

Adding a Page to the Docwiki

  1. In a related topic (one that needs to link to the topic you want to create), add a link to the new topic:
    [[new topic]]
  2. Save the page.
  3. Click the (red) link to your new topic.
  4. Now you can start writing the new topic.
    • At the top, add a parent tag (to provide the "Go Up to" link):
    {{Parent|higher topic}}
    that points to the topic located above your topic in the help organization (the Table of Contents).
    Note: If you are unsure about which is the parent topic, contact [email protected].
    • At the bottom, add an optional See Also list:
    == See Also ==

Adding Wiki Category Tags

Category tags help to group related topics. To examine the list of categories that currently exist on the docwiki, see Special:Categories.

Every page should have at least one of the following tags:

  • language tag, either Delphi or C++ or both
  • version tag
  • optional technology tag
  • organizational tag (such as Delphi Language Guide or RAD Studio Reference)

Here are some examples:

Delphi Only: 

[[Category:{{Delphi}}]]

C++ Only: 

[[Category:C++]]

Both: 

[[Category:C++]]
[[Category:{{Delphi}}]]

Each page should be tagged for the version in which it first appeared, or for the last version where the page suffered major changes: 

[[Category:XE2]]

Additional categories pertain to the technology, here are some suggestions.

FireMonkey library: 

[[Category:FMX]]

RTTI library: 

[[Category:RTTI]]

Topics

See Also

Retrieved from "https://docwiki.embarcadero.com/RADStudio/Sydney/e/index.php?title=Help_on_Help_-_docwiki&oldid=272362"