Commit 76247df6 authored by asciidoc3's avatar asciidoc3

Merge branch 'master' into 'master'

AsciiDoc3-3.0.3 release

See merge request !6
parents 8ac41d0c 4601a0e6
Bugs and Known Problems
AsciiDoc3 Version 3.0.1, 11 May 2018
AsciiDoc3 Version 3.0.3, 05 Jan 2019
__________________________________________________________________
1. AsciiDoc3
......@@ -14,8 +14,13 @@
* A row of apostrophes in an inline context throws AsciiDoc3 into an
endless loop. The problem seems to be in the input file Reader.
(workaround: begin the line with a space or \)
__________________________________________________________________
2. dblatex
See ./dblatex/dblatex-readme.txt.
3. AsciiDoc3 running under Windows
... there are some limitations. See https://asciidoc3.org/windows.html
__________________________________________________________________
......@@ -4,6 +4,21 @@ AsciiDoc3 ChangeLog
website: https://asciidoc3.org/
Version 3.0.3 (2019-01-05)
Additions and changes
- FASTER ~15%! (by using lru_cache)
- Test are back (but most users don't need them)
- Typos
Bug fixes
- asciidoc3.py:
... /usr/bin/asciidoc3:569: DeprecationWarning:
Flags not at the start of the expression '^(?u)[^\\W\\d][-\\w]*$'
return re.match(r'^'+NAME_RE+r'$', s) is not None
Version 3.0.2 (2018-06-15)
Additions and changes
......
......@@ -4,6 +4,21 @@ AsciiDoc3 ChangeLog
website: https://asciidoc3.org/
Version 3.0.3 (2019-01-05)
Additions and changes
- FASTER ~15%! (by using lru_cache)
- Test are back (but most users don't need them)
- Typos
Bug fixes
- asciidoc3.py:
... /usr/bin/asciidoc3:569: DeprecationWarning:
Flags not at the start of the expression '^(?u)[^\\W\\d][-\\w]*$'
return re.match(r'^'+NAME_RE+r'$', s) is not None
Version 3.0.2 (2018-06-15)
Additions and changes
......
Copyright © Stuart Rackham (and contributors)
for AsciiDoc v8.6.9 (Python2)
Copyright © 2018 Berthold Gehrke berthold.gehrke@gmail.com
Copyright © 2018-2019 Berthold Gehrke berthold.gehrke@gmail.com
for AsciiDoc3 (Python3)
This program is free software; you can redistribute it and/or modify
......
= AsciiDoc3 Installation
NOTE: AsciiDoc3 requires *Python 3.0 or newer*
to run. AsciiDoc3 will definitely crash when using Python2.x. Probably there are
few systems in the real world running with Python 3.0, 3.1 or 3.2 any more. Python 3.3 / 3.4 / 3.5 / 3.6
is a good choice - but you don't need the most recent branch at all. Python is installed by
to run, it will definitely crash when using Python2.x. Probably there are
few systems in the real world running with Python 3.0, 3.1, 3.2 or 3.3 any more - these versions have reached their end of live. Please consider updating to a newer version! Python 3.4 (reaches end of live 2019-03-16) / 3.5 / 3.6 / 3.7 is a good choice - you don't need the most recent branch at all. Python is installed by
default in most Unix and GNU/Linux distributions. If you don't find an up-to-date version
of Python installed it can be downloaded from the official Python website http://www.python.org/.
of Python installed it can be downloaded from the official Python website https://www.python.org/.
[WARNING]
Command line 'python3' obligatory! +
Please note: To run AsciiDoc3, the executable command 'python3' is a must-have. That means, typing 'python3' at the command line starts the Python3 executable. In almost every Unix and GNU/Linux distribution this is a given. When not, you can easily add a symlink python3 -> python3.5 and add python3 to your PATH ... +
Please note: To run AsciiDoc3, the executable command 'python3' is a must-have. That means, typing 'python3' at the command line starts the Python3 executable. In almost every Unix and GNU/Linux distribution this is a given. When not, you can easily add a symlink python3 -> python3.7 (please take your current version) and add python3 to your PATH ... +
Windows users need probably a 'windows alias for python 3' - use this as a search phrase on the net. You can find more information about this issue here: +
https://www.jamescoyle.net/how-to/1100-doskey-in-windows-is-just-like-alias-in-linux +
https://anmolsinghjaggi.wordpress.com/2015/04/14/permanent-alias-on-windows/ +
https://docs.python.org/3/using/windows.html +
https://stackoverflow.com/questions/38532440/running-both-python-2-7-and-3-5-on-pc +
See some hints about AsciiDoc3 and Windows link:windows.html[here].
== Obtaining AsciiDoc3
See link:download.html[here].
== Installation
Experienced users should consider to run AsciiDoc3 via PIP in a virtual environment created with link:https://docs.python.org/3/library/venv.html[venv]. +
See AsciiDoc3/PyPI link:pypi.html[here]
=== Unix, GNU/Linux, BSD (and probably OS X, too)
Posix systems (Unix, GNU/Linux, BSD, and assumably OS X) go here.
You have two options to install AsciiDoc3:
- system wide (you need su/sudo/admin rights)
- 'local' in your home directory, no admin rights required (if Python etc. is already installed ...)
You have two options to install AsciiDoc3: +
- 'system wide' (you need su/sudo/admin rights) +
- 'local' in your home directory, no admin rights required (if Python3 is already installed ...). Doing so, you have to use the 'python3 asciidoc3.py ...' syntax to execute AsciiDoc3.
==== Install system wide (default)
- Download the tarball in any directory with read-write access, e.g. ~/download.
- Open a terminal and change to \~/download ('cd ~/download').
- Deflate the tarball to a new dir, say 'asciidoc3-3.0.1': 'tar -xzf asciidoc3-3.0.1.tar.gz'.
- You see a new directory ~/download/asciidoc3-3.0.1
- Deflate the tarball to a new dir, say asciidoc3-3.0.x: 'tar -xzf asciidoc3-3.0.x.tar.gz'.
- You see a new directory ~/download/asciidoc3-3.0.x
- Recommended (but optional): Copy this new directory to your home directory
and rename it to something like ~/ad3 (so you have less typing labour ...).
- In the terminal: change to the new directory, e.g. ~/ad3.
- Run 'installscript' as root/superuser:
Ubuntu: 'sudo ./installscript'
Other POSIX os like Debian, Fedora, BSD: 'su <password> ./installscript'
- AsciiDoc3 is ready to use ... (continue link:quickstart.html[here]).
- AsciiDoc3 is ready to use ... continue link:quickstart.html[here].
- To avoid some configuration steps during daily routine you may consider the following directory layout:
Copy/rename the deflated directory \~/download/asciidoc3-3.0.1 to \~/.asciidoc3 (with a dot - not visible to ls)
Copy/rename the deflated directory \~/download/asciidoc3-3.0.x to \~/.asciidoc3 (with a dot - not visible to ls)
and create a symlink to directory \~/ad3. This is because asciidoc3.py tries to find some configuration files
in ~/.asciidoc3. See Userguide '26.11. Configuration file names, precedence and locations.' But that's optionally,
everything works somehow or other. Symlinks don't work on partitions formatted as fat/vfat.
......@@ -51,15 +54,15 @@ You have two options to install AsciiDoc3:
==== Install local
- Download the tarball in any directory with read-write access, e.g. ~/download.
- Open a terminal and change to \~/download ('cd ~/download').
- Deflate the tarball to a new dir, say 'asciidoc3-3.0.1': 'tar -xzf asciidoc3-3.0.1.tar.gz'.
- You see a new directory ~/download/asciidoc3-3.0.1
- Open a terminal and change to \~/download (cd ~/download).
- Deflate the tarball to a new dir, say asciidoc3-3.0.x: 'tar -xzf asciidoc3-3.0.x.tar.gz'.
- You see a new directory ~/download/asciidoc3-3.0.x
- Optional: Copy this directory and rename it to ~/asciidoc3 (so you have less typing labour ...)
- In the terminal: change to the new directory, e.g. ~/asciidoc3.
- Start using AsciiDoc3: ... ... (continue link:quickstart.html[here]).
- Start using AsciiDoc3: ... continue link:quickstart.html[here].
- To avoid some configuration steps during daily routine you may consider the following directory layout:
Copy/rename the deflated directory \~/download/asciidoc3-3.0.1 to \~/.asciidoc3 (with a dot - not visible to ls)
Copy/rename the deflated directory \~/download/asciidoc3-3.0.x to \~/.asciidoc3 (with a dot - not visible to ls)
and create a symlink to directory \~/ad3. This is because asciidoc3.py tries to find some configuration files
in ~/.asciidoc3. See Userguide '26.11. Configuration file names, precedence and locations.' But that's optionally,
everything works somehow or other. Symlinks don't work on partitions formatted as fat/vfat.
......@@ -67,16 +70,15 @@ You have two options to install AsciiDoc3:
- To install 'local' as described before makes is easier to uninstall: just delete ~/ad3.
=== Windows (pending)
Zip Installation: Windows users may go here. +
AsciiDoc3 is developed and tested on GNU/Linux. I have only limited access to such systems. But as said in the
AsciiDoc v2 homepage, there seem to be quite a few people using it on Windows (I use the informations given there:). +
=== Windows
Zip Installation: Windows users may go link:windows.html[here]. +
AsciiDoc3 is developed and tested on GNU/Linux. I have only limited access to machines with Windows OS. +
- To install AsciiDoc3 on Windows unzip the Zip file ('unzip asciidoc3-3.0.1.zip'),
- this will create the folder 'asciidoc3-3.0.1' containing the 'asciidoc3.py' and 'a2x3.py' executables along with configuration files,
- try 'python3 asciidoc3.py -n - icons -o ad3test.html ad3test.txt'... (continue link:quickstart.html[here]).
- To install AsciiDoc3 on Windows unzip the Zip file: 'unzip asciidoc3-3.0.x.zip',
- this will create the folder 'asciidoc3-3.0.x' containing the 'asciidoc3.py' and 'a2x3.py' executables along with configuration files,
- try 'python3 asciidoc3.py -n -a icons -o ad3test.html ad3test.txt'... (continue link:quickstart.html[here]).
To generate DocBook based outputs (e.g. PDFs) you will also need a working DocBook toolchain. Installing and configuring a DocBook toolchain on Windows can be a challenge. If possible, I give you more information about this later on if this website will be updated.
To generate DocBook based outputs (e.g. PDFs) you will also need a working DocBook toolchain. Installing and configuring a DocBook toolchain on Windows can be a challenge.
=== Testing your installation
......@@ -87,15 +89,15 @@ See link:quickstart.html[here].
(this information is also given in file 'UNINSTALL' of the AsciiDoc3 distribution)
=== Uninstall local installation
If you have AsciiDoc3 installed 'local' - that means, you have all files in one
If you have AsciiDoc3 installed local - that means, you have all files in one
directory (e.g., \~/asciidoc3) and never ran 'installscript'
(you have used 'python3 asciidoc3.py -a toc -a icons -n mytext.txt' or so):
just delete the directory '~/asciidoc3' (or wherever you have installed the distribution).
=== Uninstall system wide installation
If you ran the AsciiDoc3 'installscript' as root/superuser - that means, you have
directories/files like '/etc/asciidoc3/*.*', '/usr/share/asciidoc3/*.*' et al.
(you have used 'asciidoc3 -a toc -a icons -n mytext.txt' or so):
1. make 'uninstallscript' executable: 'chmod u+x uninstallscript',
2. 'su/sudo ./uninstallscript',
3. delete your 'local' files, e.g. in '~/asciidoc3'.
directories/files like /etc/asciidoc3/\*.* or /usr/share/asciidoc3/ et al.
(you have used 'asciidoc3 -a toc -a icons -n mytext.txt' or so): +
1. make uninstallscript executable: 'chmod u+x uninstallscript', +
2. 'su/sudo ./uninstallscript', +
3. delete your local files, e.g. in '~/asciidoc3'.
......@@ -24,6 +24,6 @@ Current *AsciiDoc3* version tested on Ubuntu Linux 18.04 (Bionic Beaver) with Py
## Copying
Copyright © Stuart Rackham (and contributors) for AsciiDoc v8.6.9 (Python2)
Copyright © 2018 Berthold Gehrke <berthold.gehrke@gmail.com> for AsciiDoc3 (Python3)
Copyright © 2018-2019 Berthold Gehrke <berthold.gehrke@gmail.com> for AsciiDoc3 (Python3)
Free use of this software is granted under the terms of the GNU General Public License version 2 or later (GPLv2+).
......@@ -4,7 +4,8 @@ a2x3 - A toolchain manager for AsciiDoc3 - converts AsciiDoc3 text files to othe
file formats. See asciidoc3.org for more information.
Copyright: (c) 2009 Stuart Rackham <srackham@gmail.com> MIT
Copyright: (c) 2018 Berthold Gehrke <berthold.gehrke@gmail.com> for Python3 version
Copyright: (c) 2018-2019 Berthold Gehrke <berthold.gehrke@gmail.com>
for Python3 version
License: GNU GPL v2 or higher
'''
......@@ -23,7 +24,7 @@ import zipfile
PROG = os.path.basename(os.path.splitext(__file__)[0])
# Version corresponds to asciidoc3.py version
VERSION = '3.0.2'
VERSION = '3.0.3'
# AsciiDoc3 global configuration file directory.
# NOTE: CONF_DIR is "fixed up" during install -- don't rename or change syntax.
......
......@@ -4,7 +4,7 @@
asciidoc3.py converts an AsciiDoc text file to HTML or DocBook or
Manpage using Python3.x - asciidoc3.py is also used by a2x3.py
Copyright (C) 2002-2010 Stuart Rackham
Copyright (C) 2018 by Berthold Gehrke <berthold.gehrke@gmail.com>
Copyright (C) 2018-2019 by Berthold Gehrke <berthold.gehrke@gmail.com>
for Python3 version and 2to3 work.
Free use of this software is granted under the terms of the
GNU General Public License Version 2 or higher (GNU GPLv2+).
......@@ -36,7 +36,7 @@ from unicodedata import east_asian_width, normalize
import zipfile
### Used by asciidoc3api.py ###
VERSION = '3.0.2' # See CHANGELOG file for version history.
VERSION = '3.0.3' # See CHANGELOG file for version history.
MIN_PYTHON_VERSION = '3.0' # Require this version of Python or better.
#---------------------------------------------------------------------------
......
......@@ -6,7 +6,7 @@ installed via pip / pip3 from 'https://pypi.org/project/asciidoc3/'.
Run it immediately subsequently after install.
See https://asciidoc3.org/pypi.html for more information.
Copyright (C) 2018 by Berthold Gehrke <berthold.gehrke@gmail.com>
Copyright (C) 2018-2019 by Berthold Gehrke <berthold.gehrke@gmail.com>
Free use of this software is granted under the terms of the
GNU General Public License Version 2 or higher (GNU GPLv2+).
"""
......@@ -80,3 +80,4 @@ def main():
if __name__ == '__main__':
main()
......@@ -47,7 +47,7 @@ Doctests: ...
AsciiDoc3Error: ERROR: <stdin>: line 1: [blockdef-listing] missing closing delimiter
Copyright (C) 2009 Stuart Rackham.
Copyright (C) 2018 Berthold Gehrke <berthold.gehrke@gmail.com>.
Copyright (C) 2018-2019 Berthold Gehrke <berthold.gehrke@gmail.com>.
Free use of this software is granted under the terms of the
GNU General Public License v2 or higher (GPLv2+).
"""
......
This diff is collapsed.
......@@ -9,7 +9,7 @@ To do so it is strongly recommended to run
This arranges some reasonable symlinks for convenient usage.
See https://asciidoc3.org/pypi.html for more information.
Copyright (C) 2018 by Berthold Gehrke <berthold.gehrke@gmail.com>
Copyright (C) 2018-2019 by Berthold Gehrke <berthold.gehrke@gmail.com>
Free use of this software is granted under the terms of the
GNU General Public License Version 2 or higher (GNU GPLv2+).
"""
......@@ -176,3 +176,4 @@ setup(
'Development Status :: 5 - Production/Stable',
],
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment