Mercurial Mercurial > iro.hg / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/tmpl/current.html
changeset 72 e7b44716a564
child 73 f2f247a5b6c9 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/tmpl/current.html	Tue Dec 06 19:46:00 2011 +0100
@@ -0,0 +1,100 @@
+<!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</title>
+	</head>
+	<body>
+		<title>API Dokumentation</title>
+		<div class="item">
+			<p>
+				
+			</p>
+			<ol>
+				<li value="1">1. <a href="#api-intro">Einführung</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>
+					</ol>
+				</li>
+				<li value="3">3. 
+					<a href="#api-methods">Methoden</a>
+					<ol>
+						<li py:for="(key,method) in enumerate(methods)" 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>Einführung</h3>
+			<p>
+				Die Iro API enthält Funktion, die für den Massenversand nützlich sind.
+			</p>
+		</div>
+		<div class="item" id="api-interfaces">
+			<h3>Interfaces</h3>
+			<p>
+				Die Iro API stellt zur Zeit nur ein Interfaces bereit.
+			</p>
+			<div class="item" id="interface-xmlrpc">
+				<h4>XML-RPC</h4>
+				<p>
+				Interface-URI: <code>https://<em>&lt;benutzer&gt;</em>:<em>&lt;passwort&gt;</em>@localhost:8000</code>
+				</p>
+				<p>
+					Die aufgerufene Methode wird dabei im <code>&lt;methodName /&gt;</code> übergeben.
+				</p>
+			</div>
+		</div>
+		<div class="item" id="api-methods">
+			<h3>Methoden</h3>
+			<div py:for="method in methods" class="item" id="method-${method.name}">
+				<h4>${method.title}</h4>
+				<p><code>${method.name}</code></p>
+				<p py:content="method.description">
+					Diese Methode at bis jetzt noch keine Beschreibung.
+				</p>
+				<h5>Parameter</h5>
+				<table class="docs">
+					<thead>
+						<tr>
+							<td>Parameter</td>
+							<td>Typ</td>
+							<td>Beschreibung</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>Ausgabe</h5>
+				<table class="docs">
+					<thead>
+						<tr>
+							<td>Parameter</td>
+							<td>Typ</td>
+							<td>Beschreibung</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>
iro.hg