| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| en:iot-open:rules [2025/09/18 14:40] – [Book printing to PDF remarks] pczekalski | en:iot-open:rules [2025/10/30 07:53] (current) – raivo.sell |
|---|
| ====== General rules for creating the DokuWiki-based books. v.1.6 ====== | ====== General rules for creating the DokuWiki-based books. v.1.7 ====== |
| |
| ===== Table of Contents ===== | ===== Table of Contents ===== |
| |
| ===== 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 ===== |
| <note important>Due to the requirement of the accessibility of the contents, it is necessary to provide **Alternative text** for all figures.</note> | <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 ===== |
| |
| 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. | 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> | <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> |
