Xmlmind Ebook Compiler Manual
Total Page:16
File Type:pdf, Size:1020Kb
XMLmind Ebook Compiler Manual Hussein Sha®e XMLmind Software 35 rue Louis Leblanc, 78120 Rambouillet, France, Phone: +33 (0)9 52 80 80 37, Web: www.xmlmind.com/ebookc Email: [email protected] May 14, 2021 XMLmind Ebook Compiler Manual Table of Contents List of Figures ....................................................................................................................................................... iii List of Tables ......................................................................................................................................................... iv List of Examples ..................................................................................................................................................... v List of Equations ................................................................................................................................................... vi I. User guide ........................................................................................................................................................... 1 1. What is XMLmind Ebook Compiler? .......................................................................................................... 2 2. Primer ........................................................................................................................................................... 3 3. Getting started ............................................................................................................................................ 13 4. Handy features ............................................................................................................................................ 16 4.1. Markdown support ............................................................................................................................. 16 4.1.1. Supported Markdown extensions ............................................................................................. 17 4.2. Automatic resource management ...................................................................................................... 29 4.3. Conditional processing ...................................................................................................................... 32 4.4. Transclusion ...................................................................................................................................... 34 II. Reference ......................................................................................................................................................... 37 5. Installation .................................................................................................................................................. 38 6. Content of a source HTML page ................................................................................................................ 40 6.1. Valid XHTML5 ................................................................................................................................. 40 6.2. Headings ............................................................................................................................................ 40 6.3. Examples ........................................................................................................................................... 41 6.4. Equations ........................................................................................................................................... 44 6.5. Admonitions ...................................................................................................................................... 45 6.6. Footnotes ........................................................................................................................................... 46 6.7. Cross-references ................................................................................................................................ 47 6.8. Index terms ........................................................................................................................................ 49 7. Reference of ebook elements ..................................................................................................................... 52 7.1. Element appendices ....................................................................................................................... 52 7.2. Element appendix ........................................................................................................................... 53 7.3. Element backmatter ....................................................................................................................... 54 7.4. Element body .................................................................................................................................... 54 7.5. Element book .................................................................................................................................... 55 7.6. Element chapter ............................................................................................................................. 63 7.7. Element content ............................................................................................................................. 64 7.8. Element frontmatter .................................................................................................................... 64 7.9. Element head .................................................................................................................................... 65 7.10. Element headcommon ..................................................................................................................... 67 7.11. Element index ................................................................................................................................ 68 7.12. Element loe .................................................................................................................................... 68 7.13. Element lof .................................................................................................................................... 69 7.14. Element lot .................................................................................................................................... 70 7.15. Element lox .................................................................................................................................... 71 7.16. Element part .................................................................................................................................. 72 7.17. Element related ........................................................................................................................... 73 7.18. Element section ........................................................................................................................... 74 7.19. Element title ................................................................................................................................ 75 7.20. Element toc .................................................................................................................................... 76 i XMLmind Ebook Compiler Manual 7.21. Common attributes .......................................................................................................................... 77 8. How it works .............................................................................................................................................. 80 9. The ebookc command-line utility ............................................................................................................. 82 10. XSLT stylesheets parameters ................................................................................................................... 90 10.1. Parameters of the XSLT stylesheets used to convert an ebook speci®cation to EPUB ................... 90 10.2. Parameters of the XSLT stylesheets used to convert an ebook speci®cation to Web Help ............. 90 10.3. Parameters of the XSLT stylesheets used to convert an ebook speci®cation to XSL-FO ............... 96 10.3.1. Specifying a header or a footer ............................................................................................. 105 Appendices ......................................................................................................................................................... 110 A. Embedding com.xmlmind.ebook.convert.Converter ................................................................. 111 Index ........................................................................................................................................................................ i ii XMLmind Ebook Compiler Manual List of Figures 3-1. This manual, manual.ebook, opened in XMLmind XML Editor .............................................................. 15 6-1. The "Edit index term" dialog box of XMLmind XML Editor .................................................................... 49 8-1. XMLmind Ebook Compiler components ...................................................................................................... 80 10-1. Page areas .................................................................................................................................................. 104 10-2. Layout of