GOPHERSPACE.DE - P H O X Y
gophering on raymii.org
This is a text-only version of the following page on https://raymii.org:
---
Title       :  Introduction to DokuWiki
Author      :  Remy van Elst
Date        :  15-06-2011
URL         :  https://raymii.org/s/tutorials/Dokuwiki_Overview.html
Format      :  Markdown/HTML
---



DokuWiki is a standards compliant, simple to use Wiki, mainly aimed at creating
documentation of any kind. It is targeted at developer teams, workgroups and
small companies. It has a simple but powerful syntax which makes sure the
datafiles remain readable outside the Wiki and eases the creation of structured
texts. All data is stored in plain text files no database is required.

 Consider sponsoring me on Github. It means the world to me if you show you
r appreciation and you'll help pay the server costs.

 Y
ou can also sponsor me by getting a Digital Ocean VPS. With this referral link you'll get $100 credit for 60 days. 
 >


Nowdays it can be used for a lot of things, like a wiki, note taking, podcast
show notes, collaborative note taking and a lot more.

[Official website of DokuWiki][2]

#### Key features of DokuWiki

##### Revision control

DokuWiki stores all versions of each wiki page, allowing the user to compare the
current version with any older version. The difference engine is the same as the
one used in MediaWiki. Parallel editing of one page by multiple users is
prevented by a locking mechanism.

##### Access control

Access control can be handled by a user manager which allows users and groups of
users to be defined, and an access control list where an admin user can define
permissions on page and namespace level, giving it much better access control
than Mediawiki.

##### Plugins

DokuWiki has a generic plugin interface which simplifies the process of writing
and maintaining plugins. There are over 750 plugins available. These can be
easily integrated and managed by an admin user with the help of the plugin
manager.

##### Templates

The appearance of the wiki can be defined by a template. There are templates to
make it resemble a MediaWiki site, or a popular blogging platform and more.

##### Internationalization and localization

DokuWiki supports Unicode (UTF-8), so languages such as Chinese, Thai, and
Hebrew can be displayed. DokuWiki can be configured in about 40 languages.

##### Caching

DokuWiki stores the rendered output of parsed wiki pages to reduce server load.

##### Full text search

DokuWiki has an integrated indexed search with which a user can search for
keywords on the wiki.

#### Other very handy and interesting features

  * Content can be categorized in namespaces, easily browsable through an automatic index
  * Uploading and embedding of images and other media (images, PDF, music or anything)
  * Unlimited page revisions
  * Overview of Recent changes
  * Colored side by side diff support
  * Section Editing allows editing of small parts of a page (a feature I use very much)
  * Authentication Backends for integrating with LDAP, MySQL, Postgres and others 

#### Syntax

Below I'll give some examples of the Dokuwiki Syntaxis.

[Official Syntax Reference can be found here][3]

[Here is a good page with Tips and Tricks for DokuWiki][4]

##### Headers

    
    
    ====== This is H1 ======
    ===== This is H2 =====
    ==== This is H3 ====
    === This is H4 ===
    == This is H5 ==
    

##### Unordered Lists

Type two spaces and then a star: `*`

    
    
      * first
      * second
        * sub-list
        * sub-item 2
      * third
    

##### Ordered Lists

Type two spaces and then a dash: `-`

    
    
      - first ordered
      - second ordered
        - first sub-ordered
      - third item
    

##### Quotes

    
    
    I say this
    > I agree with that
    >> Well, I do not.
    > Why not?
    Yeah, why not?
    

##### Images

    
    
    Real size:                        {{wiki:dokuwiki-128.png}}
    Resize to given width:            {{wiki:dokuwiki-128.png?50}}
    Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
    Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}
    

Alignment via left or right whitespaces (or both for center):

    
    
    {{ wiki:dokuwiki-128.png}}
    {{wiki:dokuwiki-128.png }}
    {{ wiki:dokuwiki-128.png }}
    

##### Horizontal Lines

    
    
    ---
    

##### Tables

    
    
    ^ Heading 1      ^ Heading 2       ^ Heading 3          ^
    | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
    | Row 2 Col 1    | some colspan (note the double pipe) ||
    | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
    | Row 4 Col 1    |                 | Row 4 Col 3        |
    

##### References & Footnotes

Are done by `((This is a footnote))` using double parentheses.

##### Links

###### Internal Links

Done via `[[pagename]]` or `[[pagename|Page Title]]`.

If you have a namespace: `[[namespace:second:page|NameSpace Name]]`.

###### External Links

automatically recognized by dokuwiki via: http://www.google.com or
www.google.com

With links title: `[[http://www.google.com|This link goes to Google]]`

Email addresses: `<spambox@emaildomain.org>` are converted to mailto:
links.

   [1]: https://www.digitalocean.com/?refcode=7435ae6b8212
   [2]: http://www.dokuwiki.org
   [3]: http://www.dokuwiki.org/syntax (Official Dokuwiki Sytnax)
   [4]: http://www.dokuwiki.org/tips (Tips for Dokuwiki)

---

License:
All the text on this website is free as in freedom unless stated otherwise. 
This means you can use it in any way you want, you can copy it, change it 
the way you like and republish it, as long as you release the (modified) 
content under the same license to give others the same freedoms you've got 
and place my name and a link to this site with the article as source.

This site uses Google Analytics for statistics and Google Adwords for 
advertisements. You are tracked and Google knows everything about you. 
Use an adblocker like ublock-origin if you don't want it.

All the code on this website is licensed under the GNU GPL v3 license 
unless already licensed under a license which does not allows this form 
of licensing or if another license is stated on that page / in that software:

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see .

Just to be clear, the information on this website is for ment for educational 
purposes and you use it at your own risk. I do not take responsibility if you 
screw something up. Use common sense, do not rm -rf / as root for example. 
If you have any questions then do not hesitate to contact me.

See https://raymii.org/s/static/About.html for details.