doc/tmpl/index.html
author Sandro Knauß <knauss@netzguerilla.net>
Wed, 25 Apr 2012 15:06:28 +0200
branchdevel
changeset 277 f65edc0382cc
parent 271 b218238e76b9
child 280 c96d569a8ac8
permissions -rw-r--r--
prepare for release: * diffrent web directory with all web specific content (split doc dir -> doc (data) and web (rendered data)) * update installation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
"http://www.w3.org/TR/html4/strict.dtd">
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
<html xmlns="http://www.w3.org/1999/xhtml"
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
	xmlns:xi="http://www.w3.org/2001/XInclude"
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
	xmlns:py="http://genshi.edgewall.org/">
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
	<xi:include href="layout.tmpl" />
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
	<head>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
		<title>work in progress</title>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
	</head>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
	<body>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
		<title>Iro</title>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
		<div class="item">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    13
			<h3>What it is all about?</h3>
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    14
			<p>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    15
			Iro is a non blocking server for sending a message to a bunsh of recipient. It can handle diffrent types of message typs and can be extended easially.
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    16
			It was initially written for sms backend of <a href="http://castorticker.de">castorticker.de</a>. Diffrent backends are supportes by Iro.
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    17
			</p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    18
		</div>
277
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    19
		<div class="item" id="backends">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    20
			<h3>Supported Backends</h3>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    21
			<p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    22
			A backend is a provider, that actually sends the message. 
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    23
			<ul>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    24
				<li><b>smtp</b> with TLS and SSL</li>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    25
				<li><b><a href="http://smstrade.de">smstrade</a></b> all diffrent routes are selectable</li>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    26
				<li><b><a href="http://sipgate.de">sipgate</a></b> fax and sms</li>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    27
			</ul>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    28
			</p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    29
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    30
		</div>
277
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    31
		<div class="item" id="installation">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    32
			<h3>Installation</h3>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    33
			<p>
277
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    34
			Just download <a href="files/${code}">${code}</a> see also installtion instruction under <a href="dev/install.html">Installing Iro</a>.
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    35
			</p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    36
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    37
			<h3>Documentation</h3>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
    38
			<p>
277
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    39
			If you want just use iro see <a href="current.html">API Documentation</a>.
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    40
			For extending iro see the <a href="dev/index.html">developer documenation</a>.
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    41
			</p>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    42
		</div>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    43
		<div class="item" id="files">
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    44
			<h3>Files</h3>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    45
			<p>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    46
			<ul> 
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    47
				<li py:for="f in files" value="${f.version}">${f.version} <a href="files/${f.name}">${f.name}</a></li>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    48
			</ul>
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
			</p>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
		</div>
277
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    51
		<div class="item">
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    52
			<h3>Planned features for 1.0</h3>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    53
			<p>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    54
			<ul>   
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    55
				<li>JSON Interface</li>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    56
				<li>admin interface for creating modifing users</li>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    57
				<li>heartbeat</li>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    58
			</ul>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    59
			For any further ideas, bugs or anything - send at <a href="mailto:iro@netzgerilla.net">iro@netzgerilla.net</a>.
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    60
			</p>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    61
		</div>
f65edc0382cc prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents: 271
diff changeset
    62
</body>
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
</html>
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    64
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    65