Anolis / website / index.html

<!DOCTYPE html><html lang=en-gb-x-sneddy><head><meta charset=utf-8>
<title>Anolis</title>
<link href=style.css rel=stylesheet>
<style>
a:not([href]) {
background-color: #00f;
color: #fff;
}
span:not([title=""]):not(.secno) {
background-color: #a00;
color: #fff;
}
</style>

</head><body><header>
	<h1>Anolis</h1>
</header>

<h2 class="no-num no-toc" id=contents>Contents</h2>

<!--begin-toc-->
<ol class=toc>
 <li><a href=#introduction><span class=secno>1 </span>Introduction</a></li>
 <li><a href=#installing-anolis><span class=secno>2 </span>Installing Anolis</a>
  <ol>
   <li><a href=#requirements><span class=secno>2.1 </span>Requirements</a></li>
   <li><a href=#obtaining-a-copy><span class=secno>2.2 </span>Obtaining a copy</a></li>
   <li><a href=#installation><span class=secno>2.3 </span>Installation</a></li>
   <li><a href=#running-the-test-suite><span class=secno>2.4 </span>Running the test suite</a></li></ol></li>
 <li><a href=#documentation><span class=secno>3 </span>Documentation</a></li>
 <li><a class=no-num href=#acknowledgements>Acknowledgements</a></li></ol>
<!--end-toc-->

<h2 id=introduction><span class=secno>1 </span>Introduction</h2>

<p>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.</p>

<p>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).</p>

<h2 id=installing-anolis><span class=secno>2 </span>Installing Anolis</h2>

<h3 id=requirements><span class=secno>2.1 </span>Requirements</h3>

<p>The following are the minimum requirements: later versions should also work
without issue.</p>

<ul>
	<li><a href=http://python.org/>Python</a> 2.6
	</li><li><a href=http://codespeak.net/lxml/>lxml</a> 2.0
	</li><li><a href=http://code.google.com/p/html5lib>html5lib</a> 0.10
</li></ul>

<h3 id=obtaining-a-copy><span class=secno>2.2 </span>Obtaining a copy</h3>

<p>The latest release is 1.2. This can downloaded as a
<a href=https://bitbucket.org/ms2ger/anolis/get/1.2.tar.bz2>bzip2</a>,
<a href=https://bitbucket.org/ms2ger/anolis/get/1.2.zip>zip</a>, or
<a href=https://bitbucket.org/ms2ger/anolis/get/1.2.tar.gz>gzip</a>
archive.</p>

<p>Alternatively, a copy can be obtained from <dfn id=our-mercurial-repository>our <a href=http://www.selenic.com/mercurial/>Mercurial</a> repository</dfn>: this is
where our ongoing development occurs, and allows any revision (and therefore any
release) to be downloaded. Our repository is located at
<code><!--begin-link--><a href=https://bitbucket.org/ms2ger/anolis/>https://bitbucket.org/ms2ger/anolis/</a><!--end-link--></code>.

</p><h3 id=installation><span class=secno>2.3 </span>Installation</h3>

<p>Normally, installation is done through <a href=http://pypi.python.org/pypi/setuptools>setuptools</a>, with the following
command:</p>

<p><code>python setup.py install</code></p>

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

<h3 id=running-the-test-suite><span class=secno>2.4 </span>Running the test suite</h3>

<p>The source distribution and the current development copy (in <a href=#our-mercurial-repository title="our
mercurial repository">Mercurial</a>) both contain a test suite. It can be run
with the following command:</p>

<p><code>python runtests.py</code></p>

<p>Any test failures should be reported at our
<dfn id=bug-tracker><a href=https://bitbucket.org/ms2ger/anolis/issues>bug
tracker</a></dfn>.</p>

<h2 id=documentation><span class=secno>3 </span>Documentation</h2>

<p>Documentation is included with the latest release, and the documentation for
the latest release can be obtained <a href=http://pythonhosted.org/anolis>here</a>.</p>

<h2 class=no-num id=acknowledgements>Acknowledgements</h2>

<p>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.</p>

<p>Special thanks to Geoffrey Sneddon, who created this tool.</p>

<p>Special thanks to Bert Bos for creating the CSS3 Module Postprocessor, on
which this is partially based, and (with <code>--w3c-compat</code>) 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.</p>
</body></html>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.