===== General rules for creating the ZMITAC DokuWiki document. v.1.0 =====

 

==== Overview ====

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.

===== Chapters and headers =====

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

<code>===== Title =====</code>

 

==== Subchapter ====

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

<code>==== Subchapter ====</code>

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 ====

References should appear in the text as footnotes. <note warning>This is subject to change in case we employ working plugin for DokuWiki that let us introduce IEEE-style references.</note>

<code>((Reference))</code>

==== Figures ====
Figures with their captions should be placed using the [[http://www.till-biskup.de/de/software/dokuwiki/caption|Caption plug-in]], i.e.: 
<figure RefPic1>
{{:edu:zmitac:en:zmitaclogo.jpg?nolink&200 | This is ZMITAC logo}}
<caption>ZMITAC Logo - this is caption</caption>
</figure>
If picture is too small to be seen inline then use link opening it as separate page, otherwise use //nolink//.
<code>
<figure RefPic1>
{{:edu:zmitac:en:zmitaclogo.jpg?nolink&200 | This is ZMITAC logo}}
<caption>ZMITAC Logo - this is caption</caption>
</figure>
</code>
Internal references to figures should be done with the figure number using [[http://www.till-biskup.de/de/software/dokuwiki/caption|Caption plug-in]] sytnax, i.e.:
As shown on Figure {{ref>RefPic1}}
<code>
Figure {{ref>Ref.Pic.1}}
</code>
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 ====

Tables with their captions should be placed using the [[http://www.till-biskup.de/de/software/dokuwiki/caption|Caption plug-in]]: 
<table Ref.Tab.1.1>
<caption>caption</caption>
^ Header 1 ^ Header 2 ^
| cell 1 | cell 2|
| cell span ||
</table>
and refereed in text same mechanism as figures i.e.: “as shown in Table {{ref>Ref.Tab.1.1}}”.
<code>
<table Ref.Tab.1.1>
<caption>caption</caption>
^ Header 1 ^ Header 2 ^
| cell 1 | cell 2|
| cell span ||
</table>
</code>
==== Equations ====

Mathematical equations are supported via [[https://www.dokuwiki.org/plugin:mathpublish|Mathpublish plugin]]. 

To toggle the Math mode use <nowiki><m> ... </m></nowiki> tags. The math commands must be separated by a space character or surrounded by {}, i.e.:
<m 18> E=mc^2 </m>
<code>
<m 18> E=mc^2 </m>
</code>
Equation alignment is given by front, end or both spaces, as images. A 18 number by the <nowiki><m 18></nowiki> tag is a font size.
==== Code ====

Code examples write within tags

%%<code>...</code>%%

<file>

<code c>

Code example here

</code>

</file>

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

<code>’’printf(“something”);’’</code>

 

==== Important information ====

Tips, warnings, tricks and important facts should be introduced using [[https://www.dokuwiki.org/plugin:note|note plugin]], classified as: 

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

as below:

<code>
<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>
</code>

==== Description of programming environment ====

=== Navigating in the menu ===

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

 

<code>//home/file/open//</code>


=== Buttons ===

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

**[open]**

<code>
**[open]**
</code>

 

=== Variables ===

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

<code>//variable//</code>

 

==== Citing ====

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

==== Comments in the pages ====

When yo need some text to be hidden for audience but let it exist there, use [[https://www.dokuwiki.org/plugin:comment|comment plugin]], similar to the source code comments.
Simply put the text of the comment between slash-asterisk and asterisk-slash combination:
<code>
This is an example of the sentence whereas /*this text*/ is hidden
</code>
This is an example of the sentence whereas /*this text*/ is hidden