
»Home
»FAQ
»a2x
»API
|
AsciiDoc Home PageTable of Contents
IntroductionAsciiDoc is a text document format for writing short documents, articles, books and UNIX man pages. AsciiDoc files can be translated to HTML and DocBook markups using the asciidoc(1) command. AsciiDoc is highly configurable: both the AsciiDoc source file syntax and the backend output markups (which can be almost any type of SGML/XML markup) can be customized and extended by the user.
Overview and ExamplesYou write an AsciiDoc document the same way you would write a normal text document, there are no markup tags or weird format notations. AsciiDoc files are designed to be viewed, edited and printed directly or translated to other presentation formats using the asciidoc(1) command. The asciidoc(1) command translates AsciiDoc files to HTML, XHTML and DocBook markups. DocBook can be post-processed to presentation formats such as HTML, PDF, EPUB, DVI, LaTeX, roff, and Postscript using readily available Open Source tools. Example Articles
Example BooksAsciiDoc markup supports all the standard DocBook frontmatter and backmatter sections (dedication, preface, bibliography, glossary, index, colophon) plus footnotes and index entries.
Example UNIX Man PagesHTML formatted AsciiDoc man pages with stylesheets and without stylesheets were generated by AsciiDoc from this file. This roff formatted man page was generated from asciidoc(1) DocBook output using xsltproc(1) and DocBook XSL Stylesheets. Example Web SiteThe AsciiDoc website is included in the AsciiDoc distribution (in ./examples/website/) as example website built using AsciiDoc. See ./examples/website/README-website.txt. More examples
Music FilterA music filter is included in the distribution ./filters/ directory. It translates music in LilyPond or ABC notation to standard classical notation Source Code Highlight FilterA source code highlight filter is included in the distribution ./filters/ directory. Graphviz FilterGouichi Iisaka has written a Graphviz filter for AsciiDoc. Graphviz generates diagrams from a textual specification. Gouichi Iisaka’s Graphviz filter is included in the AsciiDoc distribution. Here are some AsciiDoc Graphviz examples. Mathematical FormulaeYou can include mathematical formulae in AsciiDoc XHTML documents using ASCIIMathML or LaTeXMathML notation. LaTeX Math can be included in AsciiDoc documents processed by dblatex(1). Vim Syntax HighlighterAn AsciiDoc syntax highlighter for the Vim text editor is included in the AsciiDoc distribution (see Appendix F of the AsciiDoc User Guide for details). Dag Wieers has implemented an alternative Vim syntax file for AsciiDoc which can be found here http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/. matplotlib FilterLeonid Volnitsky has written a matplotlib filter for AsciiDoc. Using this filter you can generate charts from inline matplotlib scripts. Try AsciiDoc on the WebAndrew Koster has written a Web based application to interactively convert and display AsciiDoc source: http://andrewk.webfactional.com/asciidoc.php ResourcesHere are resources that I know of, if you know of more drop me a line and I’ll add them to the list.
Please let me know if any of these links need updating. Blogpost weblog clientDocuments written using AsciiDocHere are some documents I know of, if you know of more drop me a line and I’ll add them to the list.
Please let me know if any of these links need updating. LaTeX BackendAn experimental LaTeX backend was written for AsciiDoc in 2006 by Benjamin Klum. Benjamin did a superhuman job (I admit it, I didn’t think this was doable due to AsciiDoc's SGML/XML bias). Owning to to other commitments, Benjamin was unable to maintain this backend. Here’s Benjamin’s original documentation. Incompatibilities introduced after AsciiDoc 8.2.7 broke the LaTeX backend. In 2009 Geoff Eddy stepped up and updated the LaTeX backend, thanks to Geoff’s efforts it now works with AsciiDoc 8.4.3. Geoff’s updated latex.conf file shipped with AsciiDoc version 8.4.4. The backend still has limitations and remains experimental (see Geoff’s notes). It’s probably also worth pointing out that LaTeX output can be generated by passing AsciiDoc generated DocBook through dblatex(1). |