====== AsciiDoc ====== * [[http://www.methods.co.nz/asciidoc/|AsciiDoc Home Page]] -- Text based document generation ===== Documentation ===== ==== Manuals ==== * [[http://www.methods.co.nz/asciidoc/userguide.html|AsciiDoc User Guide]] (optional [[http://jwork.org/rtextdoc/data_local/userguide.html|AsciiDoc User Guide]]) * [[http://www.csc.kth.se/~akozlov/asciidoc-mini.html|AsciiDoc Mini Manual]] ==== Quick Reference ==== * [[http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/|AsciiDoc Syntax Quick Reference]] * [[http://xpt.sourceforge.net/techdocs/nix/tool/asciidoc-syn/ascs01-AsciiDocMarkupSyntaxQuickSummary/single/|AsciiDoc Markup Syntax Quick Summary]] ==== Tutorials ==== * [[http://asciidoctor.org/docs/asciidoc-writers-guide/|AsciiDoc Writer’s Guide]] ==== Advanced ==== * {{http://www.methods.co.nz/asciidoc/latexmath.pdf|Embedding LaTeX Math in AsciiDoc dblatex documents}} * [[AsciiDoc Customization]] * [[http://code.google.com/p/asciidoc/source/browse/asciidoc.conf|asciidoc.conf]] -- Asciidoc global configuration file. * [[http://www.sagehill.net/docbookxsl/PrintOutput.html#PaperSize|Printed output options]] ==== Papers ==== * {{http://www.linuxtag.org/2012/fileadmin/www.linuxtag.org/slides/Dag%20Wieers%20-%20Practical%20documentation%20workflow.p296.pdf|Dag Wieers - Practical documentation workflow}} ===== Examples ===== * [[http://wehart.blogspot.de/2011/09/using-asciidoc-for-mathematical.html|Using AsciiDoc for Mathematical Publications]]\\ //William E. Hart's Blog, September 23, 2011// ===== Installation ===== AsciiDoc requires these Software to be installed: * [[http://www.python.org/|Python]] * [[http://www.portablepython.com/|Portable Python]] * [[http://www.personal.psu.edu/sjh11/Courses/ACCTG597E/Python.shtml|Installing Python on a Windows computer]] * [[http://dblatex.sourceforge.net/doc/manual/|DocBook]] * [[http://dblatex.sourceforge.net/doc/manual/sec-install-unix.html|Installing on Unix like Systems]] * [[http://dblatex.sourceforge.net/doc/manual/ch02s03.html|Installing on Windows]] ==== Ubuntu ==== Install from prepackaged binaries ... sudo apt-get install asciidoc Install from source ... * http://mygithub.kahweb.de/iiu_de/asciidoc.html -- Installation in Ubuntu: AsciiDoc 8.6.8 ===== Support Filters and Plugins ===== ==== Mathematics ==== * [[http://quaoar.us:8080/mathjax.html|Using AsciiDoc With MathJax LaTeX Math Expressions]] FIXME * [[https://groups.google.com/forum/#!topic/asciidoc/6BgiKIRXK2U|Using MathJax with Asciidoc for generating (X)HTML with LaTeX math expressions]] * [[soft:prog:web_design:solution:mathematics|Mathematics Support for HTML]] ==== Diagrams and Figures ==== * [[https://code.google.com/p/asciidoc-diag-filter/|asciidoc-diag-filter]] -- Diagramm filter for Asciidoc * [[http://blockdiag.com/en/|blockdiag]] -- block-diagram image generator. * [[http://blockdiag.com/en/seqdiag/|seqdiag]] -- sequence-diagram image generator. * [[http://blockdiag.com/en/actdiag/|actdiag]] -- activity-diagram image generator. * [[http://blockdiag.com/en/nwdiag/|nwdiag]] -- network-diagram image generator. * [[https://pypi.python.org/pypi/blockdiag/1.2.4|blockdiag 1.2.4]] * [[http://stackoverflow.com/questions/14179941/how-to-install-python-packages-without-root-privileges|How to install python packages without root privileges?]] * [[http://home.gna.org/pychart|PyChart]] is a Python library for creating high quality Encapsulated Postscript, PDF, PNG, or SVG charts. ===== Exporting Other Formats ===== * [[https://github.com/dagwieers/asciidoc-odf|asciidoc-odf]] -- An ODF backend to directly convert documents from AsciiDoc to Open Document Format. * [[https://speakerdeck.com/dagwieers/odf-backend-for-asciidoc|ODF backend for AsciiDoc]] by Dag Wieers ===== Troubleshooting ===== * [[http://aerostitch.github.io/misc/asciidoc/asciidoc-title_uft8.html|Using UTF-8 titles with a2x]] -- What’s the issue with non-ascii characters * [[http://doublecheck.eu/2012/02/15/probleme-bei-der-pdf-generierung-mit-asciidoc/|Probleme bei der PDF-Generierung mit asciidoc]] -- Umlaute in Überschriften, Umlaute in Listings * [[https://bugs.launchpad.net/ubuntu/+source/asciidoc/+bug/1073247|a2x: pdf output fails with german umlauts in labels]]