Author: bugman
Date: Wed Apr 10 13:18:56 2013
New Revision: 19414
URL: http://svn.gna.org/viewcvs/relax?rev=19414&view=rev
Log:
Changed the http://www.nmr-relax.com/api/index.html webpage to be an
introductory page.
This has links for all the different version of the API documentation.
Modified:
website/api/index.html
Modified: website/api/index.html
URL:
http://svn.gna.org/viewcvs/relax/website/api/index.html?rev=19414&r1=19413&r2=19414&view=diff
==============================================================================
--- website/api/index.html (original)
+++ website/api/index.html Wed Apr 10 13:18:56 2013
@@ -1,32 +1,57 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
- "DTD/xhtml1-frameset.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
+<?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";>
+
+<!--
+ Copyright (c) 2013 Edward d'Auvergne.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.2
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. A copy of the license is included in the section entitled "GNU
+ Free Documentation License".
+-->
+
<head>
- <title> relax </title>
- <!--Google analytics JS-->
- <script type="text/javascript">
+ <title>The relax API documentation</title>
+ <!--#include virtual="head.html" -->
+</head>
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-30096326-1']);
- _gaq.push(['_setDomainName', 'nmr-relax.com']);
- _gaq.push(['_trackPageview']);
+<body>
- (function() {
- var ga = document.createElement('script'); ga.type =
'text/javascript'; ga.async = true;
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' :
'http://www') + '.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
- })();
+<!--#include virtual="header.html" -->
+<!--#include virtual="menu.html" -->
- </script>
-</head>
-<frameset cols="20%,80%">
- <frameset rows="30%,70%">
- <frame src="toc.html" name="moduleListFrame"
- id="moduleListFrame" />
- <frame src="toc-everything.html" name="moduleFrame"
- id="moduleFrame" />
- </frameset>
- <frame src="module-tree.html" name="mainFrame" id="mainFrame" />
-</frameset>
+<div class="main">
+ <div class="main_box">
+ <h1>The relax API documentation</h1>
+
+ <p>The <a href="http://nmr-relax.com/api/2.2/";>relax Application
Programming Interface (API) documentation</a> is an in-depth description of
the internal structure of relax. It can be used by power users to create
advanced relax scripts. It is also the documentation fro the collection of
functions in relax library. This documentation should be a useful reference
for relax developers and for those wishing to contribute to the relax
project.</p>
+
+ <p>The most recent version of the documentation is:</p>
+ <ul>
+ <li><a href="http://nmr-relax.com/api/2.2/";>relax 2.2.5 API
documentation</a></li>
+ </ul>
+
+ <h2>The relax library</h2>
+
+ <p>Part of the relax API is the 'lib' package. This is an extensive
collection of functions, methods, classes, objects, etc. useful for the study
of all types of molecular dynamics using NMR data. These are independent
from the relax data store, specific analysis API, and other relax concepts.
It allows you to employ relax as an alternative to Mathematica and Matlab, by
having a large collection of NMR functions at your fingertips. See the 'lib'
package section of the API documentation for more details.</p>
+
+ <h2>Old documentation</h2>
+
+ <p>The automatically generated API documentation is also available for
earlier relax versions:</p>
+
+ <ul>
+ <li><a href="http://nmr-relax.com/api/2.2/";>relax 2.2.5 API
documentation</a></li>
+ <li><a href="http://nmr-relax.com/api/2.1/";>relax 2.1.2 API
documentation</a></li>
+ <li><a href="http://nmr-relax.com/api/2.0/";>relax 2.0.0 API
documentation</a></li>
+ <li><a href="http://nmr-relax.com/api/1.3/";>relax 1.3.16 API
documentation</a></li>
+ <li><a href="http://nmr-relax.com/api/1.2/";>relax 1.2.15 API
documentation</a></li>
+ <li><a href="http://nmr-relax.com/api/1.2/";>relax 1.0.9 API
documentation</a></li>
+ </ul>
+ </div>
+</div>
+
+<!--#include virtual="footer.html" -->
+</body>
</html>
r19414 - /website/api/index.html