|
| 1 | +# 📥 Export |
| 2 | + |
| 3 | +The 📥 Export button (on the right side of the top panel above the chapter text) allows you to export the chapter text into several formats. |
| 4 | + |
| 5 | +## Formats |
| 6 | + |
| 7 | +- **HTM** |
| 8 | + One [HTML][HTML5Syntax] page with all chapter content (single book principle) |
| 9 | +- **MD** |
| 10 | + [markdown][MDSyntax] source code |
| 11 | +- **TEX** |
| 12 | + [LaTeX][LATEX] source code for subsequent output to **PDF** |
| 13 | +- **EPUB** |
| 14 | + ePub e-book format compatible with ePub2 and ePub3 |
| 15 | + (tested primarily on SW readers - [EPUBReader][EPUBReader] (Chrome), also on Android - [ReadEra][readera], [eBoox][eboox]) |
| 16 | + If no list of topics is available, the export module will attempt to create one from the **h1** headings in the chapters. |
| 17 | +- **STATIC** |
| 18 | + A set of HTML pages that are: |
| 19 | + - static, |
| 20 | + - minified, |
| 21 | + - linked to each other by relative URI paths, |
| 22 | + - supplemented with SEO metadata (og*:, description), |
| 23 | + - CSS styles and HTML structure are still compatible with **HelpViewer** (reusable custom styles for HelpViewer without the need for further modifications), |
| 24 | + - UI elements are reduced to basic hyperlinks (icons are taken from buttons at the time of export), |
| 25 | + - inspired by the principles of the WCAG 2.1 AA accessibility standard, |
| 26 | + - 💬 Texts and tooltips on buttons and other elements are taken from the active localization at the time of export, |
| 27 | + - do not contain JavaScript from the **HelpViewer** application logic and do not require the application to run, |
| 28 | + JavaScript from the help chapters that the author has inserted into the text is included. |
| 29 | + JavaScript referenced in the head section is not included. |
| 30 | + - CSS styles of external components (Mermaid, Prism) are included, JavaScript is omitted. |
| 31 | + - If no list of topics is available, the export module will attempt to create one from the first **h1** headings of each chapter. |
| 32 | + - Optionally, it is also possible to include the export of the list of 📇 [keywords][Dkeywords.lst] or the list for 🔎 [full-text search][fulltextIndex] |
| 33 | + - Export limitations: |
| 34 | + - ✨ **Intro screen**, 💧 **Watermark** are not included in the export. |
| 35 | + - 🌐 Languages - only the active language version is exported. Switching between languages will not be possible. |
| 36 | + - Support for custom modifications: |
| 37 | + - The empty **src/custom.css** file allows you to add any necessary CSS style modifications after export. |
| 38 | + - In the **sitemap.xml** and **robots.txt** files, replace **\_REMOTEHOST\_** with the full URI of your target domain where you will deploy the pages. |
| 39 | + |
| 40 | +## Limitations |
| 41 | + |
| 42 | +- Exports always work only with the visible text of the chapter. The exception is lists in **STATIC** exports. |
| 43 | +- The administrator can install the application without some export formats. |
| 44 | +- The administrator can completely remove the function from the installation - the button will then be missing. |
| 45 | + |
| 46 | +## Synergies |
| 47 | + |
| 48 | +- In combination with the 📚 Display all chapters as **one document** function (the administrator can also remove this from the installation), you can export the entire documentation. |
| 49 | + Where appropriate, the export process uses the configuration options selected here. |
| 50 | + The functions complement each other, but both do not need to be installed in the application. |
| 51 | + The **Static: Export dictionaries** option determines whether keyword and full-text lists will also be exported (exporting them significantly increases the file size). |
| 52 | +- In combination with the 🖨️ **Print** function, it is possible to remove [unicode icons][IconPrint] from the text of chapters using the following procedure: |
| 53 | + 1. In the **single document** function, select the **Remove** option in **Print icons**. |
| 54 | + 2. Click **Print** to display a preview before printing, which you should cancel (do not send to the printer). |
| 55 | + 3. The icons will be removed and the exports will work with the visible text of the chapter. |
| 56 | +- The 🖨️ **Print** function normally allows you to print a page to **PDF** in modern browsers. |
| 57 | +- In combination with the [👀 View Repository][viewRepo] function, you can read freely available external sources (for example, a free set of linked md files). |
| 58 | +- Using the **d** parameter in the URI ([index.html?d=index.html?d=https://helpviewer.github.io/][test]), freely available external resources can be read. |
| 59 | + |
| 60 | +[MDSyntax]: https://www.markdownguide.org/basic-syntax/ "MD" |
| 61 | +[HTML5Syntax]: https://www.tutorialspoint.com/html5/html5_syntax.htm "HTML" |
| 62 | +[LATEX]: https://www.latex-project.org/ "LaTeX" |
| 63 | +[EPUBReader]: https://chromewebstore.google.com/detail/epubreader/jhhclmfgfllimlhabjkgkeebkbiadflb "EPUBReader" |
| 64 | +[readera]: https://play.google.com/store/apps/details?id=org.readera "ReadEra" |
| 65 | +[eboox]: https://play.google.com/store/apps/details?id=com.reader.books "eBoox" |
| 66 | +[Dkeywords.lst]: mdata/keywords.lst.md "📇 Keywords list (keywords.lst)" |
| 67 | +[fulltextIndex]: fulltextIndex.md "🔎 Fulltext search (fts-keywords.lst)" |
| 68 | +[viewRepo]: :viewRepo.htm "👀 View your repository" |
| 69 | +[test]: ?d=https://helpviewer.github.io/ |
| 70 | +[IconPrint]: texts.md#h-2-0 "Unicode icons" |
0 commit comments