This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:iot-open:rules [2021/03/25 08:04] – [Important information] admin | en:iot-open:rules [2023/11/21 15:54] (current) – [Comments in the pages] pczekalski | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== General rules for creating the IoT-OPEN.EU DokuWiki document. v.1.3 ===== | + | ====== General rules for creating the DokuWiki-based books. v.1.5 ====== |
- | + | ===== Table of Contents ===== | |
- | ==== Overview ==== | + | A book's table of contents page has all the linked pages it will use for its materials. If a page is not linked in there, it will not appear in the book. |
+ | <note important> | ||
+ | <note warning> | ||
- | The IO1 results will be created in DokuWiki so it’s syntax would be used for document formatting. Here we provide the rules for elements of the documents created. | ||
- | ===== Chapters and headers ===== | + | ==== Exclude a page ==== |
- | Place top chapter (header level 1) title in six equation chars: | + | 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 < |
- | < | + | Example: |
- | Note, first chapter level on the page should correspond with ToC indentation as in case Dokuwiki page is part of the book. | + | < |
- | + | < | |
- | ==== Subchapter ==== | + | More of this is under the [[https:// |
- | Subchapters of first level (header level 2) need four equation marks, second level (header level 3) – three and so on: | + | ===== Chapters |
- | < | + | Place the top chapter (header level 1) title in six equation chars: |
- | 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). | + | < |
+ | Each page should start from the highest chapter level. The PDF book generator will automatically shift it down by the starting position, e.g.: | ||
- | <note important> | + | 1. Introduction (page1) |
- | < | + | 1.1 Definition |
- | ToC: | + | |
- | Level 1 (page 1, first chapter no 1) | + | page1 starts with:\\ |
- | 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) | + | |
- | --------------------------------- | + | page2 starts with:\\ |
+ | < | ||
- | Page 1: | + | <note warning> |
- | ====== | + | This is particularly important when using < |
+ | ==== Subchapter | ||
- | 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.) ====== | ||
- | |||
- | </ | ||
</ | </ | ||
- | <note warning> | + | <note warning> |
===== References ===== | ===== References ===== | ||
- | References should appear in the text as footnotes. <note warning> | + | References should appear in the text as footnotes. <note warning> |
< | < | ||
Line 87: | Line 55: | ||
< | < | ||
</ | </ | ||
- | If picture is too small to be seen inline then use link opening | + | If a picture is too small to be seen inline, then use the link to open it as a separate page; otherwise, use //nolink//. |
< | < | ||
<figure Ref.Pic.1> | <figure Ref.Pic.1> | ||
Line 94: | Line 62: | ||
</ | </ | ||
</ | </ | ||
- | Internal references to figures should be done with the figure number using [[http:// | + | Internal references to figures should be done with the figure number using [[http:// |
As shown on Figure {{ref> | As shown on Figure {{ref> | ||
< | < | ||
- | Figure {{ref> | + | Figure {{ref> |
</ | </ | ||
- | 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. | + | Note - when you insert a new figure, you must give it a unique name, here Ref. Pic.1, right by the HTML tag figure (default is a label), then you can refer to it as in regular HTML. |
- | <note important> | + | <note important> |
+ | |||
+ | <note important> | ||
< | < | ||
- | {{: | + | {{: |
</ | </ | ||
</ | </ | ||
- | Because we intend to use portrait rather than landscape | + | Because we intend to use portrait rather than landscape |
===== Tables ===== | ===== Tables ===== | ||
Line 118: | Line 88: | ||
| cell span || | | cell span || | ||
</ | </ | ||
- | and refereed in text same mechanism as figures i.e.: “as shown in Table {{ref> | + | and refereed in the text the same mechanism as figures, i.e.: “as shown in Table {{ref> |
< | < | ||
<table Ref.Tab.1.1> | <table Ref.Tab.1.1> | ||
Line 135: | Line 105: | ||
===== Code ===== | ===== Code ===== | ||
- | Code examples | + | Code examples |
%%< | %%< | ||
Line 173: | Line 143: | ||
</ | </ | ||
- | ==== Description of programming environment ==== | + | ===== Description of programming environment |
- | === Navigating in the menu === | + | ==== Navigating in the menu ==== |
While you write about menu options in software applications – write names of options in italic, i.e. like this one // | While you write about menu options in software applications – write names of options in italic, i.e. like this one // | ||
Line 186: | Line 156: | ||
- | === Buttons === | + | ==== Buttons |
Write names of the buttons in square brackets, in bold. | Write names of the buttons in square brackets, in bold. | ||
Line 199: | Line 169: | ||
- | === Variables === | + | ==== Variables |
- | Names of variables referred from the program code write in italic, i.e. //Integer val1//. | + | Names of variables referred from the program code written |
< | < | ||
Line 207: | Line 177: | ||
- | ==== Citing ==== | + | ===== Citing |
Whole sentences cited write within parenthesis “I love DokuWiki.”, | Whole sentences cited write within parenthesis “I love DokuWiki.”, | ||
Line 214: | Line 184: | ||
</ | </ | ||
- | ==== Comments in the pages ==== | + | ===== Comments in the pages ===== |
When you need some text to be hidden for the audience but let it exist there, use [[https:// | When you need some text to be hidden for the audience but let it exist there, use [[https:// | ||
Line 226: | Line 196: | ||
< | < | ||
- | If some chapters | + | If some chapters |
< | < | ||
+ | |||
+ | ===== Parts to exclude from the PDF generator ===== | ||
+ | To exclude part of the content (i.e. link lists by the end of the chapter) | ||
+ | wrap a source code using the WRAP tags: | ||
+ | < | ||
+ | <WRAP excludefrompdf> | ||
+ | |||
+ | Some content is to be present in the Dokuwiki but not to be printed in PDF. | ||
+ | |||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <note important> |