diff options
Diffstat (limited to 'index.html')
| -rw-r--r-- | index.html | 923 |
1 files changed, 5 insertions, 918 deletions
@@ -1,918 +1,5 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
- "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 10.0.0a2" />
-<meta name="description" content="AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page." />
-<meta name="keywords" content="AsciiDoc, DocBook, EPUB, PDF, ebooks, slideshow, slidy, man page" />
-<title>AsciiDoc Home Page</title>
-<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
-<link rel="stylesheet" href="./layout2.css" type="text/css" />
-<script type="text/javascript" src="./asciidoc.js"></script>
-<script type="text/javascript">
-/*<![CDATA[*/
-asciidoc.install(1);
-/*]]>*/
-</script>
-</head>
-<body style="max-width:70em">
-<div id="layout-menu-box">
-<div id="layout-menu">
- <div>»<a href="index.html">Home</a></div>
- <div>»<a href="userguide.html">User Guide</a></div>
- <div>»<a href="INSTALL.html">Installation</a></div>
- <div>»<a href="faq.html">FAQ</a></div>
- <div>»<a href="manpage.html">asciidoc(1)</a></div>
- <div>»<a href="a2x.1.html">a2x(1)</a></div>
- <div>»<a href="asciidocapi.html">API</a></div>
- <div>»<a href="plugins.html">Plugins</a></div>
- <div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
- <div>»<a href="testasciidoc.html">Tests</a></div>
- <div>»<a href="CHANGELOG.html">ChangeLog</a></div>
- <div>»<a href="support.html">Support</a></div>
- <div id="page-source">»<a href="index.txt">Page Source</a></div>
-</div>
-</div>
-<div id="layout-content-box">
-<div id="layout-banner">
- <div id="layout-title">AsciiDoc</div>
- <div id="layout-description">Text based document generation</div>
-</div>
-<div id="layout-content">
-<div id="header">
-<h1>AsciiDoc Home Page</h1>
-<div id="toc">
- <div id="toctitle">Table of Contents</div>
- <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
-</div>
-</div>
-<div id="content">
-<div id="preamble">
-<div class="sectionbody">
-<div class="sidebarblock">
-<div class="content">
-<div class="title">08 February 2021: AsciiDoc 9.1.0 Released</div>
-<div class="paragraph"><p>Read the <a href="CHANGELOG.html">CHANGELOG</a> for release highlights and a
-full list of all additions, changes and bug fixes. Changes are
-documented in the updated <a href="userguide.html">User Guide</a>. See the
-<a href="INSTALL.html">Installation page</a> for downloads and and
-installation instructions.</p></div>
-</div></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_introduction">Introduction</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.</p></div>
-<div class="paragraph"><p>AsciiDoc.py is a legacy processor for this syntax, handling an older
-rendition of AsciiDoc. As such, this will not properly handle the
-<a href="https://projects.eclipse.org/projects/technology.asciidoc">current AsciiDoc specification</a>.
-It is suggested that unless you specifically require the AsciiDoc.py
-toolchain, you should find a processor that handles the modern AsciiDoc
-syntax.</p></div>
-<div class="paragraph"><p>AsciiDoc.py 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.</p></div>
-<div class="paragraph"><p>AsciiDoc.py is free software and is licensed under the terms of the <em>GNU
-General Public License version 2</em> (GPLv2).</p></div>
-<div class="admonitionblock">
-<table><tr>
-<td class="icon">
-<img src="./images/icons/tip.png" alt="Tip" />
-</td>
-<td class="content">The pages you are reading were written using AsciiDoc, to view
-the corresponding AsciiDoc source click on the <strong>Page Source</strong> menu item
-in the left hand margin.</td>
-</tr></table>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_overview_and_examples">Overview and Examples</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>You 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 <code>asciidoc(1)</code> command.</p></div>
-<div class="paragraph"><p>The <code>asciidoc(1)</code> 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.</p></div>
-<div class="sect2">
-<h3 id="_example_articles">Example Articles</h3>
-<div class="ulist"><ul>
-<li>
-<p>
-This XHTML version of the
- <a href="asciidoc.css-embedded.html">AsciiDoc User Guide</a>
- was generated by AsciiDoc from
- <a href="asciidoc.txt">this AsciiDoc file</a>.
-</p>
-</li>
-<li>
-<p>
-Here’s the <a href="asciidoc.html">same document</a> created by first
- generating DocBook markup using AsciiDoc and then converting the
- DocBook markup to HTML using <em>DocBook XSL Stylesheets</em>.
-</p>
-</li>
-<li>
-<p>
-The User Guide again, this time a
- <a href="chunked/index.html">chunked version</a>.
-</p>
-</li>
-<li>
-<p>
-AsciiDoc generated this <a href="article-standalone.html">stand-alone
- HTML file</a> containing embedded CSS, JavaScript and images from this
- <a href="article.txt">AsciiDoc article template</a> with this command:
-</p>
-<div class="literalblock">
-<div class="content">
-<pre><code>asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt</code></pre>
-</div></div>
-</li>
-<li>
-<p>
-The same <a href="article.txt">AsciiDoc article template</a> generated
- <a href="article-html5-toc2.html">this HTML 5</a> (the <em>toc2</em> attribute puts
- a table of contents in the left margin) from this command:
-</p>
-<div class="literalblock">
-<div class="content">
-<pre><code>asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt</code></pre>
-</div></div>
-</li>
-<li>
-<p>
-The same <a href="article.txt">AsciiDoc article template</a> produced
- this <a href="article.html">HTML file</a> and this
- <a href="article.pdf">PDF file</a> via DocBook markup generated by AsciiDoc.
-</p>
-</li>
-</ul></div>
-</div>
-<div class="sect2">
-<h3 id="X7">Example Books</h3>
-<div class="paragraph"><p>AsciiDoc markup supports all the standard DocBook frontmatter and
-backmatter sections (dedication, preface, bibliography, glossary,
-index, colophon) plus footnotes and index entries.</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-This <a href="book.txt">AsciiDoc book</a> produced <a href="book.html">this HTML
- file</a> using the <em>DocBook XSL Stylesheets</em>.
-</p>
-</li>
-<li>
-<p>
-The <a href="asciidoc.pdf">PDF formatted AsciiDoc User Guide</a> was
- generated from <code>asciidoc(1)</code> DocBook output.
-</p>
-</li>
-<li>
-<p>
-The <a href="asciidoc.epub">EPUB formatted AsciiDoc User Guide</a> was
- generated using <a href="a2x.1.html">a2x</a>.
-</p>
-</li>
-<li>
-<p>
-This <a href="book.epub">EPUB formatted book skeleton</a> was generated
- using <a href="a2x.1.html">a2x</a>.
-</p>
-</li>
-<li>
-<p>
-This <a href="book-multi.txt">multi-part AsciiDoc book</a> produced
- <a href="book-multi.html">this HTML file</a> using the <em>DocBook XSL
- Stylesheets</em>.
-</p>
-</li>
-</ul></div>
-</div>
-<div class="sect2">
-<h3 id="_example_unix_man_pages">Example UNIX Man Pages</h3>
-<div class="paragraph"><p>HTML formatted AsciiDoc man pages
-<a href="asciidoc.1.css-embedded.html">with stylesheets</a> and
-<a href="asciidoc.1.html">without stylesheets</a> were generated by AsciiDoc
-from <a href="asciidoc.1.txt">this file</a>.</p></div>
-<div class="paragraph"><p>This <a href="asciidoc.1">roff formatted man page</a> was generated from
-<code>asciidoc(1)</code> DocBook output using <code>xsltproc(1)</code> and DocBook XSL
-Stylesheets.</p></div>
-</div>
-<div class="sect2">
-<h3 id="X8">Example Slideshows</h3>
-<div class="paragraph"><p>The <a href="https://www.w3.org/Talks/Tools/Slidy2/">Slidy</a> backend generates
-HTML slideshows that can be viewed in any web browser. What’s nice is
-that you can create completely self contained slideshows including
-embedded images.</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-Here is the <a href="slidy.html">slidy backend documentation</a> slideshow
- and here is it’s <a href="slidy.txt">AsciiDoc source</a>.
-</p>
-</li>
-<li>
-<p>
-An <a href="slidy-example.html">example slidy slideshow</a> and the
- <a href="slidy-example.txt">AsciiDoc source</a>.
-</p>
-</li>
-</ul></div>
-</div>
-<div class="sect2">
-<h3 id="_example_web_site">Example Web Site</h3>
-<div class="paragraph"><p>The <a href="README-website.html">AsciiDoc website</a> is included in the
-AsciiDoc distribution (in <code>./website/</code> and <code>./docs/</code>) as an example website
-built using AsciiDoc. See <code>./website/README-website.txt</code>.</p></div>
-</div>
-<div class="sect2">
-<h3 id="_more_examples">More examples</h3>
-<div class="ulist"><ul>
-<li>
-<p>
-See below: <a href="#X6"><em>Documents written using AsciiDoc</em></a>.
-</p>
-</li>
-<li>
-<p>
-Example <a href="newtables.html">Tables</a>.
-</p>
-</li>
-</ul></div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_ebook_publication">eBook Publication</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>The two most popular open eBook formats are
-<a href="https://en.wikipedia.org/wiki/EPUB">EPUB</a> and PDF.
-The AsciiDoc <a href="a2x.1.html">a2x</a> toolchain wrapper makes it easy to
-<a href="publishing-ebooks-with-asciidoc.html">publish EPUB and PDF eBooks
-with AsciiDoc</a>. See also <a href="#X7">example books</a> and
-<a href="epub-notes.html">AsciiDoc EPUB Notes</a>).</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_blogpost_weblog_client">Blogpost weblog client</h2>
-<div class="sectionbody">
-<div class="paragraph"><p><a href="https://srackham.wordpress.com/blogpost-readme/">blogpost</a> is a
-command-line weblog client for publishing AsciiDoc documents to
-<a href="https://wordpress.org/">WordPress</a> blog hosts. It creates and updates
-weblog posts and pages directly from AsciiDoc source documents.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_source_code_highlighter">Source code highlighter</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>AsciiDoc includes a <a href="source-highlight-filter.html">source code
-highlighter filter</a> that uses
-<a href="https://www.gnu.org/software/src-highlite/">GNU source-highlight</a> to
-highlight HTML outputs. You also have the option of using the
-<a href="https://pygments.org/">Pygments</a> highlighter.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="X3">Mathematical Formulae</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>You can include mathematical formulae in AsciiDoc XHTML documents using
-<a href="asciimath.html">ASCIIMath</a> or <a href="latexmathml.html">LaTeXMathML</a>
-notation.</p></div>
-<div class="paragraph"><p>The <a href="latex-filter.html">AsciiDoc LaTeX filter</a> translates LaTeX
-source to an image that is automatically inserted into the AsciiDoc
-output documents.</p></div>
-<div class="paragraph"><p>AsciiDoc also has <em>latexmath</em> macros for DocBook outputs — they are
-documented in <a href="latexmath.pdf">this PDF file</a> and can be used in
-AsciiDoc documents processed by <code>dblatex(1)</code>.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_editor_support">Editor Support</h2>
-<div class="sectionbody">
-<div class="ulist"><ul>
-<li>
-<p>
-An AsciiDoc syntax highlighter for the Vim text editor is included in Vim.
-</p>
-<div class="imageblock">
-<div class="content">
-<a class="image" href="images/highlighter.png">
-<img src="images/highlighter.png" alt="images/highlighter.png" height="400" />
-</a>
-</div>
-<div class="title">Syntax highlighter screenshot</div>
-</div>
-</li>
-<li>
-<p>
-Dag Wieers has implemented an alternative Vim syntax file for
- AsciiDoc which can be found here
- <a href="https://github.com/dagwieers/asciidoc-vim">https://github.com/dagwieers/asciidoc-vim</a>.
-</p>
-</li>
-<li>
-<p>
-David Avsajanishvili has written a source highlighter for AsciiDoc
- files for <a href="https://wiki.gnome.org/Projects/GtkSourceView">GtkSourceView</a>
- (used by <a href="https://wiki.gnome.org/Apps/Gedit">gedit</a> and a number of
- other applications). The project is hosted here:
- <a href="https://launchpad.net/asciidoc-gtk-highlight">https://launchpad.net/asciidoc-gtk-highlight</a>
-</p>
-</li>
-<li>
-<p>
-AsciiDoc resources for the Emacs editor can be found on the
- <a href="https://www.emacswiki.org/emacs/AsciiDoc">AsciiDoc page</a> at the
- <a href="https://www.emacswiki.org/emacs/EmacsWiki">Emacs Wiki</a>.
-</p>
-</li>
-<li>
-<p>
-Christian Zuckschwerdt has written a
- <a href="https://github.com/zuckschwerdt/asciidoc.tmbundle">TextMate bundle</a>
- for AsciiDoc.
-</p>
-</li>
-</ul></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_try_asciidoc_on_the_web">Try AsciiDoc on the Web</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Thaddée Tyl has written an online live editor named
-<a href="https://espadrine.github.io/AsciiDocBox/">AsciiDocBox</a> to try AsciiDoc in
-your browser.</p></div>
-<div class="paragraph"><p>You can use <a href="https://gist.asciidoctor.org/">DocGist</a> to preview AsciiDoc
-files hosted on GitHub, Dropbox, and other services. DocGist also
-features a real-time collaboration mode.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="X2">External Resources and Applications</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Here are various useful resources, feel free to open a pull request to
-add additional ones:</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-Check the <a href="INSTALL.html#X2">installation page</a> for packaged versions
- of AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-<a href="https://asciidoctor.org/">Asciidoctor</a> provides a modern, compliant, and
- substantially faster implementation of the AsciiDoc processor written
- in Ruby. This implementation can also be run on the JVM (with
- AsciidoctorJ) or using JavaScript (with Asciidoctor.js). The
- Asciidoctor project now maintains the official definition of the
- AsciiDoc syntax.
-</p>
-</li>
-<li>
-<p>
-Alex Efros has written an HTML formatted
- <a href="https://powerman.name/doc/asciidoc">AsciiDoc Cheatsheet</a> using AsciiDoc.
- The Asciidoctor project also provides a comprehensive
- <a href="https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/">AsciiDoc
- syntax quick reference</a>. However, the syntax supported by Asciidoctor differs
- slightly, see
- <a href="https://docs.asciidoctor.org/asciidoctor/latest/migrate/asciidoc-py/#updated-and-deprecated-asciidoc-syntax">this page</a>
- for more details.
-</p>
-</li>
-<li>
-<p>
-The <a href="http://remips.sourceforge.net/">ReMIPS</a> project website has been
- built using AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Here are some <a href="asciidoc-docbook-xsl.html">DocBook XSL Stylesheets
- Notes</a>.
-</p>
-</li>
-<li>
-<p>
-Karl Mowatt-Wilson has developed an <a href="http://ikiwiki.info/">ikiwiki</a>
- plugin for AsciiDoc which he uses to render
- <a href="http://mowson.org/karl">his website</a>. The plugin is available
- <a href="http://www.mowson.org/karl/colophon/">here</a> and there is some
- discussion of the ikiwiki integration
- <a href="http://ikiwiki.info/users/KarlMW/discussion/">here</a>.
-</p>
-</li>
-<li>
-<p>
-Glenn Eychaner has
- <a href="http://groups.google.com/group/asciidoc/browse_thread/thread/bf04b55628efe214">reworked
- the Asciidoc plugin for ikiwiki</a> that was created by Karl Mowson.
-</p>
-</li>
-<li>
-<p>
-David Hajage has written an AsciiDoc package for the
- <a href="http://www.r-project.org/">R Project</a> (R is a free software
- environment for statistical computing). <em>ascii</em> is available on
- <em>CRAN</em> (just run <code>install.packages("ascii")</code> from R). Briefly,
- <em>ascii</em> replaces R results in AsciiDoc document with AsciiDoc
- markup. More information and examples here:
- <a href="http://eusebe.github.com/ascii/">http://eusebe.github.com/ascii/</a>.
-</p>
-</li>
-<li>
-<p>
-Jared Henley has written
- <a href="https://jared.henley.id.au/software/awb/">AsciiDoc
- Website Builder</a>. <em>AsciiDoc Website Builder</em> (awb) is a Python
- program that automates the building of of a website written in
- AsciiDoc. All you need to write is the AsciiDoc source plus a few
- simple configuration files.
-</p>
-</li>
-<li>
-<p>
-Filippo Negroni has developed a set of tools to facilitate <em>literate
- programming</em> using AsciiDoc. The set of tools is called
- <a href="http://eweb.sourceforge.net/">eWEB</a>.
-</p>
-</li>
-<li>
-<p>
-<a href="https://vanderwijk.info/">Ivo’s blog</a> describes a
- <a href="https://ditaa.sourceforge.net/">ditaa</a> filter for AsciiDoc which converts
- <a href="https://en.wikipedia.org/wiki/ASCII_art">ASCII art</a> into graphics.
-</p>
-</li>
-<li>
-<p>
-<a href="https://github.com/gollum/gollum">Gollum</a> is a git-powered wiki, it
- supports various formats, including AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Gregory Romé has written an
- <a href="https://github.com/gpr/redmine_asciidoc_formatter">AsciiDoc plugin</a>
- for the <a href="https://www.redmine.org/">Redmine</a> project management
- application.
-</p>
-</li>
-<li>
-<p>
-Paul Hsu has started a
- <a href="https://github.com/paulhsu/AsciiDoc.CHT.userguide">Chinese translation
- of the AsciiDoc User Guide</a>.
-</p>
-</li>
-<li>
-<p>
-Dag Wieers has written
- <a href="http://dag.wieers.com/home-made/unoconv/">UNOCONV</a>. <em>UNOCONV</em> can
- export AsciiDoc outputs to OpenOffice export formats.
-</p>
-</li>
-<li>
-<p>
-Ed Keith has written
- <a href="https://sourceforge.net/projects/codeextactor.berlios/">Code Extractor</a>,
- it extracts code snippets from source code files and
- inserts them into AsciiDoc documents.
-</p>
-</li>
-<li>
-<p>
-Ryan Tomayko has written an number of
- <a href="https://github.com/rtomayko/adoc-themes">themes for AsciiDoc</a>.
-</p>
-</li>
-<li>
-<p>
-Lex Trotman has written
- <a href="https://github.com/elextr/codiicsa">codiicsa</a>, a program that
- converts DocBook to AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Qingping Hou has written <a href="https://houqp.github.io/asciidoc-deckjs/">an
- AsciiDoc backend for deck.js</a>.
- <a href="http://imakewebthings.com/deck.js/">deck.js</a> is a JavaScript
- library for building modern HTML presentations (slideshows).
-</p>
-</li>
-<li>
-<p>
-The guys from O’Reilly Media have posted an
- <a href="https://github.com/oreillymedia/docbook2asciidoc">XSL Stylesheet to
-github</a> that converts DocBook to AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Lex Trotman has written
- <a href="https://github.com/elextr/flexndex">flexndex</a>, an index generator
- tool that be used with AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Michael Haberler has created a
- <a href="https://code.google.com/archive/p/asciidoc-diag-filter/">blockdiag filter
- for AsciiDoc</a> which embeds <a href="http://blockdiag.com/en/">blockdiag</a> images in
- AsciiDoc documents.
-</p>
-</li>
-<li>
-<p>
-Dan Allen has written a
- <a href="https://github.com/mojavelinux/asciidoc-bootstrap-docs-backend">Bootstrap
- backend</a> for AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Steven Boscarine has written
- <a href="https://github.com/StevenBoscarine/JavaAsciidocWrapper">Maven wrapper for AsciiDoc</a>.
-</p>
-</li>
-<li>
-<p>
-Christian Goltz has written
- <a href="https://github.com/christiangoltz/shaape">Shaape</a>, an Ascii art to
- image converter for AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Eduardo Santana has written an
- <a href="https://github.com/edusantana/asciidoc-highlight">Asciidoc Highlight
- for Notepad++</a>.
-</p>
-</li>
-<li>
-<p>
-<a href="https://www.geany.org/">Geany</a> 1.23 adds document structure support
- for AsciiDoc.
-</p>
-</li>
-</ul></div>
-<div class="paragraph"><p>Please let me know if any of these links need updating.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="X6">Documents written using AsciiDoc</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Here are some documents I know of, if you know of more drop me a line
-and I’ll add them to the list.</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-The book <a href="http://practicalunittesting.com/">Practical Unit Testing</a> by
- Tomek Kaczanowski was
- <a href="https://groups.google.com/group/asciidoc/browse_frm/thread/4ba13926262efa23">written
- using Asciidoc</a>.
-</p>
-</li>
-<li>
-<p>
-The book
- <a href="https://www.oreilly.com/library/view/programming-ios-4/9781449397302/">Programming iOS 4</a>
- by Matt Neuburg was written using AsciiDoc. Matt has
- <a href="https://www.apeth.net/matt/iosbooktoolchain.html">written an article</a>
- describing how he used AsciiDoc and other tools to write the book.
-</p>
-</li>
-<li>
-<p>
-The book
- <a href="https://www.oreilly.com/library/view/programming-scala/9780596801908/">Programming
- Scala</a> by Dean Wampler and Alex Payne (O’Reilly) was
- <a href="http://groups.google.com/group/asciidoc/browse_frm/thread/449f1199343f0e27">written
- using Asciidoc</a>.
-</p>
-</li>
-<li>
-<p>
-The Neo4j graph database project uses Asciidoc, and the output is
- published here: <a href="https://neo4j.com/docs/">https://neo4j.com/docs/</a>. The build process includes
- live tested source code snippets and is described
- <a href="http://groups.google.com/group/asciidoc/browse_thread/thread/49d570062fd3ff52">here</a>.
-</p>
-</li>
-<li>
-<p>
-<a href="https://frugalware.org/">Frugalware Linux</a> uses AsciiDoc for
- <a href="https://frugalware.org/docs">documentation</a>.
-</p>
-</li>
-<li>
-<p>
-<a href="http://www.cherokee-project.com/doc/">Cherokee documentation</a>.
-</p>
-</li>
-<li>
-<p>
-Henrik Maier produced this professional User manual using AsciiDoc:
- <a href="http://www.proconx.com/assets/files/products/modg100/UMMBRG300-1101.pdf">http://www.proconx.com/assets/files/products/modg100/UMMBRG300-1101.pdf</a>
-</p>
-</li>
-<li>
-<p>
-Henrik also produced this folded single page brochure format
- example:
- <a href="http://www.proconx.com/assets/files/products/modg100/IGMBRG300-1101-up.pdf">http://www.proconx.com/assets/files/products/modg100/IGMBRG300-1101-up.pdf</a>
-</p>
-<div class="paragraph"><p>See this
-<a href="http://groups.google.com/group/asciidoc/browse_thread/thread/16ab5a06864b934f">AsciiDoc
-discussion group thread</a> for details.</p></div>
-</li>
-<li>
-<p>
-The
- <a href="https://mirrors.edge.kernel.org/pub/software/scm/git/docs/user-manual.html">Git
- User’s Manual</a>.
-</p>
-</li>
-<li>
-<p>
-<em>Git Magic</em><br />
- <a href="http://www-cs-students.stanford.edu/~blynn/gitmagic/">http://www-cs-students.stanford.edu/~blynn/gitmagic/</a><br />
- <a href="https://github.com/blynn/gitmagic">https://github.com/blynn/gitmagic</a>
-</p>
-</li>
-<li>
-<p>
-<em>CouchDB: The Definitive Guide</em><br />
- <a href="https://docs.couchdb.org/en/stable/">https://docs.couchdb.org/en/stable/</a><br />
- <a href="https://groups.google.com/g/asciidoc/c/pg9ny7r4Yqo">https://groups.google.com/g/asciidoc/c/pg9ny7r4Yqo</a>
-</p>
-</li>
-<li>
-<p>
-<em>Ramaze Manual</em><br />
- <a href="http://book.ramaze.net/">http://book.ramaze.net/</a><br />
- <a href="http://github.com/manveru/ramaze-book">http://github.com/manveru/ramaze-book</a>
-</p>
-</li>
-<li>
-<p>
-The <a href="https://github.com/manveru/KirbyBase">KirbyBase for Ruby</a>
- database management system manual.
-</p>
-</li>
-<li>
-<p>
-The <a href="http://xpt.sourceforge.net/">*Nix Power Tools project</a> uses
- AsciiDoc for documentation.
-</p>
-</li>
-<li>
-<p>
-The <a href="http://www.wesnoth.org/">Battle for Wesnoth</a> project uses
- AsciiDoc for its <a href="http://www.wesnoth.org/wiki/WesnothManual">Manual</a>
- in a number of different languages.
-</p>
-</li>
-<li>
-<p>
-Troy Hanson uses AsciiDoc to generate user guides for the
- <a href="https://troydhanson.github.io/tpl/index.html">tpl</a> and
- <a href="https://troydhanson.github.io/uthash/index.html">uthash</a> projects
- (the HTML versions have a customised contents sidebar).
-</p>
-</li>
-<li>
-<p>
-<a href="https://weechat.org/">WeeChat</a> uses AsciiDoc for
- <a href="https://weechat.org/doc/">project documentation</a>.
-</p>
-</li>
-<li>
-<p>
-<a href="https://github.com/Clansuite/Clansuite">Clansuite</a> uses AsciiDoc for
- project documentation.
-</p>
-</li>
-<li>
-<p>
-The <a href="https://github.com/shlomif/fc-solve">Freecell Solver program</a> uses
- AsciiDoc for its
- <a href="https://fc-solve.shlomifish.org/">distributed documentation</a>.
-</p>
-</li>
-<li>
-<p>
-Eric Raymond’s <a href="http://gpsd.berlios.de/AIVDM.html">AIVDM/AIVDO
- protocol decoding</a> documentation is written using AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Warren Block has <a href="http://www.wonkity.com/~wblock/docs/">posted a
- number of articles written using AsciiDoc</a>.
-</p>
-</li>
-<li>
-<p>
-The <a href="https://gitlab.com/ita1024/waf/">Waf project’s</a>
- <a href="https://waf.io/book/"><em>Waf Book</em></a> is written using AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-The <a href="http://www.diffkit.org/">DiffKit</a> project’s documentation and
- website have been written using Asciidoc.
-</p>
-</li>
-<li>
-<p>
-The <a href="http://www.networkupstools.org">Network UPS Tools</a> project
- <a href="http://www.networkupstools.org/documentation.html">documentation</a> is
- an example of a large documentation project written using AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-<a href="http://www.archlinux.org/pacman/">Pacman</a>, the
- <a href="http://www.archlinux.org/">Arch Linux</a> package manager, has been
- documented using AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-Suraj Kurapati has written a number of customized manuals for his
- Open Source projects using AsciiDoc:
-</p>
-<div class="ulist"><ul>
-<li>
-<p>
-<a href="http://snk.tuxfamily.org/lib/detest/">http://snk.tuxfamily.org/lib/detest/</a>
-</p>
-</li>
-<li>
-<p>
-<a href="http://snk.tuxfamily.org/lib/ember/">http://snk.tuxfamily.org/lib/ember/</a>
-</p>
-</li>
-<li>
-<p>
-<a href="http://snk.tuxfamily.org/lib/inochi/">http://snk.tuxfamily.org/lib/inochi/</a>
-</p>
-</li>
-<li>
-<p>
-<a href="http://snk.tuxfamily.org/lib/rumai/">http://snk.tuxfamily.org/lib/rumai/</a>
-</p>
-</li>
-</ul></div>
-</li>
-<li>
-<p>
-The <a href="http://cxxtest.com/">CxxTest</a> project (unit testing for C++
- language) has written its
- <a href="http://cxxtest.com/guide.html">User Guide</a> using AsciiDoc.
-</p>
-</li>
-<li>
-<p>
-The <a href="https://docs.fedoraproject.org/">Fedora Docs</a>
- website is generated using AsciiDoc.
-</p>
-</li>
-</ul></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="X1">LaTeX Backend</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>An 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). Due to
-other commitments, Benjamin was unable to maintain this backend.
-Here’s <a href="latex-backend.html">Benjamin’s original documentation</a>.
-Incompatibilities introduced after AsciiDoc 8.2.7 broke the LaTeX
-backend.</p></div>
-<div class="paragraph"><p>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
-<code>latex.conf</code> file shipped with AsciiDoc version 8.4.4. The backend
-still has limitations and remains experimental (see
-<a href="latex-bugs.html">Geoff’s notes</a>).</p></div>
-<div class="paragraph"><p>It’s probably also worth pointing out that LaTeX output can be
-generated by passing AsciiDoc generated DocBook through <code>dblatex(1)</code>.</p></div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_patches_and_bug_reports">Patches and bug reports</h2>
-<div class="sectionbody">
-<div class="paragraph"><p>Patches and bug reports are are encouraged, but please try to follow
-these guidelines:</p></div>
-<div class="ulist"><ul>
-<li>
-<p>
-Post bug reports and PRs to the
- <a href="https://github.com/asciidoc/asciidoc-py3">asciidoc-py3</a> repository.
-</p>
-</li>
-<li>
-<p>
-Post questions about using AsciiDoc or AsciiDoc syntax to the
- <a href="http://groups.google.com/group/asciidoc">asciidoc discussion list</a>,
- this keeps things transparent and gives everyone a chance to
- comment.
-</p>
-</li>
-</ul></div>
-<div class="sect2">
-<h3 id="_bug_reports">Bug reports</h3>
-<div class="ulist"><ul>
-<li>
-<p>
-When reporting problems please illustrate the problem with the
- smallest possible example that replicates the issue (and please test
- your example before posting). This technique will also help to
- eliminate red herrings prior to posting.
-</p>
-</li>
-<li>
-<p>
-Paste the commands that you executed along with any relevant
- outputs.
-</p>
-</li>
-<li>
-<p>
-Include the version of AsciiDoc and the platform you’re running it
- on.
-</p>
-</li>
-<li>
-<p>
-If you can program please consider writing a patch to fix the
- problem.
-</p>
-</li>
-</ul></div>
-</div>
-<div class="sect2">
-<h3 id="_pull_requests">Pull Requests</h3>
-<div class="ulist"><ul>
-<li>
-<p>
-Keep pull requests small and atomic (one issue per PR) — no patch
- bombs.
-</p>
-</li>
-<li>
-<p>
-If possible test your PR against the current master.
-</p>
-</li>
-<li>
-<p>
-If your PR adds or modifies functionality include a short example
- that illustrates the changes.
-</p>
-</li>
-<li>
-<p>
-Include documentation updates if you’re up to it; otherwise insert
- <em>TODO</em> comments at relevant places in the documentation.
-</p>
-</li>
-</ul></div>
-</div>
-</div>
-</div>
-</div>
-<div id="footnotes"><hr /></div>
-<div id="footer">
-<div id="footer-text">
-Version 9.1.0<br />
-Last updated 2021-09-19 06:37:11 UTC<br />
-AsciiDoc is a trademark of the Eclipse Foundation, Inc.
-</div>
-<div id="footer-badges">
-<a href="https://validator.w3.org/check?uri=referer">
- <img style="border:0;width:88px;height:31px"
- src="https://www.w3.org/Icons/valid-xhtml11-blue"
- alt="Valid XHTML 1.1" height="31" width="88" />
-</a>
-<a href="https://jigsaw.w3.org/css-validator/">
- <img style="border:0;width:88px;height:31px"
- src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
- alt="Valid CSS!" />
-</a>
-</div>
-</div>
-</div>
-</div>
-</body>
-</html>
+<!DOCTYPE html> +<meta charset="utf-8"> +<title>Redirecting to https://asciidoc-py.github.io</title> +<meta http-equiv="refresh" content="0; URL=https://asciidoc-py.github.io/"> +<link rel="canonical" href="https://asciidoc-py.github.io/"> |