|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
|
2 "http://www.w3.org/TR/html4/strict.dtd"> |
|
3 <html xmlns="http://www.w3.org/1999/xhtml" |
|
4 xmlns:xi="http://www.w3.org/2001/XInclude" |
|
5 xmlns:py="http://genshi.edgewall.org/"> |
|
6 <xi:include href="layout.tmpl" /> |
|
7 <head> |
|
8 <title>API docs</title> |
|
9 </head> |
|
10 <body> |
|
11 <title>API Dokumentation</title> |
|
12 <div class="item"> |
|
13 <p> |
|
14 |
|
15 </p> |
|
16 <ol> |
|
17 <li value="1">1. <a href="#api-intro">Einführung</a></li> |
|
18 <li value="2">2. |
|
19 <a href="#api-interfaces">Interfaces</a> |
|
20 <ol> |
|
21 <li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
|
22 </ol> |
|
23 </li> |
|
24 <li value="3">3. |
|
25 <a href="#api-methods">Methoden</a> |
|
26 <ol> |
|
27 <li py:for="(key,method) in enumerate(methods)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</a></li> |
|
28 </ol> |
|
29 </li> |
|
30 </ol> |
|
31 </div> |
|
32 <div class="item" id="api-intro"> |
|
33 <h3>Einführung</h3> |
|
34 <p> |
|
35 Die Iro API enthält Funktion, die für den Massenversand nützlich sind. |
|
36 </p> |
|
37 </div> |
|
38 <div class="item" id="api-interfaces"> |
|
39 <h3>Interfaces</h3> |
|
40 <p> |
|
41 Die Iro API stellt zur Zeit nur ein Interfaces bereit. |
|
42 </p> |
|
43 <div class="item" id="interface-xmlrpc"> |
|
44 <h4>XML-RPC</h4> |
|
45 <p> |
|
46 Interface-URI: <code>https://<em><benutzer></em>:<em><passwort></em>@localhost:8000</code> |
|
47 </p> |
|
48 <p> |
|
49 Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
50 </p> |
|
51 </div> |
|
52 </div> |
|
53 <div class="item" id="api-methods"> |
|
54 <h3>Methoden</h3> |
|
55 <div py:for="method in methods" class="item" id="method-${method.name}"> |
|
56 <h4>${method.title}</h4> |
|
57 <p><code>${method.name}</code></p> |
|
58 <p py:content="method.description"> |
|
59 Diese Methode at bis jetzt noch keine Beschreibung. |
|
60 </p> |
|
61 <h5>Parameter</h5> |
|
62 <table class="docs"> |
|
63 <thead> |
|
64 <tr> |
|
65 <td>Parameter</td> |
|
66 <td>Typ</td> |
|
67 <td>Beschreibung</td> |
|
68 </tr> |
|
69 </thead> |
|
70 <tbody> |
|
71 <tr py:for="arg in method.args"> |
|
72 <td>${arg.name}</td> |
|
73 <td>${arg.typ}</td> |
|
74 <td>${arg.description}</td> |
|
75 </tr> |
|
76 </tbody> |
|
77 </table> |
|
78 <py:if test="method.rets"> |
|
79 <h5>Ausgabe</h5> |
|
80 <table class="docs"> |
|
81 <thead> |
|
82 <tr> |
|
83 <td>Parameter</td> |
|
84 <td>Typ</td> |
|
85 <td>Beschreibung</td> |
|
86 </tr> |
|
87 </thead> |
|
88 <tbody> |
|
89 <tr py:for="arg in method.rets"> |
|
90 <td>${arg.name}</td> |
|
91 <td>${arg.typ}</td> |
|
92 <td>${arg.description}</td> |
|
93 </tr> |
|
94 </tbody> |
|
95 </table> |
|
96 </py:if> |
|
97 </div> |
|
98 </div> |
|
99 </body> |
|
100 </html> |