== Some Pointers and Tips for Using Kwiki

=== What is a Wiki?
"Wiki" comes from the Hawaiin "wikiwiki" meaning fast.  A Wiki is a community edited document that uses a simplified markup language to allow quick, collaborative editing.  This Wiki (perl-based "Kwiki") includes features that allow viewing of revisions, attachment of files and other things that ease create of your documentation.

=== How do I [make a heading | include an image | make a link | etc...]?
You can find an extensive list of markup notation, with examples, [here http://www.kwiki.org/?KwikiFormattingRules].

You can read about how !WikiLinks work [here http://www.kwiki.org/?WikiLinks].

You can read about how to get around your Wiki [here http://www.kwiki.org/?KwikiNavigation].

The attachments feature includes its own special notation that allows you to incorporate the upload in the page, or provide a link to the upload.  Note: there will always be a link to the uploaded file at the right margin of the page.

The module provides 3 tags which can be used to link to or display attachments in a Kwiki page.

 {file:[page/]filename}       creates a link to attachment filename.

 {img:[page/]filename}        displays attachment filename.

 {thumb:[page/]filename}      displays the thumbnail for attachment filename.

To attach a file simply click on the Attachments link on any page and complete the form.

=== General Tips

* When editing a page, make extensive use of the PREVIEW button.   Each SAVE makes a revision which is great to get back to older versions but annoying when someone used SAVE instead of PREVIEW.
* Kwiki's markup language is LIMITED.  This is intentional.  Instead of fighting with it /use/ it to speed up creating pages.  This means not spending time playing with layout when you should be writing!  You will find that perfectly acceptable pages are possible using what Kwiki offers.
* Review the [markup page  http://www.kwiki.org/?KwikiFormattingRules] and refer to it often.  Making the most of Kwiki means understanding what it can do.

== Getting Help

If you can't make Kwiki do something you think it should do, or you think it is just plain broken, email kwiki-support@ee.nd.edu and include a complete description of the problem.