diff options
Diffstat (limited to 'docs/index.xhtml')
| -rw-r--r-- | docs/index.xhtml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/index.xhtml b/docs/index.xhtml new file mode 100644 index 0000000..dc06aaf --- /dev/null +++ b/docs/index.xhtml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html +PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>Rarian Reference Manual</title> +</head> +<body> +<h1>Rarian Reference Manual v0.6</h1> +<hr/> +<h2>Overview</h2> +<p> +This manual describes version 0.6 of Rarian, a documentation meta-data +library. It is split into three sections, which are relevant for +different people. The first section covers writing Rarian meta-data +files and is useful for people wishing their documentation to be +visible in applications using Rarian.</p> + +<p>The second section describes the Rarian library. This details the +available API and requirements for using it. This section is aimed at +developers wishing to use the power of Rarian in their applications.</p> + +<p>The final section describes the scrollkeeper compatibility stuff in +Rarian and how to take advantage of this. It isn't really useful for +anyone, but is included for completeness.</p> +<!--<br/>--> +<hr/> +<h2>Contents</h2> +<ul> +<li><a href="license.xhtml">Preamble</a></li> +<li><a href="rar-mdf.xhtml">Writing Rarian meta-data files</a></li> +<li><a href="rar-lib.xhtml">Using the Rarian library</a></li> +<li><a href="rar-skcompat.xhtml">Scrollkeeper compatibility</a></li> +</ul> + +</body> +</html> + |