User Tools

Site Tools


wiki_manual:create_a_wiki_page

Create a Wiki page

Hereinafter you can find a collection of useful information on how to create content in VieVS-Wiki.

Permissions and users' rights

Basically, the content of VieVS-Wiki is publicly available, without registration or logging on - everyone has read access.

To created or modify content in VieVS-Wiki, you need extended users' rights. Only registered VieVS-users get the right to create or modify pages. For more information on how to get VieVS and to become a VieVS-user follow the link: Get VieVS.

If you have already become a VieVS user, feel free to register to VieVS-Wiki. You find the Register button in the top right corner of this page. You will get a username and a password to logging in and the site admin will give you the rights to create and modify pages.

If there are any questions and/or suggestions, please use the contact form to contact the VieVS-Wiki admin.

General information - DokuWiki

VieVS-Wiki uses a highly versatile Open Source Wiki-Software, called DokuWiki. For more information on DokuWiki follow the link: DokuWiki

Wiki Manual

General DokuWiki manual

The official DokuWiki Manual is provided here: DokuWiki Manual.

:!: If you intend to use VieVS-Wiki (at least if you intend to create/modify pages), you should have a look at it!

There are also some useful screencast tutorials provided, which are especially recommended for first-time users. They show some first steps and basics (create links/pages, add pictures/files, etc…).

Formatting Syntax

DokuWiki supports some simple markup language for formatting the pages. A complete collection of all possible syntax you may use when editing the pages can be found on the official DokuWiki Syntax page.

Formatting mathematical expressions

VieVS-Wiki supports TeX(LaTeX)-syntax for mathematical expressions. For more information on the mathematics-syntax in TeX we refer to respective (online-)resources (e.g. Wiki books).

The TeX mathematics support is provided by a DokuWiki plugin called MathJax.

For more information on MathJax follow the link: MathJax. There you will find a Examples/Usage section, explaining some basics application rules.

VieVS-Wiki Formatting guidelines

To create a Wiki with a consistent appearance the users are asked to follow some formatting- and syntax-guidelines when creating or modifying or creating pages.

Text formatting

  • Italic text for
    • filenames (page1.txt),
    • filepaths (C:\vievs\work\),
    • etc…
  • Monospaced for
    • commands (e.g. …press Run + Save …)
    • etc…

Codes, monospaced text blocks

You can include code blocks (monospaced font, blanks are preserved) into your documents by either indenting them by at least two spaces or by using the tags <code> or <file>.

Some examples:

This is text is indented by two spaces.
<code>
First line:  This is preformatted code all spaces are preserved: like    <-this
Second line: This is preformatted code all spaces are preserved: like    <-this
</code>

⇒ Results in:

First line:  This is preformatted code all spaces are preserved: like    <-this
Second line: This is preformatted code all spaces are preserved: like    <-this
<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

⇒ Results in:

This is pretty much the same, but you could use it to show that you quoted a file.

Pagenames, namespaces and filenames

:!: For the designation of namespaces, pages and files always use:

  • lower case characters and
  • underlines (_) instead of blanks ( ) to separate words within the name.

:!: Always use descriptive names!

Namespaces

Information on namespaces in DokuWiki can be found in the DokuWiki manual. Namespaces are particularly important for the correct application of access control lists (ACL). With an ACL the site-admin controls the user-rights for different user-groups.

:!: The system of namespaces should establish a kind of a logical structure within the Wiki. Thematically related pages should be within the same (sub-)namespace. Therefore it is recommended to establish a new (sub-)namespace, if you create pages related to a new subject area.

Publically available content

Publically available content have to be in the main-namespace “public:”. In the this main-namespace further (“public”) sub-namespaces could be defined by using colons (“:”).

⇒ Examples:

  • public:vievs_manual:” defines the sub-namespace “vievs_manual:” within the namespace “public:”
  • public:vievs_manual:scheduling” defines the sub-namespace “scheduling:” within the namespace “public:vievs_manual:”
Internal content

There is also a main-namespace, which is only accessible by members of the VieVS-Members group: “internal:”.

Pagenames

The pagename (designation of a page within the Wiki-structure) should be equal, or at least similar to the first heading of the page.

⇒ Example:

public:vievs_manual:user_guide:gui_and_batch

The pagename is gui_and_batch and it is located in the namespace “public:vievs_manual:user_guide:”. The first Heading of the page is “GUI and Batch”.

Filenames

⇒ Example:

screenshot_gui_scheduling.png

Playground

You can use the Playground page to try out the the DocuWiki syntax without logging in. Feel free to play around!

:!: A screencast Tutorial can be found here: http://courses.web2teach.com/tutorial/links

External web pages as well as internal Wiki pages can be linked using the following syntax:

[[{URL or internal Doku-Wiki path}|{shown text}]]

The two pairs of square brackets mark a link. The target URL (for external web pages), or the internal Wiki path (full path: namespaces + page name) has to be written in the first part ({URL or internal Doku-Wiki path}), before the |. The text, which is shown and highlighted as link can be included in the second part ({shown text}).

Example 1: Link to another Wiki-page

[[public:vievs_manual:vievs_manual|VieVS Manual]]

Appearance on the wiki page:

VieVS Manual

Example 2: Link to external website

[[https://www.dokuwiki.org/features|Doku Wiki Features]]

Appearance on the wiki page:

Doku Wiki Features

If you want to refer to a particular headline within an internal Wiki-page, the following syntax can be used:

[[{URL or internal Doku-Wiki path}#{headline}|{shown text}]]

{headline} denotes the linked headline.

Example: Link to the headline History and technological developments on the page public:vlbi_fundamantals:introduction

[[public:vlbi_fundamantals:introduction#History and technological developments|Developments]]

Appearance on the wiki page:

Developments

Create a new Wiki page

To create a new Wiki page, just create an empty link to the non-existing page. The empty link appears in red color. If you click an the empty link, you will reach a new empty wiki page. Klick the Create page button on the right sidebar to finally create this page. Now the new page is ready to be edited and filled with contend.

:!: A screencasst tutorial is available under the following link: http://courses.web2teach.com/tutorial/creating_pages

References and bibliography

VieVS-wiki has a bibliography page to collect literature references.

Place the complete publication reference in the “Referenced publications” section on the bibliography page. Use the syntax as in the example below:

== Ray, 1999 ==
Ray, R.D. (1999). A global ocean tide model From TOPEX/Poseidon altimetry: 
GOT99.2. NASA Technical Memorandum TM-209478, 58.

By means of the headline == Ray, 1999 == you are able to cite from the bibliography entry by using the syntax for internal links to particular headlines:

...according to ([[public:bibliography#Ray, 1999|Ray, 1999]])...

…according to (Ray, 1999)…

Installed Plugins

The features of DokuWiki can be extended by installing plugins to the Wiki-software. A list of the user-relevant plugins is provided below:

  • MathJax: To be able to use LaTeX Synthax for math. expressions.
  • dw2pdf: To create PDF files from Wiki content.
  • bookcreator: To export Wiki pages as PDF or TXT file.
  • sortablejs: Can be used to sort tables.
wiki_manual/create_a_wiki_page.txt · Last modified: 2015/02/03 16:40 by admin