Add a legend on the map and more instructions in the README

README.md

@@ -4,13 +4,40 @@ ffdnispdb
 ``ffdnispdb`` is a website designed to display all the ISPs implementing the
 ``ispschema`` specification.
 
-## How to deploy & use
+## How to install & develop
+Third-party dependencies:
+ * ``sqlite``
+ * ``libspatialite``
+
 Preferably in a virtualenv, run:
 
     pip install -r requirements.txt
     python manage.py db create
+
+To start the development server, run:
+
     python manage.py runserver
 
+## Production deployment
+To deploy this application, we recommend the use of gunicorn/gevent.
+We strongly discourage you to use a synchronous WSGI server, since the app uses
+``Server-sent events``.
+
+First, copy the example settings file:
+
+    cp settings_prod.py.dist settings_prod.py
+
+Then, edit the newly created ``settings_prod.py``:
+generate a random ``SECRET_KEY``, add yourself to the ``ADMINS`` array.
+To see the full list of available settings, see the ``ffdnispdb/default_settings.py`` file
+and [Flask's documentation](http://flask.pocoo.org/docs/config/#builtin-configuration-values).
+
+Now, you can run gunicorn using the ``app_prod.py`` file, which logs warnings
+to an application.log file and send you errors by email.
+
+    gunicorn -k gevent -b 127.0.0.1:8080 --log-level warning app_prod:app
+
+You can also edit ``app_prod.py`` to customize logging behavior.
 
 ## How to translate
 First, generate the template:
@@ -27,8 +54,12 @@ Once you're done translating, run:
 
     pybabel compile -d ffdnispdb/translations
 
+Now, you can add your language to the ``LANGUAGES`` dict in ``ffdnispdb/default_settings.py``.
+
 To update the catalog with the latest strings:
 
     pybabel extract -F babel.cfg -o messages.pot ffdnispdb
     pybabel update -i messages.pot -d ffdnispdb/translations
 
+Once you've tested your work and you're satisfied with the result, you can
+send us a patch (or the po file directly).

ffdnispdb/static/css/style.css

@@ -326,6 +326,27 @@ footer:hover p {
     margin: 8px 10px 6px 10px;
 }
 
+#map .leaflet-control-attribution {
+    opacity: 0.8;
+    font-size: 10px;
+}
+
+#map .legend {
+    background: rgba(255,255,255,0.7);
+    box-shadow: 0 0 15px rgba(0,0,0,0.2);
+    border-radius: 5px;
+    padding: 4px 6px;
+}
+
+#map .legend i {
+    background: #00aac9;
+    height: 8px;
+    width: 8px;
+    border: 1px solid #333;
+    display: inline-block;
+    vertical-align: middle;
+}
+
 @media (min-width: 768px) and (max-width: 979px) {
     #map {
         height: 500px;

ffdnispdb/templates/locale_selector.html

@@ -4,3 +4,4 @@
         <i class="flag flag-{{ l.1 }}"></i> {{ l.2 }}
       </label>
     {% endfor %}
+    <p style="margin: 20px 0 0 0;"><a href="https://dev.cafai.fr/gitweb/?p=ffdn-db.git;a=blob;f=README.md;hb=HEAD">{% trans %}Help us translate this website to your language !{% endtrans %}</a></p>

ffdnispdb/templates/project_list_macro.html

@@ -16,7 +16,7 @@
         <td>
           {{ project.json.progressStatus|step_to_label|safe }}
           {%- if project.is_ffdn_member %}
-          &thinsp;<a href="#" rel="tooltip" data-placement="right" title="{{ _("Member of the FDN Federation") }}"><span class="label label-info">FFDN</span></a>
+          &thinsp;<a href="#" data-toggle="tooltip" data-placement="right" title="{{ _("Member of the FDN Federation") }}"><span class="label label-info">FFDN</span></a>
           {%- endif %}
         </td>
         <td><a class="pull-right btn btn-small" title="{{ _("Examine") }}" href="{{ url_for('.project', projectid=project.id) }}"><i class="icon-search"></i></a>

ffdnispdb/templates/site.js

@@ -15,7 +15,7 @@ $(function () {
         });
     });
     $('.selectpicker').selectpicker();
-    $("[rel=tooltip]").tooltip();
+    $("[data-toggle='tooltip']").tooltip();
 
     var Geoinput = function(el, options, e) {
         this.$element = $(el);
@@ -267,6 +267,20 @@ function init_map() {
     if(!$('#map').length)
         return;
 
+
+    var legend = L.control({
+        position: 'bottomleft'
+    });
+
+    legend.onAdd = function (map) {
+        var div = L.DomUtil.create('div', 'info legend');
+        div.innerHTML  = '<small>'+{{ _('Legend')|js_str }}+'&thinsp;:</small>&nbsp; ';
+        div.innerHTML += '<i title="'+{{ _('Member of the FDN Federation')|js_str }}+'" /> ';
+        $(div).children('i').tooltip({container: 'body'});
+
+        return div;
+    };
+
     var map = L.map('map', {
         center: new L.LatLng(46.603354, 10),
         zoom: 4,
@@ -276,6 +290,7 @@ function init_map() {
     });
     map.attributionControl.setPrefix('');
     map.addControl(new L.Control.Pinpoint);
+    map.addControl(legend);
 
     L.control.layers({'MapQuest': mapquest, 'OSM Mapnik': osm, 'MapQuest Aerial': mapquestsat}).addTo(map);
     map.on('baselayerchange', function(a) {

ffdnispdb/translations/fr/LC_MESSAGES/messages.po

@@ -7,8 +7,8 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: gu1@cafai.fr\n"
-"POT-Creation-Date: 2013-12-23 21:20+0100\n"
-"PO-Revision-Date: 2013-12-23 21:25+0100\n"
+"POT-Creation-Date: 2013-12-24 16:27+0100\n"
+"PO-Revision-Date: 2013-12-24 16:27+0100\n"
 "Last-Translator: Gu1 <gu1@cafai.fr>\n"
 "Language-Team: \n"
 "Plural-Forms: nplurals=2; plural=(n > 1);\n"
@@ -462,7 +462,7 @@ msgstr "Accueil"
 
 #: ffdnispdb/templates/layout.html:46 ffdnispdb/templates/project_list.html:3
 msgid "Project List"
-msgstr "Liste des projet"
+msgstr "Liste des projets"
 
 #: ffdnispdb/templates/layout.html:47
 msgid "Format"
@@ -485,6 +485,10 @@ msgstr "Fermer"
 msgid "Confirm"
 msgstr "Confirmer"
 
+#: ffdnispdb/templates/locale_selector.html:7
+msgid "Help us translate this website to your language !"
+msgstr "Aidez-nous à traduire ce site dans votre langue !"
+
 #: ffdnispdb/templates/map_popup.html:15
 #: ffdnispdb/templates/project_detail.html:50
 msgid "email"
@@ -549,6 +553,7 @@ msgid "Step"
 msgstr "Étape"
 
 #: ffdnispdb/templates/project_list_macro.html:19
+#: ffdnispdb/templates/site.js:278
 msgid "Member of the FDN Federation"
 msgstr "Membre de la Fédération FDN"
 
@@ -584,6 +589,10 @@ msgstr "Fini"
 msgid "Find ISPs near you"
 msgstr "Trouvez des FAI proche de vous"
 
+#: ffdnispdb/templates/site.js:277
+msgid "Legend"
+msgstr "Légende"
+
 #: ffdnispdb/templates/validator_generic.html:81
 msgid "Retry"
 msgstr "Réessayer"