HAMPEL SOFTWARE ENGINEERING

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== 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.

---- 

===== Copy, Link, Share! =====

**Feel free to copy from or link to our Dokuwiki - this is the reason for it being public in the first place!**
 
<WRAP center round box 100%>
Except where otherwise noted, content on this wiki is licensed under the following license: [[https://creativecommons.org/licenses/by-sa/4.0/deed.en|CC Attribution-Share Alike 4.0 International]]

You are free to:

  * Share — copy and redistribute the material in any medium or format for any purpose, even commercially.
  * Adapt — remix, transform, and build upon the material for any purpose, even commercially.
  * The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms:

  * Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
  * ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
  * No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
</WRAP>

We are committed to maintaining this wiki for current and future generations of LabVIEW developers and the NI ecosystem. Unless absolutely necessary, we will not change any URLs so that your deep-links will never break. 

---- 

===== Wiki 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 [[http://opensource.hampel-soft.com|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:

|{{:processes:how-to-edit.png?nolink|}}|

**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.

|{{:processes:how-to-new-url.png?nolink|}}|

|{{:processes:how-to-create.png?nolink|}}|

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.

|{{:processes:how-to-editor.png?direct&600|}}|

==== Syntax ====

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


==== User Manual ====

The [[https://www.dokuwiki.org/manual|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.

  * [[https://www.dokuwiki.org/devel:xmlrpc]]
  * [[https://www.dokuwiki.org/plugin:jsonrpc]]


---- 

<WRAP left round help 100%>
For HSE internal structures, there is more documentation available at \\
''Organisation -> KB (internal) -> IT -> Dokuwiki'' [[organization:internal-kb:it:dokuwiki|Dokuwiki]]
</WRAP>

---- 

<WRAP center round tip 100%>
More details about creating content for our Dokuwiki can be found in our [[kb:bestpractices:documentation:wiki|Documentation Better Practices]] section.
</WRAP>