Formatting Rules

From the Tcl'ers Wiki [1]:


References:

  1. You can refer to another page by putting its name in square brackets like this: [PAGE]
  2. URLs will automatically be recognized and underlined: http://your.site/contents.html
  3. If you put URLs in square brackets, they'll be shown as a tiny reference [2] instead.(In this situation, the system assumes that any url ending in .jpg, .png, or .gif is an image and displays it inline.)
  4. URL methods recognized are:

Adding highlights:

Adding structure to your text:

  1. first numbered bullet
  2. second numbered bullet
tag
text
tag
text2
 All other lines beginning with white space are shown as is
 - no highlighting, reference generating, or even text wrapping occur.

Note: there's no way YET to undo or go back in history once changes are saved


To get more than one highlight on a single line, you can use returns to break the line in separate physicial lines. WiKit will concatenate them all into one. So if you do this (without indents):

   I'm going to ''draw''
   your ''attention''.

You'll end up with: I'm going to draw your attention.

It usually works (for non-pathological cases) just fine if you put everything on a single line. Experiment on the Graffiti page if you want to check whether anything in particular will work.


Using brackets in your text can be done by doubling them, so [[ shows as [.


AK, Mar 24, 1999: I'll try to explain the above in a more verbose and different way:

  1. Wiki text is seen as one of 3 types of lines: Normal, Indented, or Special lines.
  2. Normal lines are sentences which start in the first column. A series of sentences without intervening newlines, empty, indented or special lines is displayed as a paragraph and always rendered as one logical line. It is left to the browser to wrap this logical line according to the screen or window width. Embedded page and url references are detected and rendered appropriately.
  3. Indented lines are text lines indented by spaces and/or tabs, and are always rendered as single lines. A writer who wants to control the exact setting of newlines has to indent each section of text by at least one space or tab. The disadvantage is that embedded references and italic/bold markings are not recognized. The primary purpose for indented lines is the embedding of scripts and other verbose information into a page.
  4. Special lines are recognized through the usage of special patterns at the beginning of a line. These were explained above. They are always rendered as single lines (possibly wrapped by the browser), but without surounding vertical whitespace (in contrast to 2 and 3). Multiple newlines between special lines are simply gobbled. The only way to introduce separation is by usage of horizontal rules, normal or indented lines. Special lines always form a paragraph by themselves. Cutting a special line into multiple physical lines creates during rendering one special line and one or more paragraphs from the rest, depending on the indentation.

Category Wiki