HowToWriteAwkiAwkiPages

HowToWriteAwkiAwkiPages is a small HOWTO based on that of John Mc Mahon (at http://awkiawki.bogosoft.com/cgi-bin/awki.cgi/HowToWriteAwkiAwki).

Some basic ideas on text editing under awkiawki

Contributors To This Document

  • John "Fuzz Face" Mc Mahon
  • Oliver Tonnhofer

Preface

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.

Regular Text

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.

HTML Tags

If you use HTML tags, AwkiAwki will ignore them. 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.

Links

Tags <A> and <IMG>

AwkiAwki creates links between AwkiAwki pages 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 there is another capital letter. For example, HowToWriteAwkiAwkiPages. Creating a new file is easy, add the link to the file your editing and save it. Then click on the link (the question mark generated after the new name). This will take you to the new, empty file. Then edit the new file and add your content. Note that when you view a page you have edited, you may have to refresh to see the latest changes. Note also that once you have placed content in a page, the link changes form a question mark to a standard HTML link. 

 How so if the Link is not recognized yet??

AwkiAwki will detect various types of URLs and turn them into clickable links. The link types it recognizes are http(s), ftp, gopher, mailto and news. All you have to do is type the URL and the 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.

Emphasis

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.

Header Lines

Tags <H2>, <H3>, and <H4>

Header lines are displayed by starting the line of text with a dash.

Example With One Dash <h2>

Example With Two Dashes <h3>

Example With Three Dashes <h4>

Horizontal Lines

Tag <HR>

Horizontal lines are displayed by having a line starting with four dashes.

like that

Monospace, Preformatted Text

Tag <PRE>

Normally, text is displayed and wrapped. If you want to display text preformatted, you need to prefix each line with a single space. Here is an example. Some Preformatted Text 

 * *   *
 * *
 ***   *
 * *   *
 * *   *

The Same Text Without The Prefix

* * * * * *** * * * * * * *

Lists

Tags <LIST>, <UL>, <OL>

Each element of an unordered (unnumbered) list is started with a TAB character and an asterisk.

  • I am the first line, I have a TAB and an asterisk
  • Second line
  • Manny
  • Moe
  • Jack
  • Last line

If your browser does 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.

  1. I am the first line, I have a TAB and the number 1
  2. Second line
  3. Steve
  4. Terri
  5. Wes
  6. Last Line

Nested lists are accompished by using multiple tabs.

  • One TAB and One Asterisk
    • Two TABs and One Asterisk
    • Two TABs and One Asterisk
    • Two TABs and One Asterisk
    • Two TABs and One Asterisk
  • One TAB and One Asterisk
  • One TAB and One Asterisk
    • Two TABs and One Asterisk
    • Two TABs and One Asterisk
      • Three TABs and One Asterisk
      • Three TABs and One Asterisk
  • One TAB and One Asterisk
  1. One TAB and One 1
    1. Two TABs and One 1
    2. Two TABs and One 1
    3. Two TABs and One 1
    4. Two TABs and One 1
  2. One TAB and One 1
  3. One TAB and One 1
    1. Two TABs and One 1
    2. Two TABs and One 1
      1. Three TABs and One 1
    3. Two TABs and One 1
  4. One TAB and One 1 
        1 Test Tab 1
             1 Test tab 2
BorneoCourse PageList RecentChanges PageHistory