This document was created with awkiawki using only the source code of the program to identify features. To understand how awkiawki works, first read this document... then open it in the awkiawki editor to see what the file looks like and how it was formatted.
The simplest thing to do in awkiawki is to just enter regular text. There is no magic needed. Just edit the file and enter your text.
If you know HTML, awkiawki will ignore it. The goal here is to allow simple text editing that the parser converts to nicer-looking HTML pages. Obviously, if you know HTML, using awkiawki is sort of a step backwards. But, if you need something quick that non-technical people can learn, this is your environment.
You will notice HTML tags listed in the following examples. This is to allow folks who know HTML to easily figure out how to write something in awkiawki.
Tags <A> and <IMG>
awkiawki creates links between awkipages in the awkiawki file system. A link is created when a single word starts with a CAPITAL letter followed by a lowercase letter, and somewhere in the rest of the word the pattern is repeated. Some examples include KiSs?, McMahon?, FuzzFaceQ?. Creating a new file is easy, add the awkiawki link to the file your editing and save it. Then save the file and click on the link. This will take you to the new, empty file. Then edit the new file and add your content.
awkiawki will detect various types of URLs and turn them into clickable links. The link types it recognizes are http, ftp, gopher, mailto and news. All you have to do is type the URL and the awkiawki parser will turn it into a clickable link.
If the link is an image file like a jpeg, jpg, gif or png the parser will include the image on the finished page. If you would prefer to just provide a link to the image, use six single-quotes behind the image suffix.
Use six single-quotes to prevent mix upper-lowercase words to become a wiki link.
Tags <STRONG> and <EM>
Surrounding text in 'single quotes' can be used for emphasis. One set of quotes is displayed normally. Two sets of quotes is displayed in emphasis font. Three sets of quotes is displayed in strong font.
Tags <H2>, <H3>, and <H4>
Header lines are displayed by starting the line of text with a dash.
Tag <HR
Horizontal lines are displayed by having a line starting with four dashes.
Tag <PRE>
Normally, text is displayed and wrapped. If you want to display text performatted, you need to prefix each line with a single space. Here is an example.
* * * * * *** * * * * * * *
* * * * * *** * * * * * * *
Tags <LIST>, <UL>, <OL>
Each element of an unordered (unnumbered) list is started with a TAB character and an asterisk.
If your browser dös not allow you to type TABs, you can substitute eight spaces. Just remember to click the editor box that reads Convert runs of 8 spaces to Tab.
Each element of an ordered (numbered) list is started with a TAB character and the number 1.
Nested lists are accompished by using multiple tabs.