Hello !
Trace: • Delay

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:iot-open:rules [2023/08/29 07:29] – external edit (Unknown date) 127.0.0.1en:iot-open:rules [2023/11/21 15:54] (current) – [Comments in the pages] pczekalski
Line 1: Line 1:
-====== General rules for creating the DokuWiki-based books. v.1.4 ======+====== General rules for creating the DokuWiki-based books. v.1.5 ======
  
 ===== Table of Contents ===== ===== Table of Contents =====
Line 5: Line 5:
 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. 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>The ToC does not assign the chapters in the book. That is done on every linked page separately, depending on the header. Info about headers is down below.</note> <note important>The ToC does not assign the chapters in the book. That is done on every linked page separately, depending on the header. Info about headers is down below.</note>
 +<note warning>Do not use capital letters or spaces in the chapter links!</note>
 +
  
 ==== Exclude a page ==== ==== Exclude a page ====
Line 21: Line 23:
  
 <code>====== Title ======</code> <code>====== Title ======</code>
-Note the first chapter level on the page should correspond with the ToC indentation if the Dokuwiki page is part of the book. +Each page should start from the highest chapter level. The PDF book generator will automatically shift it down by the starting position, e.g.:
- +
  
-==== Subchapter ====+1. Introduction (page1) 
 +1.1 Definition of the problem (page2)
  
-Subchapters of the first level (header level 2) need four equation marks, second level (header level 3) – three and so on:+page1 starts with:\\ 
 +<code>======Introduction======</code>
  
-<code>===== Subchapter =====</code>+page2 starts with:\\ 
 +<code>======Definition of the problem======</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 chapters).+<note warning>Note, in the final document, page1's header will be rendered as HTML's H1, while page2's header will be rendered as H2, thus it is automatically converted from 6x= to 5x=.\\ 
 +This is particularly important when using <code>===</code> headers because depending on the chapter nesting, they can be decreased down to either <code>==</code> or even <code>=</code> that does not represent legit header!</note> 
 +==== Subchapter ====
  
-<note important> The Level of the first chapter is determined by the ToC level if the page is supposed to be a part of the book in the feature, i.e. 
-<code> 
-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.) ====== 
- 
-</code> 
 </note> </note>
 <note warning>DO NOT INCLUDE CHAPTER NUMBERS in the headers!!!! The sample above is to present the relation between chapters, but numbers are to be generated automatically!</note> <note warning>DO NOT INCLUDE CHAPTER NUMBERS in the headers!!!! The sample above is to present the relation between chapters, but numbers are to be generated automatically!</note>
Line 237: Line 196:
 <code><hidden>excluded section</hidden></code> <code><hidden>excluded section</hidden></code>
  
-If some chapters needs to be exclude use del tag+If some chapters need to be excluded use the del tag
 <code><del>  </del></code> <code><del>  </del></code>
 +
 +===== 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:
 +<code>
 +<WRAP excludefrompdf>
 +
 +Some content is to be present in the Dokuwiki but not to be printed in PDF.
 +
 +</WRAP>
 +</code>
 +
 +<note important>You must explicitly use the name **excludefrompdf** identifier, otherwise it won't work.</note>
en/iot-open/rules.1693294164.txt.gz · Last modified: 2023/08/29 07:29 by 127.0.0.1
CC Attribution-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0