User Tools

Site Tools


processes:dokuwiki

01 Dokuwiki

A wiki allows collaborative modification, extension, or deletion of content and structure. Typically, it is a web application, and text is written using a simplified markup language. DokuWiki is a simple to use and highly versatile Open Source wiki software.

Dokuwikis web-based nature allows us to provide information in a very accessible way. It also enables effortless collaboration with project-specific information, giving you equal opportunity to create and consume information.


Structure

Our Dokuwiki is structured into four sections:

Processes

Covers information on how you can collaborate with us.

Code

Contains information on our public, open-source offerings (see also opensource.hampel-soft.com) and our commercial offerings.

Knowledge Base

Contains various information on all sorts of topics related to our work.

Projects

Holds project-specific information like protocols, descriptions, manuals… Access only with customer-specific user credentials.


How to edit content

Edit existing content: If you have sufficient rights to edit a page, you find a little pen icon to the right of the page. If you hover over it with your mouse arrow, it changes into a “Edit this page” link:

Create a new page: Just type the URL that you want the new content to have into the address bar of your browser and load that new page. On the new page, the “Edit this page” link will change into a “Create this page” link.

Note: To edit existing contents or create new ones, you have to have sufficient user rights.

Edit mode

In edit mode, a big form field is displayed. You can type your content into it and commit changes by clicking the “Save” button below it.

Syntax

DokuWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages.

PlantUML

Our Dokuwiki also supports generating PlantUML diagrams from markdown syntax. An example:

  <uml>
  @startuml
  hide empty description
  [*] --> State1
  State1 --> [*]
  State1 : this is a string
  State1 : this is another string
  
  State1 -> State2
  State2 --> [*]
  @enduml
  </uml>

is represented as

State1this is a stringthis is another stringState2

another useful presentation for folders and files:

RepoRootbuildsapplicationdistributioninstaller

More information on the UML syntax can be found at https://plantuml.com/

User Manual

The user manual is intended to be the extended resource for all standard questions on using DokuWiki. It includes information useful for “standard” users up to administrators who want to configure and run their own wiki installation.

DokuWiki API

There is a XML RPC API implemented and a JSON RPC API is available as plugin.

processes/dokuwiki.txt · Last modified: 2022/07/21 20:11 by joerg.hampel