RAU6 Dokuwiki

Those are hints for authors. Use with care . Following this guide may simply introduce you to the Dokuwiki capabilities along with this special installation that covers extra plugins like Captions with references and automated numbering, math equations, etc.

Place top chapter (header level 1) title in five equation chars:

===== Title =====

Subchapters of first level (header level 2) need four equation marks, second level (header level 3) – three and so on:

==== Subchapter ====

Do not use any font modifiers to the title. We assume that three levels of subchapters should be enough (four total, including top level chapter).

References should appear in the text as footnotes.

((Reference))

Figures with their captions should be placed using the Caption plug-in, i.e.:

If picture is too small to be seen inline then use link opening it as separate page, otherwise use nolink.

<figure RefPic1>
{{:edu:zmitac:en:zmitaclogo.jpg?nolink&200 | This is ZMITAC logo}}
<caption>ZMITAC Logo - this is caption</caption>
</figure>

Internal references to figures should be done with the figure number using Caption plug-in sytnax, i.e.: As shown on Figure 1

Figure {{ref>Ref.Pic.1}}

Note - when you insert a new figure, you must give it an unique name, here Ref.Pic.1, right by the HTML tag figure (default is label) then you can refer to is as in regular HTML.

Tables with their captions should be placed using the Caption plug-in:

and refereed in text same mechanism as figures i.e.: “as shown in Table 1”.

<table Ref.Tab.1.1>
<caption>caption</caption>
^ Header 1 ^ Header 2 ^
| cell 1 | cell 2|
| cell span ||
</table>

Mathematical equations are supported via Mathpublish plugin.

To toggle the Math mode use <m> ... </m> tags. The math commands must be separated by a space character or surrounded by {}, i.e.: <m 18> E=mc^2 </m>

<m 18> E=mc^2 </m>

Equation alignment is given by front, end or both spaces, as images. A 18 number by the <m 18> tag is a font size.

Code examples write within tags

<code>...</code>

<code c>

Code example here

</code>

Part of the code placed in the text like_this_function(var arg) should be written as monospace text within double apostrophes

’’printf(“something”);’’

Tips, warnings, tricks and important facts should be introduced using note plugin, classified as:

as below:

<note>regular note on something</note> 
<note warning>warning information</note> 
<note tip>some useful tip for reades</note>  
<note important>and some important information</note>

While you write about menu options in software applications – write names of options in italic, i.e. like this one home/file/open

Option and suboption chains write with “/” (slash) character

//home/file/open//

Write names of the buttons in square brackets, in bold.

[open]

**[open]**

Names of variables referred from the program code write in italic, i.e. Integer val1.

//variable//

Whole sentences cited write within parenthesis “I love DokuWiki.”, simply by:

“I love DokuWiki.”

When yo need some text to be hidden for audience but let it exist there, use comment plugin, similar to the source code comments. Simply put the text of the comment between slash-asterisk and asterisk-slash combination:

This is an example of the sentence whereas /*this text*/ is hidden

This is an example of the sentence whereas is hidden