changeset 49:6cf0808b8275

update specifications.html with auto-generated templates
author souliane <souliane@mailoo.org>
date Sun, 03 May 2015 22:40:07 +0200
parents 3b4ba14d1e26
children 10cdc1fbc4c7
files templates/sat_website/specifications.html templates/sat_website/specifications_exp.html templates/sat_website/specifications_xep.html
diffstat 3 files changed, 262 insertions(+), 119 deletions(-) [+]
line wrap: on
line diff
--- a/templates/sat_website/specifications.html	Sun May 03 22:39:02 2015 +0200
+++ b/templates/sat_website/specifications.html	Sun May 03 22:40:07 2015 +0200
@@ -23,131 +23,36 @@
 {% load i18n %}
 {% load staticfiles %}
 
-{% block headline %}{% trans "Salut à Toi's features" %}{% endblock %}
-{% block subtext %}{% trans "SàT is a feature rich XMPP client, here is a round up of them." %}{% endblock %}
-{% block extra %}<span class="label label-success">{% trans "Click on the feature name to have a more detailed description" %}</span>{% endblock %}
+{% block headline %}{% trans "Salut à Toi's specifications" %}{% endblock %}
 
 {% block main_container %}
 
-    <div class="row">
-        <div class="col-md-2">
-            <a href="frontends">{% trans "Multi frontend" %}</a>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}The heart of the software being independent from its display, you can have different interfaces adapted to specific usages.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Microblogging" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Share your thought either publicly or privately (see below), thanks to the microblogging feature. With the decentralised nature of XMPP, you don't have to rely on one specific server, so you can stay master of your data, and avoir censorship.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Group permissions" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Keep access to private data only for the people you choose. SàT uses groups to manage your permissions, and avoid your coworker to see your party pictures.{% endblocktrans %}
-        </div>
+<div class="row">
+    {% blocktrans with xmpp="<abbr title=\"eXtensible Messaging and Presence Protocol\">XMPP</abbr>" spec_prefix='<a href="http://xmpp.org/xmpp-protocols/rfcs/" target="#">' spec_suffix="</a>"%}SàT is a rich-featured {{ xmpp }} client. Beside the {{ spec_prefix }}core specifications{{ spec_suffix }} that define the way to manage a contact list and exchange presence information and messages, it implements many standardised extensions and some other internal features.{% endblocktrans %}
+</div>
+
+<div class="row">
+    <h5 class="alert alert-success">
+        {% trans "Standard extensions" %}
+    </h5>
+    <div class="info">
+        {% blocktrans with xsf="<abbr title=\"XMPP Standards Foundation\">XSF</abbr>" xep="<abbr title=\"XMPP Extension Protocol\">XEP</abbr>" %}A extension that is standardized by the {{ xsf }} is called a {{ xep }}. We aim to support as much as possible. For now, SàT implements the following ones:{% endblocktrans %}
     </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Advanced chat and group chat" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}XMPP is one of the best (and probably the best) instant messaging protocol ever made. There are plenty of things you can do, far too much to detail everything here. In addition, you can join muli-user rooms, and discuss with tons of people.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Heavy messaging" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}With XMPP, you are not limited to chat or short messages: you have no size limit, and if you want to write essays or to highly detail your last holidays, you can. SàT also handles rich text syntaxes like XHTML and Markdown.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Gateways" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Communicate with other networks using different protocols. With SàT and XMPP, you'll not stay behind closed walls.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "File sharing" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Easily send file to your friends.{% endblocktrans %}
