AxessCleaner

This python module cleans a LaTex file in order to use the axessibility.sty package safely. It handles the following:

• User defined macro e.g \def, \newcommand, with and without inputs.
• Dollars-defined math environments, e.g $$\sqrt{4}$$
• Underscore
• Include external files with \include, \input

Getting Started

These instructions will get you a copy of the project up and running on your local machine for usage, development and testing.

Prerequisites

In order to use axesscleaner.py you need

• python Python 2 >=2.7.9 or Python 3 >=3.4 (https://www.python.org)
  • For windows user, please select the installer.exe (32 or 64 bit) and select also the PATH installation option.
• pip (https://pip.pypa.io/en/stable/installing/)
• For the pdflatex version, you need a working tex distribution.
  • TexLive
    • Mac Osx (http://www.tug.org/mactex/)
    • Windows, Ubuntu (https://www.tug.org/texlive/)
  • MikTex (https://miktex.org)

Installing

Download the folder on your local computer and unzip the content.

Step 1, Open prompt and go to directory

Linux/ Mac Osx

Open the terminal. Inside the terminal, go to the directory where the folder is stored using

cd <address of your folder>

For example, if your folder Axesscleaner is inside Documents, you can do

cd ~/Documents/Axesscleaner

Windows

Open the Command Prompt. If you are not familiar, please check this. Once open, go to the directory where the folder is stored using

cd <address of your folder>

For example, if your folder Axesscleaner is inside Documents, you can do

cd C:\Users\<User_Name>\Documents

Step 2, install dependencies

Once you are in the right folder, install all the dependencies

python -m pip install -r requirements.txt --user

Optionally, you can set up a virtualenv and do the same steps inside it (https://docs.python.org/3/library/venv.html).

Usage

Now, you are ready tu use our module from the command line. Let's look into the input/output structure.

By executing python src/Py/axesscleaner.py -h you get the following output

optional arguments:
  -h, --help  show this help message and exit
  -i INPUT    Input File (Required). It accepts only .tex files
  -o OUTPUT   Output File (optional, default: input file with _clean as
              suffix)
  -p          If selected, runs pdflatex at the end

Hence, in order to clean a file, execute:

python src/Py/axesscleaner.py -i <input file>.tex 

It will generate <input file>_clean.tex in the same folder as the input file. With the option -p, i.e.

python src/Py/axesscleaner.py -i <input file>.tex -p 

It will also generate the log files and the input file>_clean.pdf

To specify an output, you can execute:

python src/Py/axesscleaner.py -i <input file>.tex -o <output file>.tex

with or without -p.

Main Contributors

• Dragan Ahmetovic
• Tiziana Armano
• Cristian Bernareggi
• Michele Berra
• Sandro Coriasco
• Nadir Murru

See also the website of the project (www.integr-abile.unito.it) for the full list of contributors and testers.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• ProgressBar
• Perl scripts inspired by:
• Flatex
• StripComments
• Perl scripts inspired by: this.