QwikiWiki - QwikiSyntax

:Qwiki Syntax Rules:
QwikiWiki uses its own syntax. It may seem terse and complex when
you read about it here, but it's reasonably easy to use in
practice.

<note /> For examples, see the source code that's shown at the end
of this document.

:Creating Headings:
This copy of QwikiWiki uses special rules for headings. There are two
ways to create a heading:

 1. Any line consisting of two or more upper-case words becomes a
heading.

 2. Alternatively, start with a line consisting of one or more
ordinary words. The first word must be capitalized. Put a colon at the
beginning of the line and another one at the end, and the line should
turn into a heading.

:Indentation:
Each line is indented as many times as there are spaces at the
beginning.

:Horizontal Bars:
To insert a horizontal separator, just enter a line of dashes or equals
signs. The line should contain at least 40 dashes or equals signs, and
it shouldn't contain anything else.

:Creating Lists:
Any line starting with a "bullet identifier" becomes a line in a list.
Bullet identifiers (including numbered and non-numbered) can be
mixed and matched at will. The supported bullet identifiers are as
follows:

? Question Mark (?): Creates a "question item"

! Exclamation Mark (!): Creates an "action item"

- Hyphen (-): Creates a hyphenated line

. Period (.): Creates a bulleted line

1. Number: Creates a numbered line. Any numbered line starting with one
resets the list counter. Lines starting with numbers other than one
are renumbered as necessary. Likewise, the list counter is reset with
every heading.

:Automatic Linking:
Text in a QwikiWiki page is scanned for several patterns, which
automatically produce links of the following types:

- Email addresses and DNS names become hyperlinks, as do URLs of the
form xxx://xxx@xxx.xxx?xxx

- Any word with "!CamelBack" capitalization (meaning "UPPERCASE
lowercase UPPERCASE lowercase" etc) becomes a link to a page with its
corresponding name, such as QwikiWiki.

  ! Note: You can disable this on a per-instance basis by prefacing
the word with an exclamation point (!), or by adding the word to the
#'ignoreQwikiTagArray'# variable in #_config.php#.

- Any group of words surrounded and separated by underscores (_)
becomes a link to a page with its corresponding name, such as _Home_

:Formatting Notes:
- Words surrounded by asteriks (*) become *bold*
- Words surrounded by forward-slashes (/) become /italicized/
- Words surrounded by pound-signs (#) are shown as #code#

:HTML Notes:
- QwikiSyntax and HTML can be freely intermixed, though care must be
taken to avoid conflicting with the other automated markup rules.

  ! Note: To insert HTML code that should be visible to the user, be
sure to replace the '<' and '>' with '&lt;' and '&gt;',
respectively,

- Text surrounded by <HTML> and </HTML> tags will be
ignored by QwikiWiki and passed to the browser without alteration.

  ! Note: For security reasons, only a subset of HTML tags are allowed
in QwikiWiki pages. The specific tags allowed are specified by the
administrator.

:Attached Files and Images:
If enabled by the QwikiWiki administrator, you can upload and "attach"
files to each page.  Attached files are stored in a page-specific
subdirectory, and can be linked to from within the page by simply
typing its filename into the page text.  If the attached file is an
image type (GIF, JPG, PNG), it is inserted directly rather than linked
to.
  ! Note: Only certain file types can be attached, as specified by the
QwikiWiki administrator.  Click *Help* when editing a page to see the
complete list of acceptable file types.

:Special Tags:
<emphasis>Optional:</emphasis> If you're comfortable with HTML,
you can use the following special tags:

 &LT;maintitle&GT;Hello, World&LT;/maintitle&GT; - Inserts a main title.
For example:
 <maintitle>Hello, World</maintitle>

 &LT;emphasis&GT;Monday&LT;/emphasis&GT; - Like &LT;em&GT; but colored:
<emphasis>Monday</emphasis>

 &LT;note /&GT; - Inserts the word <note />

 &LT;note&GT;Important:&LT;/note&GT; - Displays other text using same font
as &LT;note /&GT;
 For example: <note>Important:</note>