From 5cc971753ed61089813f6038f6584aa6b096463c Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sat, 25 Dec 2021 16:13:23 -0500 Subject: Remove unused website files (#232) --- website/README-website.txt | 30 -- website/README.txt | 53 --- website/asciidoc-website.dict | 241 -------------- website/customers.csv | 18 - website/favicon.ico | Bin 1150 -> 0 bytes website/index.txt | 478 --------------------------- website/layout1.conf | 153 --------- website/layout1.css | 65 ---- website/layout2.conf | 154 --------- website/layout2.css | 83 ----- website/newlists.txt | 40 --- website/newtables.txt | 743 ------------------------------------------ website/plugins.txt | 115 ------- website/support.txt | 9 - website/version83.txt | 37 --- 15 files changed, 2219 deletions(-) delete mode 100644 website/README-website.txt delete mode 100644 website/README.txt delete mode 100644 website/asciidoc-website.dict delete mode 100644 website/customers.csv delete mode 100644 website/favicon.ico delete mode 100644 website/index.txt delete mode 100644 website/layout1.conf delete mode 100644 website/layout1.css delete mode 100644 website/layout2.conf delete mode 100644 website/layout2.css delete mode 100644 website/newlists.txt delete mode 100644 website/newtables.txt delete mode 100644 website/plugins.txt delete mode 100644 website/support.txt delete mode 100644 website/version83.txt diff --git a/website/README-website.txt b/website/README-website.txt deleted file mode 100644 index cb034f3..0000000 --- a/website/README-website.txt +++ /dev/null @@ -1,30 +0,0 @@ -AsciiDoc Website -================ - -The AsciiDoc website source is included in the AsciiDoc distribution -as an example of using AsciiDoc to build a website. The files are -principally located under `/doc` and `/website`, with a handful of -files pulled in from the root directory. - -A simple shell script (`./build_website.sh`) will -build the site's web pages -- just set the `LAYOUT` variable to the -desired layout. - -Website Layouts ---------------- -The website layout is determined by the layout configuration file -(`layout1.conf` or `layout2.conf`) and corresponding layout CSS file -(`layout1.css` or `layout2.css`). The example website comes with the -following layouts: - -[width="80%",cols="1,4",options="header"] -|==================================================================== -|Layout | Description -|layout1 | Table based layout -|layout2 | CSS based layout (this is the default layout) -|==================================================================== - -The default tables based layout (layout1) works with most modern -browsers. - -NOTE: The simulated frames layout (layout2) does not work with IE6. diff --git a/website/README.txt b/website/README.txt deleted file mode 100644 index 86fe699..0000000 --- a/website/README.txt +++ /dev/null @@ -1,53 +0,0 @@ -[float] -AsciiDoc -======== - -image:https://github.com/asciidoc/asciidoc-py3/workflows/Test/badge.svg?branch=master["Build Status", link="https://github.com/asciidoc/asciidoc-py3/actions?query=workflow%3ATest+branch%3Amaster"] - -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. - -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. - -Prerequisites -------------- -AsciiDoc is written in Python so you need a Python interpreter -(version 3.5 or later) to execute asciidoc(1). Python is installed by -default in most Linux distributions. You can download Python from the -official Python website https://www.python.org/. - - -Obtaining AsciiDoc ------------------- -AsciiDoc's Python 3 port is currently under development. To obtain AsciiDoc, -download a copy of the repo from the GitHub project at -https://github.com/asciidoc/asciidoc-py3 and follow the instructions in -INSTALL.txt to build and install it. - -Tools ------ -Current AsciiDoc version tested on Ubuntu 18.04 with: - -- Python 3.6.5 -- DocBook XSL Stylesheets 1.76.1 -- xsltproc (libxml 20706, libxslt 10126 and libexslt 815). -- w3m 0.5.2 -- dblatex 0.3 -- FOP 0.95 -- A-A-P 1.091 - - -Copying -------- -Copyright (C) 2002-2013 Stuart Rackham. - -Copyright (C) 2013-2020 AsciiDoc Contributors. - -Free use of this software is granted under the terms of the GNU General -Public License version 2 (GPLv2). - -AsciiDoc is a trademark of the Eclipse Foundation, Inc. diff --git a/website/asciidoc-website.dict b/website/asciidoc-website.dict deleted file mode 100644 index b3ca7e6..0000000 --- a/website/asciidoc-website.dict +++ /dev/null @@ -1,241 +0,0 @@ -personal_ws-1.1 en 240 -O'Reilly -awb -Blogpost -Bulleted -Iisaka -pygmentize -callouts -JavaScript -asciimath -tex -Philips -stylesheets -Rosenkraenzer -LaTexMathML -LaTeXMathML -latexmathml -Rapaz -ASCIIMathML -AsciiMathML -asciimathml -faq -Efros -stdin -LinuxDoc -slideshows -Klum -CentOS -src -plugin -Steen -passthroughs -AsciiDoc -asciidoc -blog -revdate -toc -css -Rosten -screenshot -CSW -Waf -slideshow -Wiese -ShareSource -Avsajanishvili -autowidth -Mandelson -HOWTO -newlists -Hajage -Jipsen -frontmatter -Suraj -dvi -backend -upperalpha -doctype -UNOCONV -dxf -Gentoo -Mowatt -SGML -raggedright -uri -Røsten -upperroman -Slackware -CouchDB -Wesnoth -matplotlib -adoc -Zuckschwerdt -stdout -usr -txt -ebooks -eBooks -ImageMagick -distros -Mowson -qanda -GPL -roff -README -Trotman -xhtml -Stylesheet -inline -weblog -xmllint -refentry -toolchains -Wieers -Debian -xml -filetype -asciidocapi -Pommereau -epub -Iisaka's -Hou -doctests -backends -Gingras -sinx -Romé -multi -autoconf -Dmitry -Volnitsky -AttributeList -Shlomi -outlang -Scala -xsltproc -ikiwiki -firefox -Hsu -xsl -iOS -arabic -Neuburg -Ilya -tablewidth -Kaczanowski -Volnitsky's -backmatter -RPMs -symlink -newtables -cd -Qingping -Calixto -scaledwidth -testasciidoc -linenumbering -xzf -xmlto -Lex -refname -html -online -lim -el -mkdir -Kurapati -Solaris -LilyPond -DelimitedBlocks -dx -eBook -hg -Gouichi -lang -conf -Tomek -wiki -Maier -Berker -Neo -js -AsciiDocGen -Portnov -CRAN -jw -ln -pygments -odf -lt -monospace -monospaced -Negroni -ly -programlisting -docname -OpenOffice -Schottelius -ps -dblatex -Ramaze -pdf -formulae -abc -py -LaTeX -ua -uB -precompiled -vB -latexmath -Wampler -chunked -Terje -SourceForge -ascii -Obenhuber's -CHANGLOG -DocBook -docbook -fontlocking -toolchain -slidy -ebuild -syntaxes -Tomayko -toclevels -Eychaner -OPF -Yannick -repo -github -plugins -Xubuntu -AsciiDoc's -png -Backtick -showcomments -revnumber -userguide -Potapov -Schauer -CHANGELOG -Koster -loweralpha -dBA -SCM -API -AttributeEntry -lowerroman -Rackham -callout -graphviz -Sakellariou -passthrough -asc -sqrt -TODO -GPLv -Cheatsheet -manpage diff --git a/website/customers.csv b/website/customers.csv deleted file mode 100644 index 01f862a..0000000 --- a/website/customers.csv +++ /dev/null @@ -1,18 +0,0 @@ -"AROUT","Around the Horn","Thomas Hardy","120 Hanover Sq. -London","(171) 555-7788" -"BERGS","Berglunds snabbkop","Christina Berglund","Berguvsvagen 8 -Lulea","0921-12 34 65" -"BLAUS","Blauer See Delikatessen","Hanna Moos","Forsterstr. 57 -Mannheim","0621-08460" -"BLONP","Blondel pere et fils","Frederique Citeaux","24, place Kleber -Strasbourg","88.60.15.31" -"BOLID","Bolido Comidas preparadas","Martin Sommer","C/ Araquil, 67 -Madrid","(91) 555 22 82" -"BONAP","Bon app'","Laurence Lebihan","12, rue des Bouchers -Marseille","91.24.45.40" -"BOTTM","Bottom-Dollar Markets","Elizabeth Lincoln","23 Tsawassen Blvd. -Tsawassen","(604) 555-4729" -"BSBEV","B's Beverages","Victoria Ashworth","Fauntleroy Circus -London","(171) 555-1212" -"CACTU","Cactus Comidas para llevar","Patricio Simpson","Cerrito 333 -Buenos Aires","(1) 135-5555" diff --git a/website/favicon.ico b/website/favicon.ico deleted file mode 100644 index 2dc2b43..0000000 Binary files a/website/favicon.ico and /dev/null differ diff --git a/website/index.txt b/website/index.txt deleted file mode 100644 index c1d5db1..0000000 --- a/website/index.txt +++ /dev/null @@ -1,478 +0,0 @@ -AsciiDoc Home Page -================== -// Web page meta data. -:keywords: AsciiDoc, DocBook, EPUB, PDF, ebooks, slideshow, slidy, man page -:description: 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. - - -.{revdate}: AsciiDoc {revnumber} Released -************************************************************************ -Read the link:CHANGELOG.html[CHANGELOG] for release highlights and a -full list of all additions, changes and bug fixes. Changes are -documented in the updated link:userguide.html[User Guide]. See the -link:INSTALL.html[Installation page] for downloads and and -installation instructions. -************************************************************************ - -Introduction ------------- -{description} - -AsciiDoc.py is a legacy processor for this syntax, handling an older -rendition of AsciiDoc. As such, this will not properly handle the -https://projects.eclipse.org/projects/technology.asciidoc[current AsciiDoc specification]. -It is suggested that unless you specifically require the AsciiDoc.py -toolchain, you should find a processor that handles the modern AsciiDoc -syntax. - -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. - -AsciiDoc.py is free software and is licensed under the terms of the 'GNU -General Public License version 2' (GPLv2). - -TIP: The pages you are reading were written using AsciiDoc, to view -the corresponding AsciiDoc source click on the *Page Source* menu item -in the left hand margin. - - -Overview and Examples ---------------------- -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 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 -~~~~~~~~~~~~~~~~ -- This XHTML version of the - link:asciidoc.css-embedded.html[AsciiDoc User Guide] - was generated by AsciiDoc from - link:asciidoc.txt[this AsciiDoc file]. - -- Here's the link:asciidoc.html[same document] created by first - generating DocBook markup using AsciiDoc and then converting the - DocBook markup to HTML using 'DocBook XSL Stylesheets'. - -- The User Guide again, this time a - link:chunked/index.html[chunked version]. - -- AsciiDoc generated this link:article-standalone.html[stand-alone - HTML file] containing embedded CSS, JavaScript and images from this - link:article.txt[AsciiDoc article template] with this command: - - asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt - -- The same link:article.txt[AsciiDoc article template] generated - link:article-html5-toc2.html[this HTML 5] (the 'toc2' attribute puts - a table of contents in the left margin) from this command: - - asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt - -- The same link:article.txt[AsciiDoc article template] produced - this link:article.html[HTML file] and this - link:article.pdf[PDF file] via DocBook markup generated by AsciiDoc. - -[[X7]] -Example Books -~~~~~~~~~~~~~ -AsciiDoc markup supports all the standard DocBook frontmatter and -backmatter sections (dedication, preface, bibliography, glossary, -index, colophon) plus footnotes and index entries. - -- This link:book.txt[AsciiDoc book] produced link:book.html[this HTML - file] using the 'DocBook XSL Stylesheets'. -- The link:asciidoc.pdf[PDF formatted AsciiDoc User Guide] was - generated from asciidoc(1) DocBook output. -- The link:asciidoc.epub[EPUB formatted AsciiDoc User Guide] was - generated using link:a2x.1.html[a2x]. -- This link:book.epub[EPUB formatted book skeleton] was generated - using link:a2x.1.html[a2x]. -- This link:book-multi.txt[multi-part AsciiDoc book] produced - link:book-multi.html[this HTML file] using the 'DocBook XSL - Stylesheets'. - -Example UNIX Man Pages -~~~~~~~~~~~~~~~~~~~~~~ -HTML formatted AsciiDoc man pages -link:asciidoc.1.css-embedded.html[with stylesheets] and -link:asciidoc.1.html[without stylesheets] were generated by AsciiDoc -from link:asciidoc.1.txt[this file]. - -This link:asciidoc.1[roff formatted man page] was generated from -asciidoc(1) DocBook output using `xsltproc(1)` and DocBook XSL -Stylesheets. - -[[X8]] -Example Slideshows -~~~~~~~~~~~~~~~~~~ -The https://www.w3.org/Talks/Tools/Slidy2/[Slidy] 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. - -- Here is the link:slidy.html[slidy backend documentation] slideshow - and here is it's link:slidy.txt[AsciiDoc source]. -- An link:slidy-example.html[example slidy slideshow] and the - link:slidy-example.txt[AsciiDoc source]. - -Example Web Site -~~~~~~~~~~~~~~~~ -The link:README-website.html[AsciiDoc website] is included in the -AsciiDoc distribution (in `./website/` and `./docs/`) as an example website -built using AsciiDoc. See `./website/README-website.txt`. - -More examples -~~~~~~~~~~~~~ -- See below: <>. -- Example link:newtables.html[Tables]. - - -eBook Publication ------------------ -The two most popular open eBook formats are -https://en.wikipedia.org/wiki/EPUB[EPUB] and PDF. -The AsciiDoc link:a2x.1.html[a2x] toolchain wrapper makes it easy to -link:publishing-ebooks-with-asciidoc.html[publish EPUB and PDF eBooks -with AsciiDoc]. See also <> and -link:epub-notes.html[AsciiDoc EPUB Notes]). - - -Blogpost weblog client ----------------------- -https://srackham.wordpress.com/blogpost-readme/[blogpost] is a -command-line weblog client for publishing AsciiDoc documents to -https://wordpress.org/[WordPress] blog hosts. It creates and updates -weblog posts and pages directly from AsciiDoc source documents. - - -Source code highlighter ------------------------ -AsciiDoc includes a link:source-highlight-filter.html[source code -highlighter filter] that uses -https://www.gnu.org/software/src-highlite/[GNU source-highlight] to -highlight HTML outputs. You also have the option of using the -https://pygments.org/[Pygments] highlighter. - - -[[X3]] -Mathematical Formulae ---------------------- -You can include mathematical formulae in AsciiDoc XHTML documents using -link:asciimath.html[ASCIIMath] or link:latexmathml.html[LaTeXMathML] -notation. - -The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX -source to an image that is automatically inserted into the AsciiDoc -output documents. - -AsciiDoc also has 'latexmath' macros for DocBook outputs -- they are -documented in link:latexmath.pdf[this PDF file] and can be used in -AsciiDoc documents processed by `dblatex(1)`. - - -Editor Support --------------- -- An AsciiDoc syntax highlighter for the Vim text editor is included in Vim. -+ -.Syntax highlighter screenshot -image::images/highlighter.png[height=400,caption="",link="images/highlighter.png"] - -- Dag Wieers has implemented an alternative Vim syntax file for - AsciiDoc which can be found here - https://github.com/dagwieers/asciidoc-vim. -- David Avsajanishvili has written a source highlighter for AsciiDoc - files for https://wiki.gnome.org/Projects/GtkSourceView[GtkSourceView] - (used by https://wiki.gnome.org/Apps/Gedit[gedit] and a number of - other applications). The project is hosted here: - https://launchpad.net/asciidoc-gtk-highlight -- AsciiDoc resources for the Emacs editor can be found on the - https://www.emacswiki.org/emacs/AsciiDoc[AsciiDoc page] at the - https://www.emacswiki.org/emacs/EmacsWiki[Emacs Wiki]. -- Christian Zuckschwerdt has written a - https://github.com/zuckschwerdt/asciidoc.tmbundle[TextMate bundle] - for AsciiDoc. - - -Try AsciiDoc on the Web ------------------------ -Thaddée Tyl has written an online live editor named -https://espadrine.github.io/AsciiDocBox/[AsciiDocBox] to try AsciiDoc in -your browser. - -You can use https://gist.asciidoctor.org/[DocGist] to preview AsciiDoc -files hosted on GitHub, Dropbox, and other services. DocGist also -features a real-time collaboration mode. - -[[X2]] -External Resources and Applications ------------------------------------ -Here are various useful resources, feel free to open a pull request to -add additional ones: - -- Check the link:INSTALL.html#X2[installation page] for packaged versions - of AsciiDoc. -- https://asciidoctor.org/[Asciidoctor] 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. -- Alex Efros has written an HTML formatted - https://powerman.name/doc/asciidoc[AsciiDoc Cheatsheet] using AsciiDoc. - The Asciidoctor project also provides a comprehensive - https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[AsciiDoc - syntax quick reference]. However, the syntax supported by Asciidoctor differs - slightly, see - https://docs.asciidoctor.org/asciidoctor/latest/migrate/asciidoc-py/#updated-and-deprecated-asciidoc-syntax[this page] - for more details. -- The http://remips.sourceforge.net/[ReMIPS] project website has been - built using AsciiDoc. -- Here are some link:asciidoc-docbook-xsl.html[DocBook XSL Stylesheets - Notes]. -- Karl Mowatt-Wilson has developed an http://ikiwiki.info/[ikiwiki] - plugin for AsciiDoc which he uses to render - http://mowson.org/karl[his website]. The plugin is available - http://www.mowson.org/karl/colophon/[here] and there is some - discussion of the ikiwiki integration - http://ikiwiki.info/users/KarlMW/discussion/[here]. -- Glenn Eychaner has - http://groups.google.com/group/asciidoc/browse_thread/thread/bf04b55628efe214[reworked - the Asciidoc plugin for ikiwiki] that was created by Karl Mowson. -- David Hajage has written an AsciiDoc package for the - http://www.r-project.org/[R Project] (R is a free software - environment for statistical computing). 'ascii' is available on - 'CRAN' (just run `install.packages("ascii")` from R). Briefly, - 'ascii' replaces R results in AsciiDoc document with AsciiDoc - markup. More information and examples here: - http://eusebe.github.com/ascii/. -- Jared Henley has written - https://jared.henley.id.au/software/awb/[AsciiDoc - Website Builder]. 'AsciiDoc Website Builder' (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. -- Filippo Negroni has developed a set of tools to facilitate 'literate - programming' using AsciiDoc. The set of tools is called - http://eweb.sourceforge.net/[eWEB]. -- https://vanderwijk.info/[Ivo's blog] describes a - https://ditaa.sourceforge.net/[ditaa] filter for AsciiDoc which converts - https://en.wikipedia.org/wiki/ASCII_art[ASCII art] into graphics. -- https://github.com/gollum/gollum[Gollum] is a git-powered wiki, it - supports various formats, including AsciiDoc. -- Gregory Romé has written an - https://github.com/gpr/redmine_asciidoc_formatter[AsciiDoc plugin] - for the https://www.redmine.org/[Redmine] project management - application. -- Paul Hsu has started a - https://github.com/paulhsu/AsciiDoc.CHT.userguide[Chinese translation - of the AsciiDoc User Guide]. -- Dag Wieers has written - http://dag.wieers.com/home-made/unoconv/[UNOCONV]. 'UNOCONV' can - export AsciiDoc outputs to OpenOffice export formats. -- Ed Keith has written - https://sourceforge.net/projects/codeextactor.berlios/[Code Extractor], - it extracts code snippets from source code files and - inserts them into AsciiDoc documents. -- Ryan Tomayko has written an number of - https://github.com/rtomayko/adoc-themes[themes for AsciiDoc]. -- Lex Trotman has written - https://github.com/elextr/codiicsa[codiicsa], a program that - converts DocBook to AsciiDoc. -- Qingping Hou has written https://houqp.github.io/asciidoc-deckjs/[an - AsciiDoc backend for deck.js]. - http://imakewebthings.com/deck.js/[deck.js] is a JavaScript - library for building modern HTML presentations (slideshows). -- The guys from O'Reilly Media have posted an - https://github.com/oreillymedia/docbook2asciidoc[XSL Stylesheet to -github] that converts DocBook to AsciiDoc. -- Lex Trotman has written - https://github.com/elextr/flexndex[flexndex], an index generator - tool that be used with AsciiDoc. -- Michael Haberler has created a - https://code.google.com/archive/p/asciidoc-diag-filter/[blockdiag filter - for AsciiDoc] which embeds http://blockdiag.com/en/[blockdiag] images in - AsciiDoc documents. -- Dan Allen has written a - https://github.com/mojavelinux/asciidoc-bootstrap-docs-backend[Bootstrap - backend] for AsciiDoc. -- Steven Boscarine has written - https://github.com/StevenBoscarine/JavaAsciidocWrapper[Maven wrapper for AsciiDoc]. -- Christian Goltz has written - https://github.com/christiangoltz/shaape[Shaape], an Ascii art to - image converter for AsciiDoc. -- Eduardo Santana has written an - https://github.com/edusantana/asciidoc-highlight[Asciidoc Highlight - for Notepad++]. -- https://www.geany.org/[Geany] 1.23 adds document structure support - for AsciiDoc. - -Please let me know if any of these links need updating. - - -[[X6]] -Documents written using AsciiDoc --------------------------------- -Here are some documents I know of, if you know of more drop me a line -and I'll add them to the list. - -- The book http://practicalunittesting.com/[Practical Unit Testing] by - Tomek Kaczanowski was - https://groups.google.com/group/asciidoc/browse_frm/thread/4ba13926262efa23[written - using Asciidoc]. - -- The book - https://www.oreilly.com/library/view/programming-ios-4/9781449397302/[Programming iOS 4] - by Matt Neuburg was written using AsciiDoc. Matt has - https://www.apeth.net/matt/iosbooktoolchain.html[written an article] - describing how he used AsciiDoc and other tools to write the book. - -- The book - https://www.oreilly.com/library/view/programming-scala/9780596801908/[Programming - Scala] by Dean Wampler and Alex Payne (O'Reilly) was - http://groups.google.com/group/asciidoc/browse_frm/thread/449f1199343f0e27[written - using Asciidoc]. - -- The Neo4j graph database project uses Asciidoc, and the output is - published here: https://neo4j.com/docs/. The build process includes - live tested source code snippets and is described - http://groups.google.com/group/asciidoc/browse_thread/thread/49d570062fd3ff52[here]. - -- https://frugalware.org/[Frugalware Linux] uses AsciiDoc for - https://frugalware.org/docs[documentation]. -- http://www.cherokee-project.com/doc/[Cherokee documentation]. - -- Henrik Maier produced this professional User manual using AsciiDoc: - http://www.proconx.com/assets/files/products/modg100/UMMBRG300-1101.pdf - -- Henrik also produced this folded single page brochure format - example: - http://www.proconx.com/assets/files/products/modg100/IGMBRG300-1101-up.pdf -+ -See this -http://groups.google.com/group/asciidoc/browse_thread/thread/16ab5a06864b934f[AsciiDoc -discussion group thread] for details. - -- The - https://mirrors.edge.kernel.org/pub/software/scm/git/docs/user-manual.html[Git - User's Manual]. -- 'Git Magic' + - http://www-cs-students.stanford.edu/~blynn/gitmagic/ + - https://github.com/blynn/gitmagic -- 'CouchDB: The Definitive Guide' + - https://docs.couchdb.org/en/stable/ + - https://groups.google.com/g/asciidoc/c/pg9ny7r4Yqo -- 'Ramaze Manual' + - http://book.ramaze.net/ + - http://github.com/manveru/ramaze-book -- The https://github.com/manveru/KirbyBase[KirbyBase for Ruby] - database management system manual. -- The http://xpt.sourceforge.net/[*Nix Power Tools project] uses - AsciiDoc for documentation. -- The http://www.wesnoth.org/[Battle for Wesnoth] project uses - AsciiDoc for its http://www.wesnoth.org/wiki/WesnothManual[Manual] - in a number of different languages. -- Troy Hanson uses AsciiDoc to generate user guides for the - https://troydhanson.github.io/tpl/index.html[tpl] and - https://troydhanson.github.io/uthash/index.html[uthash] projects - (the HTML versions have a customised contents sidebar). -- https://weechat.org/[WeeChat] uses AsciiDoc for - https://weechat.org/doc/[project documentation]. -- https://github.com/Clansuite/Clansuite[Clansuite] uses AsciiDoc for - project documentation. -- The https://github.com/shlomif/fc-solve[Freecell Solver program] uses - AsciiDoc for its - https://fc-solve.shlomifish.org/[distributed documentation]. -- Eric Raymond's http://gpsd.berlios.de/AIVDM.html[AIVDM/AIVDO - protocol decoding] documentation is written using AsciiDoc. -- Warren Block has http://www.wonkity.com/~wblock/docs/[posted a - number of articles written using AsciiDoc]. -- The https://gitlab.com/ita1024/waf/[Waf project's] - https://waf.io/book/['Waf Book'] is written using AsciiDoc. -- The http://www.diffkit.org/[DiffKit] project's documentation and - website have been written using Asciidoc. -- The http://www.networkupstools.org[Network UPS Tools] project - http://www.networkupstools.org/documentation.html[documentation] is - an example of a large documentation project written using AsciiDoc. -- http://www.archlinux.org/pacman/[Pacman], the - http://www.archlinux.org/[Arch Linux] package manager, has been - documented using AsciiDoc. -- Suraj Kurapati has written a number of customized manuals for his - Open Source projects using AsciiDoc: - - * http://snk.tuxfamily.org/lib/detest/ - * http://snk.tuxfamily.org/lib/ember/ - * http://snk.tuxfamily.org/lib/inochi/ - * http://snk.tuxfamily.org/lib/rumai/ - -- The http://cxxtest.com/[CxxTest] project (unit testing for C++ - language) has written its - http://cxxtest.com/guide.html[User Guide] using AsciiDoc. -- The https://docs.fedoraproject.org/[Fedora Docs] - website is generated using AsciiDoc. - -[[X1]] -LaTeX Backend -------------- -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 link:latex-backend.html[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 -link:latex-bugs.html[Geoff's notes]). - -It's probably also worth pointing out that LaTeX output can be -generated by passing AsciiDoc generated DocBook through `dblatex(1)`. - - -Patches and bug reports ------------------------ -Patches and bug reports are are encouraged, but please try to follow -these guidelines: - -- Post bug reports and PRs to the - https://github.com/asciidoc/asciidoc-py3[asciidoc-py3] repository. -- Post questions about using AsciiDoc or AsciiDoc syntax to the - http://groups.google.com/group/asciidoc[asciidoc discussion list], - this keeps things transparent and gives everyone a chance to - comment. - -=== Bug reports -- 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. -- Paste the commands that you executed along with any relevant - outputs. -- Include the version of AsciiDoc and the platform you're running it - on. -- If you can program please consider writing a patch to fix the - problem. - -=== Pull Requests -- Keep pull requests small and atomic (one issue per PR) -- no patch - bombs. -- If possible test your PR against the current master. -- If your PR adds or modifies functionality include a short example - that illustrates the changes. -- Include documentation updates if you're up to it; otherwise insert - 'TODO' comments at relevant places in the documentation. - diff --git a/website/layout1.conf b/website/layout1.conf deleted file mode 100644 index cd45caf..0000000 --- a/website/layout1.conf +++ /dev/null @@ -1,153 +0,0 @@ -# -# AsciiDoc website. -# Three division table based layout (layout1). -# NOTE: You should probably use the the pure CSS layout -# (layout2.conf). -# -# +-----------------------------------------------------+ -# | #layout-banner | -# +--------------+--------------------------------------+ -# | | | -# | | | -# | #layout-menu | #layout-content | -# | | | -# | | | -# | | | -# +--------------+--------------------------------------+ -# -# - The #layout-menu and #layout-content divisions are contained in a -# two cell table. -# - The #layout-content division is a container for AsciiDoc page documents. -# - Documents rendered in the #layout-content use the standard AsciiDoc -# xhtml11 backend stylesheets. - -[specialwords] -monospacedwords=\\?\basciidoc\(1\) \\?\ba2x\(1\) - -[header] - - - - - - - -{title} -{title%}{doctitle=} - -{doctype-manpage} -ifdef::quirks[] - -endif::quirks[] - - - -ifdef::asciimath[] - -endif::asciimath[] -ifdef::latexmath[] - -endif::latexmath[] - - -
-
AsciiDoc
-
Text based document generation
-
- - - - - -
- - - -
»FAQ
- - -
»API
- - - - - -
»Page Source
-		 -
-# Article, book header. -ifndef::doctype-manpage[] - -endif::doctype-manpage[] -# Man page header. -ifdef::doctype-manpage[] - -endif::doctype-manpage[] -
- -[footer] -
-{disable-javascript%
} - -
-
- - diff --git a/website/layout1.css b/website/layout1.css deleted file mode 100644 index 30bd65d..0000000 --- a/website/layout1.css +++ /dev/null @@ -1,65 +0,0 @@ -body { - background-color: white; - margin: 1%; -} - -h1 { - margin-top: 0.5em; -} - -#layout-banner { - background-color: #73a0c5; - color: white; - font-family: Arial,Helvetica,sans-serif; - text-align: left; - padding: 0.8em 20px; -} - -#layout-title { - font-family: "Courier New", Courier, monospace; - font-size: 3.5em; - font-weight: bold; - letter-spacing: 0.2em; - margin: 0; -} - -#layout-description { - font-size: 1.2em; - letter-spacing: 0.1em; -} - -#layout-menu { - background-color: #f4f4f4; - border-right: 3px solid #eeeeee; - padding-top: 0.8em; - padding-left: 20px; - padding-right: 0.8em; - font-size: 1.1em; - font-family: Arial,Helvetica,sans-serif; - font-weight: bold; -} -#layout-menu a { - line-height: 2em; - margin-left: 0.5em; -} -#layout-menu a:link, #layout-menu a:visited, #layout-menu a:hover { - color: #527bbd; - text-decoration: none; -} -#layout-menu a:hover { - color: navy; - text-decoration: none; -} -#layout-menu #page-source { - border-top: 2px solid silver; - margin-top: 0.2em; -} - -#layout-content { - margin-left: 1.0em; -} - -@media print { - #layout-banner { display: none; } - #layout-menu { display: none; } -} diff --git a/website/layout2.conf b/website/layout2.conf deleted file mode 100644 index 9339a09..0000000 --- a/website/layout2.conf +++ /dev/null @@ -1,154 +0,0 @@ -# -# AsciiDoc website. -# Three division CSS based layout (layout2). -# -# Simulated frames using CSS (fixed banner and menu, scrolling content). -# NOTE: This layout does not work with IE6. -# -# +-----------------------------------------------------+ -# | #layout-banner | -# +--------------+--------------------------------------+ -# | | | -# | | | -# | #layout-menu | #layout-content | -# | | | -# | | | -# | | | -# +--------------+--------------------------------------+ -# -# Each of the three divisions is enclosed in a same-named *-box division -# which position and size the layout. -# -# - The #layout-content division is a container for AsciiDoc page documents. -# - Documents rendered in the #layout-content use the standard AsciiDoc -# xhtml11 backend stylesheets. - -[specialwords] -monospacedwords=\\?\basciidoc\(1\) \\?\ba2x\(1\) - -[header] - - - - - - - -{title} -{title%}{doctitle=} - -{doctype-manpage} -ifdef::quirks[] - -endif::quirks[] - - - -ifdef::asciimath[] - -endif::asciimath[] -ifdef::latexmath[] - -endif::latexmath[] - - -
-
- - - -
»FAQ
- - -
»API
- - - - - -
»Page Source
-
-
-
-
-
AsciiDoc
-
Text based document generation
-
-
-# Article, book header. -ifndef::doctype-manpage[] - -endif::doctype-manpage[] -# Man page header. -ifdef::doctype-manpage[] - -endif::doctype-manpage[] -
- -[footer] -
-{disable-javascript%
} - -
-
- - diff --git a/website/layout2.css b/website/layout2.css deleted file mode 100644 index 5ca46dc..0000000 --- a/website/layout2.css +++ /dev/null @@ -1,83 +0,0 @@ -body { - margin: 0; -} - -#layout-menu-box { - position: fixed; - left: 0px; - top: 0px; - width: 160px; - height: 100%; - z-index: 1; - background-color: #f4f4f4; -} - -#layout-content-box { - position: relative; - margin-left: 160px; - background-color: white; -} - -h1 { - margin-top: 0.5em; -} - -#layout-banner { - color: white; - background-color: #73a0c5; - font-family: Arial,Helvetica,sans-serif; - text-align: left; - padding: 0.8em 20px; -} - -#layout-title { - font-family: "Courier New", Courier, monospace; - font-size: 3.5em; - font-weight: bold; - letter-spacing: 0.2em; - margin: 0; -} - -#layout-description { - font-size: 1.2em; - letter-spacing: 0.1em; -} - -#layout-menu { - height: 100%; - border-right: 3px solid #eeeeee; - padding-top: 0.8em; - padding-left: 15px; - padding-right: 0.8em; - font-size: 1.0em; - font-family: Arial,Helvetica,sans-serif; - font-weight: bold; -} -#layout-menu a { - line-height: 2em; - margin-left: 0.5em; -} -#layout-menu a:link, #layout-menu a:visited, #layout-menu a:hover { - color: #527bbd; - text-decoration: none; -} -#layout-menu a:hover { - color: navy; - text-decoration: none; -} -#layout-menu #page-source { - border-top: 2px solid silver; - margin-top: 0.2em; -} - -#layout-content { - padding-top: 0.2em; - padding-left: 1.0em; - padding-right: 0.4em; -} - -@media print { - #layout-banner-box { display: none; } - #layout-menu-box { display: none; } - #layout-content-box { margin-top: 0; margin-left: 0; } -} diff --git a/website/newlists.txt b/website/newlists.txt deleted file mode 100644 index 3edc3a7..0000000 --- a/website/newlists.txt +++ /dev/null @@ -1,40 +0,0 @@ -AsciiDoc New Lists -================== - -*New in version 8.3.0* - -Lists can now be styled like other block elements, this allows the -normal bulleted and labeled list syntax to be used for 'glossary', -'qanda' (Question and Answer) and 'bibliography' lists instead of -having to remember a different syntax for each one. In the same vein -there is only one labeled list syntax, horizontal labeled lists are -rendered by applying the 'horizontal' style. Examples: - ---------------------------------------------------------------------- -[glossary] -A glossary term:: - The corresponding definition. -A second glossary term:: - The corresponding definition. - -[horizontal] -Lorem:: Fusce euismod commodo velit. -Ipsum:: Vivamus fringilla mi eu lacus. ---------------------------------------------------------------------- - -The list related stuff in the configuration files has been -rationalized with separate 'listtags-\*' sections (c.f. table -'tabletags-*' sections). The old list tags are no longer supported so -you'll need to update your custom configuration file list definitions. - -These changes necessitated the following backward incompatibilities: - -. You have to explicitly precede horizontal labeled lists with the - `[horizontal]` style attribute -- if you do nothing the existing - horizontal labeled lists will be rendered vertically. -. The old 'compact' list style is now implemented as a list option, to - update replace `[compact]` with `[options="compact"]`. You can now - apply the 'compact' option globally by setting the `compact-option` - document attribute. -. You'll need to update any customized configuration file list - definitions that have been made. diff --git a/website/newtables.txt b/website/newtables.txt deleted file mode 100644 index 0c6e52c..0000000 --- a/website/newtables.txt +++ /dev/null @@ -1,743 +0,0 @@ -AsciiDoc New tables -=================== - -*New in version 8.3.0* - -I've finally come up with a 'new tables' syntax that I'm happy with -and can at last remove this footnote from the 'User Guide': ``The -current table syntax is overly complicated and unwieldy to edit, -hopefully a more usable syntax will appear in future versions of -AsciiDoc.'' - -.Update -********************************************************************* -The following additions were made at AsciiDoc 8.4.4: - -- Cell column and row spanning. -- Styles can be applied per cell. -- Vertical cell alignment can be applied to columns and cells. - -See the examples at the end of this document. -********************************************************************* - -At first glance it doesn't look much different to the old syntax but -it's a lot more flexible, easier to enter and supports a lot of column -styles (for example the 'asciidoc' style supports AsciiDoc block and -inline elements). The old tables syntax has been deprecated but is -currently still processed. Here are some examples of AsciiDoc 'new -tables': - -.Simple table -[width="15%"] -|======= -|1 |2 |A -|3 |4 |B -|5 |6 |C -|======= - -.AsciiDoc source ---------------------------------------------------------------------- -[width="15%"] -|======= -|1 |2 |A -|3 |4 |B -|5 |6 |C -|======= ---------------------------------------------------------------------- - - -.Table with title, header and footer -[width="40%",frame="topbot",options="header,footer"] -|====================== -|Column 1 |Column 2 -|1 |Item 1 -|2 |Item 2 -|3 |Item 3 -|6 |Three items -|====================== - -.AsciiDoc source ---------------------------------------------------------------------- -.An example table -[width="40%",frame="topbot",options="header,footer"] -|====================== -|Column 1 |Column 2 -|1 |Item 1 -|2 |Item 2 -|3 |Item 3 -|6 |Three items -|====================== ---------------------------------------------------------------------- - - -.Columns formatted with strong, monospaced and emphasis styles -[width="50%",cols=">s,^2m,^2e",frame="topbot",options="header,footer"] -|========================== -| 2+|Columns 2 and 3 -|1 |Item 1 |Item 1 -|2 |Item 2 |Item 2 -|3 |Item 3 |Item 3 -|4 |Item 4 |Item 4 -|footer 1|footer 2|footer 3 -|========================== - -.AsciiDoc source ---------------------------------------------------------------------- -.An example table -[width="50%",cols=">s,^2m,^2e",frame="topbot",options="header,footer"] -|========================== -| 2+|Columns 2 and 3 -|1 |Item 1 |Item 1 -|2 |Item 2 |Item 2 -|3 |Item 3 |Item 3 -|4 |Item 4 |Item 4 -|footer 1|footer 2|footer 3 -|========================== ---------------------------------------------------------------------- - -.A table with externally sourced CSV data -[format="csv",cols="^1,4*2",options="header"] -|=================================================== -ID,Customer Name,Contact Name,Customer Address,Phone -include::customers.csv[] -|=================================================== - -.AsciiDoc source ---------------------------------------------------------------------- - [format="csv",cols="^1,4*2",options="header"] - |=================================================== - ID,Customer Name,Contact Name,Customer Address,Phone - include::customers.csv[] - |=================================================== ---------------------------------------------------------------------- - - -.DVS formatted table -[width="70%",format="dsv"] -|==================================== -root:x:0:0:root:/root:/bin/bash -daemon:x:1:1:daemon:/usr/sbin:/bin/sh -bin:x:2:2:bin:/bin:/bin/sh -sys:x:3:3:sys:/dev:/bin/sh -sync:x:4:65534:sync:/bin:/bin/sync -games:x:5:60:games:/usr/games:/bin/sh -|==================================== - -.AsciiDoc source ---------------------------------------------------------------------- -[width="70%",format="dsv"] -|==================================== -root:x:0:0:root:/root:/bin/bash -daemon:x:1:1:daemon:/usr/sbin:/bin/sh -bin:x:2:2:bin:/bin:/bin/sh -sys:x:3:3:sys:/dev:/bin/sh -sync:x:4:65534:sync:/bin:/bin/sync -games:x:5:60:games:/usr/games:/bin/sh -|==================================== ---------------------------------------------------------------------- - - -.Horizontal and vertical source data -[width="80%",cols="3,^2,^2,10",options="header"] -|========================================================= -|Date |Duration |Avg HR |Notes - -|22-Aug-08 |10:24 | 157 | -Worked out MSHR (max sustainable heart rate) by going hard -for this interval. - -|22-Aug-08 |23:03 | 152 | -Back-to-back with previous interval. - -|24-Aug-08 |40:00 | 145 | -Moderately hard interspersed with 3x 3min intervals (2min -hard + 1min really hard taking the HR up to 160). - -|========================================================= - -Short cells can be entered horizontally, longer cells vertically. The -default behavior is to strip leading and trailing blank lines within a -cell. These characteristics aid readability and data entry. - -.AsciiDoc source ---------------------------------------------------------------------- -.Windtrainer workouts -[width="80%",cols="3,^2,^2,10",options="header"] -|========================================================= -|Date |Duration |Avg HR |Notes - -|22-Aug-08 |10:24 | 157 | -Worked out MSHR (max sustainable heart rate) by going hard -for this interval. - -|22-Aug-08 |23:03 | 152 | -Back-to-back with previous interval. - -|24-Aug-08 |40:00 | 145 | -Moderately hard interspersed with 3x 3min intervals (2min -hard + 1min really hard taking the HR up to 160). - -|========================================================= ---------------------------------------------------------------------- - - -.Default and verse styles -[cols=",^v",options="header"] -|=================================== -|Default paragraphs |Centered verses -2*|Per id. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. -|=================================== - -.AsciiDoc source ---------------------------------------------------------------------- -[cols=",^v",options="header"] -|=================================== -|Default paragraphs |Centered verses -2*|Per id. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. -|=================================== ---------------------------------------------------------------------- - - -.Horizontal and vertical headings -[cols="h,4*",options="header",width="50%"] -|================================== -| |West |Central |East | Total -|Q1 |270 |292 |342 | 904 -|Q2 |322 |276 |383 | 981 -|Q3 |298 |252 |274 | 824 -|Q4 |344 |247 |402 | 993 -|================================== - -.AsciiDoc source ---------------------------------------------------------------------- -.Horizontal and vertical headings -[cols="h,4*",options="header",width="50%"] -|================================== -| |West |Central |East | Total -|Q1 |270 |292 |342 | 904 -|Q2 |322 |276 |383 | 981 -|Q3 |298 |252 |274 | 824 -|Q4 |344 |247 |402 | 993 -|================================== ---------------------------------------------------------------------- - - -.AsciiDoc style in first column, Literal in second -[cols="asciidoc,literal",options="header",grid="cols"] -|================================== -|Output markup |AsciiDoc source -2*| -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - ------------------------------------ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. ------------------------------------ - -.Code filter example -[source,python] ------------------------------------ -''' A multi-line - comment.''' -def sub_word(mo): - ''' Single line comment.''' - word = mo.group('word') - if word in keywords[language]: - return quote + word + quote - else: - return word ------------------------------------ - -- Lorem ipsum dolor sit amet, - consectetuer adipiscing elit. - * Fusce euismod commodo velit. - * Qui in magna commodo, est labitur - dolorum an. Est ne magna primis - adolescens. Sit munere ponderum - dignissim et. Minim luptatum et vel. - * Vivamus fringilla mi eu lacus. - * Donec eget arcu bibendum nunc - consequat lobortis. -- Nulla porttitor vulputate libero. - . Fusce euismod commodo velit. - . Vivamus fringilla mi eu lacus. - -|================================== - -.AsciiDoc source -[listing] -..................................................................... -[cols="asciidoc,literal",options="header",grid="cols"] -|================================== -|Output markup |AsciiDoc source -2*| -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - ------------------------------------ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. ------------------------------------ - -.Code filter example -[source,python] ------------------------------------ -''' A multi-line - comment.''' -def sub_word(mo): - ''' Single line comment.''' - word = mo.group('word') - if word in keywords[language]: - return quote + word + quote - else: - return word ------------------------------------ - -- Lorem ipsum dolor sit amet, - consectetuer adipiscing elit. - * Fusce euismod commodo velit. - * Qui in magna commodo, est labitur - dolorum an. Est ne magna primis - adolescens. Sit munere ponderum - dignissim et. Minim luptatum et vel. - * Vivamus fringilla mi eu lacus. - * Donec eget arcu bibendum nunc - consequat lobortis. -- Nulla porttitor vulputate libero. - . Fusce euismod commodo velit. - . Vivamus fringilla mi eu lacus. - -|================================== -..................................................................... - - -.Cell containing lots of example markup elements -|==================================================================== -|'URLs': -https://asciidoc.org/[The AsciiDoc home page], -https://asciidoc.org/, -mailto:joe.bloggs@example.com[email Joe Bloggs], -joe.bloggs@example.com, -callto:joe.bloggs[]. - -'Link': See <>. - -'Emphasized text', *Strong text*, +Monospaced text+, ``Quoted text''. - -'Subscripts and superscripts': e^{amp}#960;i^+1 = 0. H~2~O and x^10^. -Some ^super text^ and ~some sub text~ - -'Replacements': (C) copyright, (TM) trademark, (R) registered trademark, --- em dash, ... ellipsis, -> right arrow, <- left arrow, => right -double arrow, <= left double arrow. -|==================================================================== - -[[X1]] -.AsciiDoc source ---------------------------------------------------------------------- -|==================================================================== -|'URLs': -https://asciidoc.org/[The AsciiDoc home page], -https://asciidoc.org/, -mailto:joe.bloggs@example.com[email Joe Bloggs], -joe.bloggs@example.com, -callto:joe.bloggs[]. - -'Link': See <>. - -'Emphasized text', *Strong text*, +Monospaced text+, ``Quoted text''. - -'Subscripts and superscripts': e^{amp}#960;i^+1 = 0. H~2~O and x^10^. -Some ^super text^ and ~some sub text~ - -'Replacements': (C) copyright, (TM) trademark, (R) registered trademark, --- em dash, ... ellipsis, -> right arrow, <- left arrow, => right -double arrow, <= left double arrow. -|==================================================================== ---------------------------------------------------------------------- - - -.Nested table -[width="75%",cols="1,2a"] -|============================================== -|Normal cell - -|Cell with nested table - -[cols="2,1"] -!============================================== -!Nested table cell 1 !Nested table cell 2 -!============================================== - -|============================================== - -.AsciiDoc source ---------------------------------------------------------------------- -[width="75%",cols="1,2a"] -|============================================== -|Normal cell - -|Cell with nested table - -[cols="2,1"] -!============================================== -!Nested table cell 1 !Nested table cell 2 -!============================================== - -|============================================== ---------------------------------------------------------------------- - - -.Spans, alignments and styles -[cols="e,m,^,>s",width="25%"] -|================ -|1 >s|2 |3 |4 -^|5 2.2+^.^|6 .3+<.>m|7 -^|8 -|9 2+>|10 -|================ - -.AsciiDoc source ---------------------------------------------------------------------- -.Spans, alignments and styles -[cols="e,m,^,>s",width="25%"] -|================ -|1 >s|2 |3 |4 -^|5 2.2+^.^|6 .3+<.>m|7 -^|8 -|9 2+>|10 -|================ ---------------------------------------------------------------------- - -.Three panes -[cols="a,2a"] -|================================== -| -[float] -Top Left Pane -~~~~~~~~~~~~~ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -.2+| -[float] -Right Pane -~~~~~~~~~~ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - ------------------------------------ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. ------------------------------------ - -.Code filter example -[source,python] ------------------------------------ -''' A multi-line - comment.''' -def sub_word(mo): - ''' Single line comment.''' - word = mo.group('word') - if word in keywords[language]: - return quote + word + quote - else: - return word ------------------------------------ - -- Lorem ipsum dolor sit amet, - consectetuer adipiscing elit. - * Fusce euismod commodo velit. - * Qui in magna commodo, est labitur - dolorum an. Est ne magna primis - adolescens. Sit munere ponderum - dignissim et. Minim luptatum et vel. - * Vivamus fringilla mi eu lacus. - * Donec eget arcu bibendum nunc - consequat lobortis. -- Nulla porttitor vulputate libero. - . Fusce euismod commodo velit. - . Vivamus fringilla mi eu lacus. - -| -[float] -Bottom Left Pane -~~~~~~~~~~~~~~~~ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -- Lorem ipsum dolor sit amet, - consectetuer adipiscing elit. - * Fusce euismod commodo velit. - * Qui in magna commodo, est labitur - dolorum an. Est ne magna primis - adolescens. Sit munere ponderum - dignissim et. Minim luptatum et vel. - * Vivamus fringilla mi eu lacus. - * Donec eget arcu bibendum nunc - consequat lobortis. -- Nulla porttitor vulputate libero. - . Fusce euismod commodo velit. - . Vivamus fringilla mi eu lacus. - -|================================== - -.AsciiDoc source -[listing] -..................................................................... -.Three panes -[cols="a,2a"] -|================================== -| -[float] -Top Left Pane -~~~~~~~~~~~~~ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -.2+| -[float] -Right Pane -~~~~~~~~~~ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - ------------------------------------ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. ------------------------------------ - -.Code filter example -[source,python] ------------------------------------ -''' A multi-line - comment.''' -def sub_word(mo): - ''' Single line comment.''' - word = mo.group('word') - if word in keywords[language]: - return quote + word + quote - else: - return word ------------------------------------ - -- Lorem ipsum dolor sit amet, - consectetuer adipiscing elit. - * Fusce euismod commodo velit. - * Qui in magna commodo, est labitur - dolorum an. Est ne magna primis - adolescens. Sit munere ponderum - dignissim et. Minim luptatum et vel. - * Vivamus fringilla mi eu lacus. - * Donec eget arcu bibendum nunc - consequat lobortis. -- Nulla porttitor vulputate libero. - . Fusce euismod commodo velit. - . Vivamus fringilla mi eu lacus. - -| -[float] -Bottom Left Pane -~~~~~~~~~~~~~~~~ -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -Consul *necessitatibus* per id, -consetetur, eu pro everti postulant -homero verear ea mea, qui. - -- Lorem ipsum dolor sit amet, - consectetuer adipiscing elit. - * Fusce euismod commodo velit. - * Qui in magna commodo, est labitur - dolorum an. Est ne magna primis - adolescens. Sit munere ponderum - dignissim et. Minim luptatum et vel. - * Vivamus fringilla mi eu lacus. - * Donec eget arcu bibendum nunc - consequat lobortis. -- Nulla porttitor vulputate libero. - . Fusce euismod commodo velit. - . Vivamus fringilla mi eu lacus. - -|================================== -..................................................................... - - -== Combinations of 'align', 'frame', 'grid', 'valign' and 'halign' attributes - -:frame: all -:grid: all -:halign: left -:valign: top - -[options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== - -.AsciiDoc source ---------------------------------------------------------------------- -:frame: all -:grid: all -:halign: left -:valign: top - -[options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== ---------------------------------------------------------------------- - - -:frame: sides -:grid: rows -:halign: center -:valign: middle - -.Table test -[width="50%",options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== - -.AsciiDoc source ---------------------------------------------------------------------- -:frame: sides -:grid: rows -:halign: center -:valign: middle - -.Table test -[width="50%",options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== ---------------------------------------------------------------------- - - -:frame: topbot -:grid: cols -:halign: right -:valign: bottom - -[align="right",width="50%",options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== - -.AsciiDoc source ---------------------------------------------------------------------- -:frame: topbot -:grid: cols -:halign: right -:valign: bottom - -[align="right",width="50%",options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== ---------------------------------------------------------------------- - - -:frame: none -:grid: none -:halign: left -:valign: top - -[align="center",width="50%",options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== - -.AsciiDoc source ---------------------------------------------------------------------- -:frame: none -:grid: none -:halign: left -:valign: top - -[align="center",width="50%",options="header"] -|==== -||frame | grid |valign |halign -v|  -  -  -|{frame} | {grid} |{valign} |{halign} -|==== ---------------------------------------------------------------------- - -:frame!: -:grid!: -:halign!: -:valign!: - diff --git a/website/plugins.txt b/website/plugins.txt deleted file mode 100644 index 20b85fc..0000000 --- a/website/plugins.txt +++ /dev/null @@ -1,115 +0,0 @@ -AsciiDoc Plugins -================ - - -A list of backend, filter and theme link:userguide.html#X101[AsciiDoc -plugins]. - -If you have implemented a plugin and it's not in the list, please open -a pull request in our https://github.com/asciidoc/asciidoc-py3[GitHub -repository]. - -[NOTE] -These plugins mostly targeted older versions of AsciiDoc that utilized -python2 and may not work for AsciiDoc 9.0+. - -[[X1]] -[cols="1e,1,3,3",frame="topbot",options="header"] -.Backend Plugins -|==== -|Backend name |Author |Home page |Description - -|9man -|Alex Efros -|https://powerman.name/asciidoc/ -|A backend plugin to generate man pages (troff) compatible with OS -Inferno and Plan9. - -|blogger -|Stuart Rackham -|https://github.com/srackham/asciidoc-blogger-backend -|Generates Blogger friendly HTML from AsciiDoc source. - -|deckjs -|Qingping Hou -|https://houqp.github.io/asciidoc-deckjs/ -|A 'deck.js' backend for AsciiDoc. - -|fossil -|Stuart Rackham -|https://github.com/srackham/asciidoc-fossil-backend -|Generates Fossil friendly Wiki markup from AsciiDoc source. - -|ODF -|Dag Wieers -|https://github.com/dagwieers/asciidoc-odf -|Backends for generating LibreOffice/OpenOffice Writer (`.fodt`) files -and LibreOffice/OpenOffice Impress (`.fodp`) files. - -|slidy2 -|Jean-Michel Inglebert -|https://code.google.com/archive/p/asciidoc-slidy2-backend-plugin/ -|Enhanced slidy backend. - -|wordpress -|Stuart Rackham -|https://srackham.wordpress.com/blogpost-readme/ -|Generates WordPress friendly markup and is part of the -https://srackham.wordpress.com/blogpost-readme/[blogpost] project. - -|==== - - -[[X2]] -[cols="1e,1,3,3",frame="topbot",options="header"] -.Filter Plugins -|==== -|Filter name |Author |Home page |Description - -|aafigure |Henrik Maier -|https://github.com/hwmaier/asciidoc-aafigure-filter -|https://launchpad.net/aafigure[Aafigure] ASCII line art filter. - -|diag |Michael Haberler -|https://code.google.com/archive/p/asciidoc-diag-filter/ -|http://blockdiag.com/[blockdiag] diagrams filter. - -|ditaa |Henrik Maier -|https://github.com/hwmaier/asciidoc-ditaa-filter -|http://ditaa.sourceforge.net[ditaa] ASCII line art filter. - -|graphviz-cmap -|Alex Efros -|https://powerman.name/asciidoc/ -|A variant of the built-in graphviz filter, which adds support for -client-side imagemaps. - -|matplotlib |Leonid Volnitsky -|https://github.com/lvv/mplw -|Using this filter you can generate charts from inline matplotlib scripts. - -|mscgen |Henrik Maier -|https://github.com/hwmaier/asciidoc-mscgen-filter -|Message sequence chart filter. - -|qrcode |Jean-Marc Temmos -|https://code.google.com/archive/p/asciidoc-qrencode-filter/ -|This filter generates -https://fukuchi.org/works/qrencode/manual/index.html[QRencode] images. - -|==== - - -[[X3]] -[cols="1e,1,3,3",frame="topbot",options="header"] -.Theme Plugins -|==== -|Theme name |Author |Home page |Description - -|compact -|Alex Efros -|https://powerman.name/asciidoc/ -|Similar to default theme but more compact. - -|==== - diff --git a/website/support.txt b/website/support.txt deleted file mode 100644 index c37b835..0000000 --- a/website/support.txt +++ /dev/null @@ -1,9 +0,0 @@ -AsciiDoc Support -================ - -- Bugs should be posted to our - https://github.com/asciidoc/asciidoc-py3[GitHub repository]. - -- Questions about general syntax or usage should be posted to the - http://groups.google.com/group/asciidoc[AsciiDoc discussion list] - (thanks Terrence Brannon for setting it up). diff --git a/website/version83.txt b/website/version83.txt deleted file mode 100644 index d4cd91d..0000000 --- a/website/version83.txt +++ /dev/null @@ -1,37 +0,0 @@ -AsciiDoc Version 8.3 -==================== - -This is significant release, it gets rid of unused cruft, simplifies -the https://asciidoc.org/newlists.html[lists] syntax and -introduces a decent -https://asciidoc.org/newtables.html[tables] syntax. -There are a few fairly minor backward compatibility issues, please -read the link:CHANGELOG.html#X1[compatibility issues] section in the -CHANGELOG before upgrading. - -New Features ------------- -- AsciiDoc tables have been redesigned. The link:newtables.html[new - syntax and features] are a huge improvement over the old tables. The - old tables syntax has been deprecated but is currently still - processed. -- Lists can now be styled like other block elements. This allows a - single list syntax for 'glossary', 'qanda' (Question and Answer) and - 'bibliography' lists instead of having to remember a different - syntax for each type. link:newlists.html[Here is some more - information]. -- Inline passthroughs macros have been improved and block passthrough - macros added. Attribute substitution can be optionally specified - when the macro is called. -- The passthrough block has a fully transparent passthrough delimited - block block style called 'pass'. -- The 'asciimath' and 'latexmath' link:userguide.html#X77[passthrough - macros] along with 'asciimath' and 'latexmath' - link:userguide.html#X76[passthrough blocks] provide a (backend - dependent) mechanism for rendering mathematical formulas. There are - link:latexmath.pdf[LaTeX Math], link:asciimath.html[AsciiMath] - and link:latexmathml.html[LaTeXMathML] examples on the AsciiDoc - website. - -Read the link:CHANGELOG.html[CHANGELOG] for a full list of all -additions and changes. -- cgit v1.2.1