doc/tmpl/current.html
author Sandro Knauß <knauss@netzguerilla.net>
Thu, 27 Sep 2012 17:18:06 +0200
branchdevel
changeset 305 887ca66823bb
parent 302 3f4bdea2abbf
permissions -rw-r--r--
merging from default

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
	xmlns:xi="http://www.w3.org/2001/XInclude"
	xmlns:py="http://genshi.edgewall.org/">
	<xi:include href="layout.tmpl" />
	<head>
		<title>api docs current</title>
	</head>
	<body>
		<title>API Documentation</title>
		<div class="item">
			<p>

			</p>
			<ol>
				<li value="1">1. <a href="#api-intro">Intro</a></li>
				<li value="2">2. 
				<a href="#api-interfaces">Interfaces</a>
				<ol>
					<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li>
					<li value="2.1">2.2 <a href="#interface-soap">SOAP</a></li>
					<li value="2.3">2.3 <a href="#interface-json">JSON</a></li>
					<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li>
				</ol>
				</li>
				<li value="3">3. 
					<a href="#api-methods">Methods</a>
					<ol>
						<li py:for="(key,method) in enumerate(current)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</a></li>
					</ol>				
				</li>

			</ol>
		</div>
		<div class="item" id="api-intro">
			<h3>Intro</h3>
			<p>
				Iro API has many methods, that are usefull if you want to send a bunch of messages. This Site describes the API for Iro 1.0.
			</p>
		</div>
		<div class="item" id="api-interfaces">
			<h3>Interfaces</h3>
			<p>
				You can use diffrent interfaces to get to same result.
			</p>
			<div class="item" id="interface-xmlrpc">
				<h4>XML-RPC</h4>
				<p>
					Interface-URI: <code>http://localhost:8000/xmlrpc</code>
				</p>
			</div>
			<div class="item" id="interface-soap">
				<h4>SOAP</h4>
				<p>
					Interface-URI: <code>http://localhost:8000/soap</code>
				</p>
			</div>
			<div class="item" id="interface-json">
				<h4>JSON</h4>
				<p>
					Interface-URI: <code>http://localhost:8000/json/<em>&lt;methode&gt;</em></code>
				</p>
				<p>
					Not yet implementet
				</p>
			</div>
			<div class="item" id="interface-jsonp">
				<h4>JSONP</h4>
				<p>
					Interface-URI: <code>http://localhost:8000/jsonp/<em>&lt;methode&gt;</em>?callback=&lt;callback&gt;</code>
				</p>
				<p>
					Not yet implementet
				</p>
			</div>
		</div>
		<div class="item" id="api-methods">
			<h3>Methods</h3>
			<div py:for="method in current" class="item" id="method-${method.name}">
				<h4>${method.title}</h4>
				<p><code>${method.name}${method.func_line}</code></p>
				<p py:content="method.description">
					No description
				</p>
				<h5>Parameter</h5>
				<table class="docs">
					<thead>
						<tr>
							<td>parameter</td>
							<td>type</td>
							<td>description</td>
						</tr>					
					</thead>
					<tbody>
						<tr py:for="arg in method.args">
							<td>${arg.name}</td>
							<td>${arg.typ}</td>
							<td>${arg.description}</td>
						</tr>
					</tbody>
				</table>
				<py:if test="method.rets">
				<h5>Return</h5>
				<table class="docs">
					<thead>
						<tr>
							<td>parameter</td>
							<td>type</td>
							<td>description</td>
						</tr>					
					</thead>
					<tbody>
						<tr py:for="arg in method.rets">
							<td>${arg.name}</td>
							<td>${arg.typ}</td>
							<td>${arg.description}</td>
						</tr>
					</tbody>
				</table>	
				</py:if>
			</div>
		</div>
	</body>
</html>