How to Use this Wiki

What is a Wiki?

A Wiki is a special type of website that designed to enable anyone who accesses it to contribute or modify content, using a simplified markup language.

A single page in a wiki website is referred to as a “wiki page”, while the entire collection of pages, which are usually well interconnected by hyperlinks, is “the wiki”. A wiki is essentially a database for creating, browsing, and searching through information. “Wiki” (/wiːkiː/) is originally a Hawaiian word for “fast”.

In the early 2000s, wikis were increasingly adopted in enterprise as collaborative software. Common uses included project communication, intranets, and documentation, initially for technical users.

About this Wiki

I need a simple tool to help me to save information while I am surfing the website. It will essentially function as a personal notepad. After been with an online community for sometime, I learn to use their Wiki and found it to be an useful tool for online collaboration and knowledge management.

Hence I installed a Wiki on my website. Of all Wiki softwares, why Dokuwiki? Why not use MediaWiki? I will not state the reasons here but If you are interested, do read this article as well as this article.

How to Use this Wiki

All wiki pages at this wiki should be in Document Style. This will give all wiki pages a consistent look. You should familiarise yourself with the markup language used here. It is really simple to understand.

Page Style Guide

The wiki pages shall follow the following order:

  1. Page Title & Section Title
    The wiki page should have a title to identify it. We use the H1 markup for this. For sections, we use H2 markup. Sub-sections will use H3 and so on…

  2. Tagging
    All page must be tagged for easier searching of information and for SEO purposes.

  3. Editing Tips
    All pages must also include links to this page for reference purposes.

  4. Keywords
    Keywords used in the page must be included at this part for SEO purposes.

Document Template

Below is the markup template in accordance with the page style guide. Replace the text between [ and ] with the appropriate information. If you feel some sections is not usefull, feel free to delete it. Of course, you are free to add as much sections as you want :)

====== Page Title (H1) ======
[Contents Here]

===== Document Sections (H2) =====
[Contents Here]

==== Document Sub Sections (H3) ====
[Contents Here]


{{tag>Tags Here}} 

<note>
[[wiki:help|How to Use this Wiki]]
</note>

{{keywords>Keywords Here}} 

Documentation Plugins

The following documentation plugins are installed to extend the markup of dokuwiki to aid documentation and SEO.

  1. Tags
  2. Note
  3. Keywords

Tag Plugin

The Tag Plugin allows the assignment of category tags to wiki pages for categorization of wiki pages. Each tag will display a list of links to the tag pages in the tag namespace. Seperate each tag with a space.

Syntax:

{{tag>[list of tags]}}
[list of tags] a space separated list of tags that describe the content of the current page

Note Plugin

The Note Plugin allows you to insert pre-formated messages to your content/page.

Standard Notes:

This is usually used for general messages.

Syntax:

<note>
This is usually used in messages for general informing.
</note>

Important Notes:

This is used to highlight important messages to let readers know about the situation.

Syntax:

<note important>
This is used to highlight important messages to let readers know about the situation.
</note>

Tips:

This is used to share useful information with the readers.

Syntax:

<note tip>
This is used to share useful information with the readers.
</note>

Warning:

This is to warn readers of possible problems.

Syntax:

This is to warn readers of possible problems.

Keywords Plugin

The Keyword Plugin adds keywords used in the page content to the meta header, used by the web crawlers for the page indexing and categorization.

Syntax:

{{keywords>word1 word2 wordN}}
[List of Keywords] a space separated list of words that list the keywords of the current page

Examples:

  • {{keywords>word1 word2 wordN}}



This page is incomplete and is on the update list.

 
wiki/help.txt · Last modified: 2008/08/10 16:48 by admin