Python Webapp zur Anzeige der Tutorials

Eine Demo gibt es hier: http://jabber.zeroathome.de

http://github.com/zeroathome/step-by-step/commits/master

• durchklickbare Schritt-für-Schritt-Anleitung
  • pro Seite/Schritt ein Bild (evtl. mit Markierungen) und einer bis drei Zeilen (Zeichenbegrenzung?!) Text
• generiert die Tutorials dynamisch aus den Bildern und dem dazugehörigen Text (verringert den Aufwand beim Einpflegen neuer Tutorials)
• nach dem Tutorial werden weiterführende Links angezeigt
• nach dem Tutorial gibt es die Möglichkeit den neuen Jabber-Account direkt per Twitter/Facebook/Mail etc. zu verbreiten
• evtl. eine Möglichkeit die Tutorials per Webinterface zu Erstellen und Einzureichen

programmiert in Python basierend auf

• Werkzeug WSGI-Framework
• Jinja2 Templating Engine

Die Daten für die Tutorials (Bildernamen und Text) werden aus JSON formatierten Dateien ausgelesen. JSON ist ein Datenformat ähnlich XML, aber wesentlich kompakter und für das menschliche Auge leichter zu lesen. Hier mal ein Beispiel, wie eine solche Datei aussieht (nach dem bisherigen Stand; Änderungen vorbehalten):

{
  "os": "Windows XP",
  "client": "Pidgin",
  "client-version": "2.6.5",
  "tutorial": [
    {
      "image":  "winxp-pidgin1.png",
      "text":   "Besuchen Sie die Seite http://www.pidgin.im/download/windows, und laden Sie Pidgin durch einen Klick auf \"Download Pidgin\" herunter."
    },
    {
      "image":  "winxp-pidgin2.png",
      "text":   "Nach einem Doppelklick auf die Installationsdatei erscheint das obige Bild. Dort klicken Sie bitte auf \"Weiter\"."
    },
	{
      "image":  "winxp-pidgin3.png",
      "text":   "Der nächste Schritt zeigt die Lizenz, unter der Pidgin veröffentlicht ist. Da Pidgin Open Source ist, kann man hier beruhigt auf \"Weiter\" klicken."
    }
  ],
  "links": [
    {
      "linktext": "Pidgin Homepage",
      "url":      "http://pidgin.im"
    },
    {
      "linktext": "OTR-Tutorial",
      "url":      "http://wiki.jabber.zeroathome.de/OTR-Pidgin"
    }
  ]
}

Um den Text unter den Bildern zu formatieren (URLs, Fettschrift, usw.) wird vorraussichtlich eine Art Wiki-Syntax zum Einsatz kommen.

• PNG-Format
• Größe
  • quadratische 150px * 150px
  • rechteckige Logos ?px * ?px

Pro OS/Client-Kombination eine JSON-Datei mit dem gleichnamigen Ordner, in dem die Bilder liegen:

tutorial-
        \- [os]-[client]
        |  \-[os]-[client]1.png
        |  |-[os]-[client]2.png 
        |- [os]-[client].json

Beispiel:

tutorial-
        \- winxp-pidgin
        |  \-winxp-pidgin1.png
        |  |-winxp-pidgin2.png 
        |- winxp-pidgin.json

Ein Beispiel findet sich hier: http://github.com/zeroathome/step-by-step/tree/master/stepbystep/static/tutorials/

Alles unter http://github.com/zeroathome/step-by-step

Die Software ist als Open Source veröffentlicht und unterliegt bis auf weiteres der MIT-Lizenz:

Copyright (c) 2010 Benjamin Zimmer
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.