-        </div>
+    <div class="info">
+        {% include "sat_website/specifications_xep.html" %}
     </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Games" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Play with your friends or other people.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            {% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2011/01/18/Recevez-et-envoyez-vos-messages-XMPP/Jabber-avec-votre-lecteur-de-courriel-gr%C3%A2ce-%C3%A0-Salut-%C3%A0-Toi-%21">E-mail clients interactions</a>{% endblocktrans %}
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Thanks to it's IMAP/SMTP plugin, you can use any e-mail client to communicate through SàT. Combinate this with the gateway feature, and you can send message with it to any network (including traditional e-mail network). One of the goal of SàT is to allow easy transition to Jabber as an alternative to classical e-mail network, with a better protection against SPAM and identity spoofing.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            {% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2011/10/07/Shell%3A-pipe-you-commands-out-via-XMPP-with-S%C3%A0T">Pipe over XMPP</a>{% endblocktrans %}
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}This is a feature for power-user: SàT allows to send command-line tools' stdout to your contacts. This actually is as easy as knowing the name of your contact.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            {% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2013/02/22/Export-command-to-a-contact-%28with-video%29">Export Unix commands</a>{% endblocktrans %}
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}An other feature for power-user: you can export input/outputs of an Unix CLI command to any contact (using any XMPP client or even other protocols through gateways).{% endblocktrans %}
-        </div>
+</div>
+
+<div class="row">
+    <h5 class="alert alert-success">
+        {% trans "Experimental and non-standard features" %}
+    </h5>
+    <div class="info">
+        {% blocktrans %}This table lists the non-standard features. Some of them can't be standardised because they are too specific, some others might become new standards in the future.{% endblocktrans %}
     </div>
