Hello !
Trace: • ToDo list for a green book • Instruction Execution Process • Mobility – New Paradigm for IoT Systems • Introduction • Bluetooth • Arendajatele • IoT System Design Principles • Mikrokontrollerid ja robootika • Blockchain Network Structures and Technologies • General rules for creating the DokuWiki-based books. v.1.7

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/11/21 15:54] – [Comments in the pages] pczekalskien:iot-open:rules [2025/10/30 07:53] (current) – raivo.sell
Line 1: Line 1:
-====== General rules for creating the DokuWiki-based books. v.1.5 ======+====== General rules for creating the DokuWiki-based books. v.1.7 ======
  
 ===== Table of Contents ===== ===== Table of Contents =====
Line 39: Line 39:
  
  
-</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>
  
  
 ===== References ===== ===== References =====
 +References should appear in the text as pointers e.g. <code>[(AuthorsYear)]</code> The full record of this reference must be in the separate References page, e.g. [[en:safeav:references|]]. Make sure that all pointers are correctly listed in the Reference page.
  
-References should appear in the text as footnotes. <note warning>This is subject to change in case we employ a working plugin for DokuWiki that lets us introduce IEEE-style references.</note>+<note>You can see the references only in Edit mode. In standard View mode, the Reference page looks empty. This is normal behaviour</note>
  
-<code>((Reference))</code>+ 
 +If using the **RefNotes plugin** for structured or bibliographical references (e.g., Harvard or IEEE-style), make sure to disable the automatic backlink numbers that appear in the reference list.   
 +Otherwise, the same citation may appear with duplicated numbers such as `[2], [2]`. 
 + 
 +To make each reference appear only once in the footer (as in proper academic formatting), add the following to the **end of your page**: 
 + 
 +<code> 
 +<refnotes> 
 +back-ref-format : none 
 +</refnotes> 
 +</code>
  
 ===== Figures ===== ===== Figures =====
Line 77: Line 87:
 </note> </note>
  
-Because we intend to use portrait rather than landscape layouts 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.+Because we intend to use portrait rather than landscape layouts in printed books, please consider preparing diagrams as landscape ones rather than portrait. Eventually, portrait diagrams, images, and graphics could be rotated 90 degrees counterclockwise to fit into the printing layout.
  
 +<note important>Due to the requirement of the accessibility of the contents, it is necessary to provide **Alternative text** for all figures.</note>
 +
 +A video presenting work with figures, tables and references is here:
 +{{ youtube>88N9eoKgakw?large }}
 ===== Tables ===== ===== Tables =====
  
Line 88: Line 102:
 | cell span || | cell span ||
 </table> </table>
-and refereed in the text the same mechanism as figures, i.e.: “as shown in Table {{ref>Ref.Tab.1.1}}”.+and referred in the text to the same mechanism as figures, i.e.: “as shown in Table {{ref>Ref. Tab . 1.1}}”.
 <code> <code>
 <table Ref.Tab.1.1> <table Ref.Tab.1.1>
Line 97: Line 111:
 </table> </table>
 </code> </code>
 +
 +Our Dokuwiki has installed the table editor plugin, so once you create and save the page with a table, you can edit it in a simpler way using the GUI editor.
 ===== Equations ===== ===== Equations =====
  
Line 211: Line 227:
  
 <note important>You must explicitly use the name **excludefrompdf** identifier, otherwise it won't work.</note> <note important>You must explicitly use the name **excludefrompdf** identifier, otherwise it won't work.</note>
 +
 +===== Common language settings ======
 +Please use UK English, not US English; thus, e.g. use UK's "license", not US's "licence", etc.
 +
 +Use depersonated form, e.g. "in this chapter, details of drone security systems are presented" rather than "in this chapter, you can read about drone security".
 +
 +===== Book printing to PDF remarks =====
 +On top of the ToC, there is a link for the PDF version of the contents and another to generate a new one. The book is not generated automatically, so if you change anything and then wish to see the PDF version, click the ''Generate new PDF book!'' link and wait till it is finished.
 +
 +<note tip>Dokuwiki server struggles with a caching issue: if you generate PDFs in a row, when downloading the PDF book, you may get an older copy instead of the recently generated one. Open the PDF book in the private tab of your browser (it does not use session cache, thus always downloads full content from the Dokuwiki server). Simply right-click the **Current version of PDF Book** and select **Open in new private tab** (or similar, browser dependent).</note>
 +===== Useful tools =====
 +
 +If you want to print just one page as proper PDF, you can use a DW2PDF plugin. Just add in the end of page URL a command:
 +<code>?do=export_pdf</code>
 +
en/iot-open/rules.1700582085.txt.gz · Last modified: 2023/11/21 15:54 by pczekalski
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