Table of Contents
DokuWiki (info.gwdg.de)
Effective: kgermer 2015/01/22 17:02
This wiki intends to gather instructions needed to use the official GWDG services. The services themselves, will be presented in detail via portal.gwdg.de.
(Additional tips and tricks shall be placed on faq.gwdg.de.)
There exist two areas in this wiki: one publicly accessible (services) and a hidden draft space. A manual can be prepared in that (draft) section.
(The wiki is bi-lingual. The display can be switched between English (en) and German (de) language.)
Instructions
Log in with your GWDG UID and the corresponding LDAP password.
(You must be logged in to create/modify content within the wiki, or to search/access restricted/hidden pages.)
navigate
One can easily navigate within the wiki via the services sidebar on the left, or the breadcrumbs ('You are here:') and trace options.
search content
Search is done through the search box. Dokuwiki performs logical AND search (all words will be used). Details about the capabilities: https://www.dokuwiki.org/search.
create pages
The easiest way to create a new page, is to edit (pencil icon) a existing page and put an internal wiki link into it. Like this:
[[page_name|alternative name]]
Save, click on that link and edit the new page.
(Page names should be short and representative.)
(Created pages within services, will be added automatically to the navigation sidebar. The first heading of a page will be the title of this entry.)
edit content
Select the page you want to edit and alter it's content. The syntax is plain simple. A description can be found by clicking on syntax in edit mode or online: https://www.dokuwiki.org/wiki:syntax
(In order to avoid conflicts, when multiple users try to edit the same page at the same time, the wiki locks the page you are editing.)
(A table of contents will be shown automatically, if more than two headings are defined.)
Content within the service section have to be correct, up-to-date and in a compact form. English language is mandatory, a German version is optional.
upload media
You can use several media files for your manuals. Just upload them via Media Manager to a suitable namespace and embed them to your page via the image icon in edit mode.
(If you plan to use screenshots, mind that they are useful and not too much of them. Make sure that the text instructions itself, can fully be understandable without them (accessible)).
move pages
Since this is a wiki, unfortunately a simple move page from a to b doesn't exist. So one has to copy/paste the whole content in edit mode, get to the new page, paste it and save.
delete pages
To delete a page, simply select and remove all content in edit mode an save.
restore pages
To restore a messed up or deleted page to a prior version, please click on the clock icon and select a prior version. Enter edit mode and save.
(A diff between two version can also be displayed.)
References
- GWDG Dokuwiki, https://info.gwdg.de
- Dokuwiki drafts, https://info.gwdg.de/dokuwiki/doku.php?id=en:drafts:start
- Dokuwiki syntax, https://info.gwdg.de/dokuwiki/doku.php?id=wiki:syntax
- Dokuwiki features, https://www.dokuwiki.org/features
- Dokuwiki manual, https://www.dokuwiki.org/manual (multilingual)