Anolis

Contents

  1. 1 Introduction
  2. 2 Installing Anolis
    1. 2.1 Requirements
    2. 2.2 Obtaining a copy
    3. 2.3 Installation
    4. 2.4 Running the test suite
  3. 3 Documentation
  4. Acknowledgements

1 Introduction

The need for Anolis came from the need for long technical documents to include niceties such as cross-references and a table of contents for the purpose of easy navigation — doing this manually can be a great chore especially when sections are numbered and a section is added, consequently changing the numbering of many others, leading to it being advantageous to do it programmatically.

Anolis does this on HTML documents, as a number of sequential processes. Currently cross-referencing, section numbering, table of contents creation, and a number of substitutions are done (mainly relating to the current date).

2 Installing Anolis

2.1 Requirements

The following are the minimum requirements: later versions should also work without issue.

2.2 Obtaining a copy

The latest release is 1.0. This can downloaded as a bzip2, zip, or gzip archive.

Alternatively, a copy can be obtained from our Mercurial repository: this is where our ongoing development occurs, and allows any revision (and therefore any release) to be downloaded. Our repository is located at http://hg.gsnedders.com/anolis/.

2.3 Installation

Normally, installation is done through setuptools, with the following command:

python setup.py install

Please see setuptools' documentation for information on installation options (such as installing in non-standard locations).

2.4 Running the test suite

The source distribution and the current development copy (in Mercurial) both contain a test suite. It can be run with the following command:

python runtests.py

Any test failures should be reported at our bug tracker.

3 Documentation

Documentation is included with the latest release, and the documentation for the latest release can be obtained here.

Acknowledgements

Thanks to Andrew Sidwell, Anne van Kesteren, Henri Sivonen, Ian Hickson, James Graham, Lachlan Hunt, Magnus Kristiansen, Michael(tm) Smith, and Philip Taylor for their ever needed help.

Special thanks to Bert Bos for creating the CSS3 Module Postprocessor, on which this is partially based, and (with --w3c-compat) claims to be partially compatible with. Further special thanks to Bert Bos for creating a number of things (especially the algorithm for finding the W3C status) that took the author of Anolis many hours to reverse engineer.