Help:Contents
Contents |
Getting Started
You must log in to edit the Discussion page. For permission to edit the main pages, contact documentation@embarcadero.com.
- Click the Edit tab to display the wiki markup and optionally edit the displayed topic.
- Click the Discussion tab to ask or answer a question about the topic.
Basic Wiki Tags When You are Editing or Writing
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.
- ** (two stars) give you a second-level bullet, like this one.
To create a hyperlink to another topic on the docwiki, enclose the topic name in double brackets, as follows:
[[Object Inspector]] = Object Inspector
To create a hyperlink to the VCL, add the 'vcl_en:' prefix. For other languages, use vcl_de, _fr, and _ja. Specify the title using a | to eliminate the prefix from the link:
[[vcl_en:Forms.TForm|Forms.TForm]] = Forms.TForm
To link from the VCL to the Topics, use the 'rad_en:' prefix in the same way as the VCL prefix:
[[rad_en:Object Inspector|Object Inspector]] = Object Inspector
To link to code samples, use the samp: prefix:
[[samp:TrySystemTimeToDateTime (Delphi)|TrySystemTimeToDateTime (Delphi)]] = TrySystemTimeToDateTime (Delphi)
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 follows:
Sample Heading 2
==Heading 2 Has Two Equals Signs==
Sample of Heading 3
===Heading 3 Has Three Equals Signs===
Adding a Page to the Docwiki
- 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]]
- Save the page.
- Click the (red) link to your new topic.
- Now you can start writing the new topic.
- At the top, add a parent tag (to provide the "Go Up to" link in the H2 help):
- {{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 khouser@embarcadero.com.
- At the bottom, add an optional See Also list:
- ==See Also==