This is an old revision of the document!
The table of contents page for a book has all the linked pages that the book will use for it's materials. If a page is not linked in there it will not appear in the book.
To exclude a page in the book simply remove it from the ToC or if you want to keep it in the ToC then put the page between
<del> </del>
tags and it will not show up in the book.
Example:
Chapter 3
<del> Chapter 3 </del>
More of this under the "Comments in the pages" guidelines.
Place top chapter (header level 1) title in six equation chars:
====== Title ======
Note, first chapter level on the page should correspond with ToC indentation as in case Dokuwiki page is part of the book.
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).
ToC: Level 1 (page 1, first chapter no 1) Level 1 (page 2, first chapter no 2) - Level 2 (page 3, first chapter no 2.1) - Level 2 (page 4, first chapter no 2.2) - - Level 3 (page 5, first chapter no 2.2.1) - Level 2 (page 6, first chapter no 2.3) - - Level 3 (page 7, first chapter no 2.3.1) - - Level 3 (page 8, first chapter no 2.3.2) - - Level 3 (page 9, first chapter no 2.3.3) Level 1 (page 10, first chapter no 3) --------------------------------- Page 1: ====== Header level 1 (1.) ====== Page 2: ====== Header level 1 (2.) ====== Page 3: ===== Header level 2 (2.1.) ===== Page 4: ===== Header level 2 (2.2.) ===== Page 5: ==== Header level 3 (2.2.1.) ==== Page 6: ===== Header level 2 (2.3.) ===== Page 7: ==== Header level 3 (2.3.1.) ==== Page 8: ==== Header level 3 (2.3.2.) ==== Page 9: ==== Header level 3 (2.3.3.) ==== Page 10: ====== Header level 1 (3.) ======
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 Ref.Pic.1> {{ :logotyp_1_-_fb_-_square.png?nolink&200 | This is IOT-OPEN.EU logo}} <caption>IOT-OPEN.EU Logo</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.
{{:en:iot-open:remotelab:sut:iotrx.jpg?470|}}
Because we intend to use portrait rather than landscape layout in printed books, please consider preparing diagrams as landscape ones rather than portrait. Eventually, portrait diagrams, images and graphics could be rotated 90 degrees counter-wise, to fit into the printing layout.
Tables with their captions should be placed using the Caption plug-in:
Header 1 | Header 2 |
---|---|
cell 1 | cell 2 |
cell span |
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 should be inserted as figures and referenced as figures.
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 you need some text to be hidden for the 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
If you need to exclude some section from PDF printed book file, use
<hidden>excluded section</hidden>
If some chapters needs to be exclude use del tag
<del> </del>