Roadmap
to be continued
4.0.1 stable
-
asciidoc3: Add new option --pdf= / --pdf=dblatex / --pdf=fop to produce PDFs analogue to a2x3 -f pdf
(that’s a hack …) -
asciidoc3: Replace deprecated and dangerous tempfile.mktemp
-
asciidoc3: Handles data-uri inline, so there is no Python interpreter neccessary
(that’s a hack) -
FIXED: SyntaxWarning: invalid escape sequence \S (and others) when using Python 3.12
Due to the change https://docs.python.org/3/whatsnew/3.12.html we encounter this warning:
>> … Other Language Changes … The parser now raises SyntaxError when parsing source code containing null bytes. … A backslash-character pair that is not a valid escape sequence now generates a SyntaxWarning, instead of DeprecationWarning. … In a future Python version, SyntaxError will eventually be raised, instead of SyntaxWarning. … <<
The same input processed with 3.11 (or before) throws only a silent DeprecationWarning.
After all this error does not affect AsciiDoc3’s output. -
FIXED: Add keyword flags to regex expressions to avoid deprecation warnings
-
FIXED: Avoid deprecated positional parameter count in re.sub and re.subn
-
Python 3.9 required
-
Add assciidoc3_toc_generator.py (beta) to write a Table of Content without the use of javascript
-
asciidoc3: Add option --gassy (verboseverbose) for more granular (debug-) messages
-
Refactoring tests due to the new file layout with src/misc … The files are in the repo, not in tarball.gz
-
Warn if image can not be found, run with -v to see
-
asciidoc3: Avoid and replace deprecated locale.getdefaultlocale
-
Day of release: 2025-02-12
AsciiDoc3 cheatsheet v2.0
Titles Headlines 🞙 Formatting Text 🞙 Images 🞙 Paragraphs and Admonitions 🞙 Blocks 🞙 Lists 🞙 Tables 🞙 Formulas
Please take note of the annotation at the end of this document.
To generate a html-file: asciidoc3 -n -a icons -a latexmath cheatsheet.txt. Do not try a2x3 -f pdf cheatsheet.txt, because the plain source yields just an (html-)example and not valid DocBook. Download a PDF here. This document will be updated from time to time.
The items are divided by the AsciiDoc3 logo. At first in the box is shown the plain code, followed by the HTML output.
Linux Package Manager
|
Not yet available. |
Use the Repo-Version or the standalone version in the meantime → look at quickstart.
.deb
dpkg, originally used by Debian and now by Ubuntu and all its derivates, uses the .deb format. Most systems provide apt as a dependency resolution tool.
Download the Deb-Package here.
|
Yes, there is no info yet … Comes asap for the newest version. |
.rpm
The RPM package manage was created by Red Hat. RPM is the standard packaging format of Red Hat, openSUSE, and Fedora.
Container
Docker
You find the docker image here. But do not use this until the update is completed.
|
Docker Hub is currently outdated. |
We’ll provide a new version asap.
Podman
The same as for docker at the moment.
INSTALLATION
|
|
See Quickstart til more detailed info is available. |
PyPi
You find the PyPi package here. But do not use this until the update is completed.
|
|
PyPi is currently outdated. |
We’ll provide a new version asap.
This is an overly large document, it probably needs to be refactored into a Tutorial, Quick Reference and Formal Reference. Visit the homepage of the project to find additional information.
If you’re new to AsciiDoc3 read the Introduction / Getting Started section and the Introduction / Getting Started section and take a look at the example AsciiDoc3 (*.txt) source files in the distribution directories ./doc/ and ./tests/data. They may be useful as templates to learn more about the features of AsciiDoc3.
AsciiDoc3 on Windows
You can use the power of AsciiDoc3 on Windows 10/11 without any limitation or hacky tricks, though the program was developed under GNU/Linux. This page gives you some hints how to make this happen in a few seconds.
There are different ways to use AsciiDoc3 on Windows OS.
Standard Usage: There is no need of installing a Python interpreter any more
You want to compute html - html5 (the default), xhtml, slidy (html4 is possible, but deprecated) - pages or docbook-xml or a text-file out of your plain input.txt?
You don’t even need a Python interpreter to achieve this!
