Acrocat.com < Products < AcroWiki < Wiki Syntax

AcroWiki for Palm OS

- Font styles
- Separator
- Heading levels
- Lists
- Numbered list
- Bulleted list
- WikiWord links
- WikiWord syntax
- Forced links
- Named links
- URL linksĀ 
- Email links
- Disabling AcroWiki syntax
- Particular syntax construct

only $15.00
Palm OS
10 day fully functional trial 
Free demo 

The AcroWiki syntax is very straightforward. In most cases text appears pretty much the same as what you see when you write. Single line feeds are ignored, while double line feeds are used to mark paragraphs.

If you want to show the text in a boldface font, simply enclose it with asterisks. Here are some examples of the available styles:


 

To draw horizontal lines (separators), simply enter three minus signs at the beginning of the line, like this:


 

You can organize your text into sections, giving each its own heading. Each heading has a "level", with one being highest (which is usually the title of the document, and smaller levels for subsections. To create a heading, just start a new line with three minus signs and one or more plus signs (the more plus signs, the greater the heading level). For example:


 
Lists  

Numbered list

Another useful syntax construct are lists. To use numbered lists, just enter 3 spaces followed by an arbitrary number. You do not need to worry about the number order, AcroWiki will renumber the items for you, starting from 1. Usually, it is enough to use same number (e.g. 1) for all of the items. For example:


As you can see in example above, list elements could contain sub lists.

 

Bullet lists are pretty much the same, except an asterisk ("*") should be used instead of the line number.


 

WikiWord syntax

Now for the most exiting part: linking. Each AcroWiki document has a name, which is usually in the WikiWord format. The WikiWord format is exactly what it looks like: two or more words merged together with the first letter of each word capitalized. Some examples of valid WikiWords:


Once you enter a WikiWord in your document, AcroWiki will automatically show it as a link to the appropriate Memo. There is an option in the preferences which will add question marks at the end of any invalid links or words to indicate that the link is broken. Tapping on the link to a non-existent memo will automatically invoke the AcroWiki editor, create the memo and allow you to start editing it.

 

What if you want to name your document something which does not fit into the WikiWord syntax? For example, a phrase with spaces inside, or text in lower case? No problem, you can force it to be recognized as a link by enclosing it in double square brackets. For example:


 

Also, in your document you can force the link to be displayed with a different name than the one it links to. For example:


This link will now be shown in your document as "Display Name", not as "WikiWord".

 

Sometimes you may want to reference external documents. You can do this by using forced links (named or unnamed) with a URL. Some examples:


 

The first one will be shown as "http://www.Acrocat.com/" while the second one will be displayed as "Acrocat Software". Besides HTTP, HTTPS, and FTP links, AcroWiki also recognizes MailTo URLs. For example:


Clicking on a MailTo link will cause your default mail application to open and allow you to compose your message with the specified e-mail address pre-filled in.

Other types of links will launch your default web browser.

If AcroWiki does not automatically recognize your browser and mail program type, you can specify them in the Preferences dialog.

 

Last, but not least: you can choose to disable the AcroWiki syntax in individual cases, by simply pre-pending it with the <n o p%gt; prefix. For example:


That's it! Once you learn this easy syntax you will find that writing documents using AcroWiki is very fast and easy. As they say in Hawaiian: "Wiki-Wiki"!

 

only $15.00
Palm OS
10 day fully functional trial 
Free demo