Help on Help - docwiki

From InterBase

Go Up to Help on Help


The online help of InterBase is available in an online wiki:

All InterBase 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 documentation@embarcadero.com.

  • 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:

 [[IBConsole]] = IBConsole

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 khouser@embarcadero.com.
    • 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.

Here are some examples:

IBConsole-related:

[[Category:IBConsole]]

Pages that are part of the Operations guide:

[[Category:Operations Guide]]

Pages that include an index of child pages:

[[Category:Topic Index]]


See Also