-    <div class="row">
-        <div class="col-md-2">
-            {% blocktrans context "Url need to point to the localised one" %}<a href="http://blog.goffi.org/post/2014/02/18/A-universal-remote-for-your-softwares">Ad-Hoc commands</a>{% endblocktrans %}
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}You can remotely control your XMPP entities and all the softwares that offer DBus services. {% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            {% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2012/02/02/Collective-radio-%28with-video%29">Collective radio</a>{% endblocktrans %}
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Experiment music with your friends: in a multi-user room, you share a playlist; everybody can add songs to it, and everybody listens the same music at the same time. Good way to share your taste and discover new songs.{% endblocktrans %}
-        </div>
+    <div class="info">
+        {% include "sat_website/specifications_exp.html" %}
     </div>
-    <div class="row">
-        <div class="col-md-2">
-            <strong>{% trans "Multiplatform" %}</strong>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans %}Since its begining, the SàT project was made with other platforms in mind. It's only avaible on Gnu/Linux so far (except of course Libervia, the web interface, which is available from every javascript powered browser), but other platforms are planed.{% endblocktrans %}
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-2">
-            <a href="social_contract.html">{% trans "Social contract" %}</a>
-        </div>
-        <div class="col-md-7 feature">
-            {% blocktrans with social_prefix="<a href=\"social_contract\">" social_suffix="</a>" %}Not exactly a feature, but certainly one of the most important point: a {{ social_prefix }}social contract{{ social_suffix }} has been written as a moral engagement around the project. SàT is not made for money or trap people, it's a project about freedom and sharing.{% endblocktrans %}
-        </div>
-    </div>
+</div>
 
 {% endblock %}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/templates/sat_website/specifications_exp.html	Sun May 03 22:40:07 2015 +0200
@@ -0,0 +1,99 @@
+
+{% comment %}
+SàT website: Salut à Toi's presentation website
+Copyright (C) 2012  Jérôme Poisson (goffi@goffi.org)
+Copyright (C) 2015  Adrien Cossa (souliane@mailoo.org)
+
+This file is part of SàT website.
+
+SàT website is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Foobar is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+
+NOTE: this file has been automatically generated by the following script:
+http://repos.goffi.org/sat_docs/file/tip/scripts/list_plugins/list_plugins.py
+
+Please avoid manual modification, try to update the script instead! Before /
+after a regeneration, don't forget to save / merge the manual modifications.
+
+{% endcomment %}
+{% load i18n %}
+
+<div class="row">
+  <div class="col-md-2">{% blocktrans context "Url need to point to the localised one" %}<a href="http://blog.goffi.org/post/2014/02/18/A-universal-remote-for-your-softwares">Ad-Hoc commands</a>{% endblocktrans %}</div>
+  <div class="col-md-7 feature">{% blocktrans %}You can remotely control your XMPP entities and all the softwares that offer D-Bus services. {% endblocktrans %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2013/02/22/Export-command-to-a-contact-%28with-video%29">Commands export</a>{% endblocktrans %}</div>
+  <div class="col-md-7 feature">{% blocktrans %}An other feature for power-user: you can export input/outputs of an Unix CLI command to any contact (using any XMPP client or even other protocols through gateways).{% endblocktrans %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Parrot Plugin" %}</div>
+  <div class="col-md-7 feature">{% trans "Parrot mode (repeat messages between 2 entities)" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2011/10/07/Shell%3A-pipe-you-commands-out-via-XMPP-with-S%C3%A0T">Pipe over XMPP</a>{% endblocktrans %}</div>
+  <div class="col-md-7 feature">{% blocktrans %}This is a feature for power-user: SàT allows to send command-line tools' stdout to your contacts. This actually is as easy as knowing the name of your contact.{% endblocktrans %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Group blogs" %}</div>
+  <div class="col-md-7 feature">{% blocktrans %}Blogging and microblogging with fine access tuning using XMPP roster groups. You can decide who will be able to read your posts, and avoid your coworker to see your party pictures. Moreover, you are not limited to short messages: there is no size limit and if you want, you can also write long essays and includes numerous pictures. SàT handles rich text syntaxes like XHTML and Markdown.{% endblocktrans %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2011/01/18/Recevez-et-envoyez-vos-messages-XMPP/Jabber-avec-votre-lecteur-de-courriel-gr%C3%A2ce-%C3%A0-Salut-%C3%A0-Toi-%21">IMAP server</a>{% endblocktrans %}</div>
+  <div class="col-md-7 feature">{% trans "Create an Imap server that you can use to read your \"normal\" type messages" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Maildir Plugin" %}</div>
+  <div class="col-md-7 feature">{% trans "Intercept \"normal\" type messages, and put them in a Maildir inbox" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Quiz game" %}</div>
+  <div class="col-md-7 feature">{% trans "A quiz game (under development)" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% blocktrans context "Url need to point to the localised one" %}<a href="http://www.goffi.org/post/2012/02/02/Collective-radio-%28with-video%29">Collective radio</a>{% endblocktrans %}</div>
+  <div class="col-md-7 feature">{% blocktrans %}Experiment music with your friends: in a multi-user chat, you share a playlist; everybody can add songs to it, and everybody listens to the same music at the same time. A nice way to share your taste and discover new songs.{% endblocktrans %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Register Account Plugin" %}</div>
+  <div class="col-md-7 feature">{% trans "Register XMPP account" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Room game" %}</div>
+  <div class="col-md-7 feature">{% trans "Defines a referee and invitation system for the implementation of various games on top of the multi-user chat." %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "SMTP server Plugin" %}</div>
+  <div class="col-md-7 feature">{% trans "Create a SMTP server that you can use to send your \"normal\" type messages" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Static Blog Plugin" %}</div>
+  <div class="col-md-7 feature">{% trans "Expose your public blogs to the web. Your public page will be accessible from any web browser and doesn't require your visitors to have an XMPP account." %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Tarot cards plugin" %}</div>
+  <div class="col-md-7 feature">{% trans "Tarot card game" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Text commands" %}</div>
+  <div class="col-md-7 feature">{% trans "IRC-like text commands" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2">{% trans "Text syntaxes" %}</div>
+  <div class="col-md-7 feature">{% trans "Management of various text syntaxes (XHTML-IM, Markdown, etc)" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="https://otr.cypherpunks.ca/Protocol-v3-4.0.0.html" target="#">OTR</a></div>
+  <div class="col-md-7 feature">{% trans "End-to-end chat encryption using the Off-The-Record messaging protocol" %}</div>
+</div>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/templates/sat_website/specifications_xep.html	Sun May 03 22:40:07 2015 +0200
@@ -0,0 +1,139 @@
+
+{% comment %}
+SàT website: Salut à Toi's presentation website
+Copyright (C) 2012  Jérôme Poisson (goffi@goffi.org)
+Copyright (C) 2015  Adrien Cossa (souliane@mailoo.org)
+
+This file is part of SàT website.
+
+SàT website is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Foobar is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+
+NOTE: this file has been automatically generated by the following script:
+http://repos.goffi.org/sat_docs/file/tip/scripts/list_plugins/list_plugins.py
+
+Please avoid manual modification, try to update the script instead! Before /
+after a regeneration, don't forget to save / merge the manual modifications.
+
+{% endcomment %}
+{% load i18n %}
+
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0020.html" target="#">XEP-0020</a></div>
+  <div class="col-md-7 feature">{% trans "Feature Negotiation" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0033.html" target="#">XEP-0033</a></div>
+  <div class="col-md-7 feature">{% trans "Extended Stanza Addressing" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0045.html" target="#">XEP-0045</a></div>
+  <div class="col-md-7 feature">{% trans "Multi-User Chat" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0047.html" target="#">XEP-0047</a></div>
+  <div class="col-md-7 feature">{% trans "In-Band Bytestreams" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0048.html" target="#">XEP-0048</a></div>
+  <div class="col-md-7 feature">{% trans "Bookmarks" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0049.html" target="#">XEP-0049</a></div>
+  <div class="col-md-7 feature">{% trans "Private XML Storage" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0050.html" target="#">XEP-0050</a></div>
+  <div class="col-md-7 feature">{% trans "Ad-Hoc Commands" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0054.html" target="#">XEP-0054</a></div>
+  <div class="col-md-7 feature">{% trans "vcard-temp" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0055.html" target="#">XEP-0055</a></div>
+  <div class="col-md-7 feature">{% trans "Jabber Search" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0059.html" target="#">XEP-0059</a></div>
+  <div class="col-md-7 feature">{% trans "Result Set Management" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0060.html" target="#">XEP-0060</a></div>
+  <div class="col-md-7 feature">{% trans "Publish-Subscribe" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0065.html" target="#">XEP-0065</a></div>
+  <div class="col-md-7 feature">{% trans "SOCKS5 Bytestreams" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0071.html" target="#">XEP-0071</a></div>
+  <div class="col-md-7 feature">{% trans "XHTML-IM" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0077.html" target="#">XEP-0077</a></div>
+  <div class="col-md-7 feature">{% trans "In-Band Registration" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0085.html" target="#">XEP-0085</a></div>
+  <div class="col-md-7 feature">{% trans "Chat State Notifications" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0092.html" target="#">XEP-0092</a></div>
+  <div class="col-md-7 feature">{% trans "Software Version" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0095.html" target="#">XEP-0095</a></div>
+  <div class="col-md-7 feature">{% trans "Stream Initiation" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0096.html" target="#">XEP-0096</a></div>
+  <div class="col-md-7 feature">{% trans "SI File Transfer" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0100.html" target="#">XEP-0100</a></div>
+  <div class="col-md-7 feature">{% trans "Gateway Interaction" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0115.html" target="#">XEP-0115</a></div>
+  <div class="col-md-7 feature">{% trans "Entity Capabilities" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0163.html" target="#">XEP-0163</a></div>
+  <div class="col-md-7 feature">{% trans "Personal Eventing Protocol" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0203.html" target="#">XEP-0203</a></div>
+  <div class="col-md-7 feature">{% trans "Delayed Delivery" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0249.html" target="#">XEP-0249</a></div>
+  <div class="col-md-7 feature">{% trans "Direct MUC Invitations" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0277.html" target="#">XEP-0277</a></div>
+  <div class="col-md-7 feature">{% trans "Microblogging over XMPP" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0297.html" target="#">XEP-0297</a></div>
+  <div class="col-md-7 feature">{% trans "Stanza Forwarding" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0313.html" target="#">XEP-0313</a></div>
+  <div class="col-md-7 feature">{% trans "Message Archive Management" %}</div>
+</div>
+<div class="row">
+  <div class="col-md-2"><a href="http://xmpp.org/extensions/xep-0334.html" target="#">XEP-0334</a></div>
+  <div class="col-md-7 feature">{% trans "Message Processing Hints" %}</div>
+</div>
\ No newline at end of file