Habenwill!

• für die Ausführung wird Flask benötigt

• Download und Entpacken des Quellcodes von GitHub

• kbgen.py ausführen, dies startet den internen Flask-Server

• 127.0.0.1:5000 aufrufen

• Workout generieren

• Werte können per Spinner geändert werden

Konfiguration

In der kbgen.py gibt es 3 Variablen für individuelle Einstellungen:

1. `REPS_PRESET`: Tupel mit 2 Werten (int) für die Preset-Buttons, Gesamtwiederholungen

2. `KB_EX`: Liste von Übungen, die bei der Kettlebattle zur Auswahl stehen sollen, ein Listeneintrag ist ein Tupel nach dem Muster (Name, Minimum bei Preset 1, Minimum bei Preset 2)

3. `MAX_EX`: Maximale Anzahl (int) von Übungen, die aus der Liste durchgeführt werden sollen, Minimumwerte werden immer gezählt

GtkSourceView

Die SourceView-Widgets befinden sich unterhalb einer eigenen gleichnamigen Hauptkategorie in der Seitenleiste.

• GtkSourceView: das eigentliche Editorwidget, das in einem ScrolledWindow platziert wird

• GtkSourceMap: Miniaturansicht und Unterklasse von SourceView

• GtkSourceStyleSchemeChooserWidget: Widget zur Auswahl eines StyleSchemes

In Glade lassen sich bereits viele Eigenschaften des Editorbereichs festlegen wie die Anzeige der Zeilennummern, Einrückung, Umbruchverhalten usw., die sich natürlich auch über set_property festlegen oder ändern lassen.

Beim StyleChooser-Widget wird das Signal button-release-event belegt, um das ausgewählte StyleScheme auf die SourceView-Widgets anzuwenden.

SourceMap

Das Widget muss mit der anzuzeigenden Quelle, einem SourceView-Widget, verknüpft werden (über "Allgemein > View"). Es wird dann der Inhalt des SourceView-Widgets verkleinert (standardmäßig mit Schriftgröße in 1pt) angezeigt. Durch scrollen in SourceMap verändert man gleichzeitig die Anzeige in SourceView.

Headerbar

Die Headerbar enthält verschiedene Buttons zum Laden, Suchen und Speichern:

• "Python file" und "Glade file" laden die entsprechenden Dateien dieses Beispieles in den Editor (Signal clicked)

• Die Sucheingabe ist ein Gtk.SearchEntry-Widget (Signale search-changed und activate)

• "Save .bak" und "Save" speichern die Dateien (Signal clicked)

SourceView

GObject.type_register(GtkSource.View)

self.buffer = self.view.get_buffer()

self.sourcefile = GtkSource.File()
self.lang_manager = GtkSource.LanguageManager()

sourcefile.set_location(Gio.File.new_for_path("file"))
buffer.set_language(self.lang_manager.get_language("language"))
loader = GtkSource.FileLoader.new(buffer, sourcefile)
loader.load_async(0, None, None, None, None, None)

# bestehende Datei überschreiben
saver = GtkSource.FileSaver.new(buffer, sourcefile)
# Datei unter anderem Namen speichern
saver = GtkSource.FileSaver.new_with_target(buffer, sourcefile, targetfile)
# Speichern ausführen
saver.save_async(0, None, None, None, None, None)

settings = GtkSource.SearchSettings()
search_context = GtkSource.SearchContext.new(buffer, settings)

builder.get_object("search_entry").bind_property('text', settings, 'search-text')

def find_text(self, start_offset=1):
    buf = self.buffer
    insert = buf.get_iter_at_mark(buf.get_insert())
    start, end = buf.get_bounds()
    insert.forward_chars(start_offset)
    match, start_iter, end_iter, wrapped = self.search_context.forward2(insert)

    if match:
        buf.place_cursor(start_iter)
        buf.move_mark(buf.get_selection_bound(), end_iter)
        self.view.scroll_to_mark(buf.get_insert(), 0.25, True, 0.5, 0.5)
        return True
    else:
        buf.place_cursor(buf.get_iter_at_mark(buf.get_insert()))

StyleChooser

Das Widget zeigt die verfügbaren Stile an. Es ist nicht möglich, lokale Stile anzugeben oder sie zu verändern.

Der angewählte Style lässt sich dann einfach auf den gewünschten Buffer anwenden:

def on_signal_emitted(self, widget, event):
    buffer.set_style_scheme(widget.get_style_scheme())

Initialisierung

Nach der Installation erstellt man das Projektverzeichnis und initialisiert mit

$ sphinx-quickstart

das Grundgerüst. Fast alle Fragen können auf der Voreinstellung belassen werden. Im Projektverzeichnis befindet sich nun die Konfigurationsdatei conf.py sowie das Root-Dokument index.rst.

Die Dateien lassen sich nach dem Muster make Builder erzeugen, die in den Unterverzeichnissen _build/builder befinden:

$ make epub
$ make latexpdf

conf.py

#HTML-Dateien vor dem Inhalt der index.rst einfügen
epub_pre_files = [('info.xhtml', 'Info')]
html_additional_pages = {'info': 'info.html'}

#Titel erzeugen
epub_cover = ('_static/cover.png', 'epub-cover.html')

#Stichwortverzeichnis auslassen
epub_use_index = False

#Bezeichnung der Ausgabedatei
epub_basename = output_basename

#für die Generierung der info.xhtml benötigt, da sonst None
html_last_updated_fmt = '%d. %B %Y'

#Papierformat (Standard ist US-Letter), leere Seiten vermeiden
latex_elements = {
    'papersize': 'a4paper',
    'classoptions': 'oneside,openany'
}

#Logo auf der Titelseite
latex_logo = '_static/logo.png'

pygments_style = 'borland'
output_basename = 'gladepytutorial'

_static

In diesem Ordner befinden sich Stylesheets, Bilder und Skripte, die nach den vorgegebenen Dateien geladen werden. So kann man lokale individuelle Stylesheet-Anpassungen vornehmen, ohne das Theme selbst zu modifizieren. Hier befinden sich eine angepasste pygments.css, cover.png (Epub) und logo.png (PDF).

_templates

Analog zu _static befinden sich hier individuelle Templates. Diese werden standardmäßig mit der Template-Engine Jinja2 betrieben. Hier befindet sich info.html, die in der Epub-Ausgabe Verwendung findet.

Epub: zusätzliche Dateien einfügen

Sphinx bietet mit epub_pre_files (und analog epub_post_files) die Option, zusätzliche und nicht zur eigentlichen Dokumentation gehörenden (X)HTML-Dateien zum Epub hinzuzufügen. Diese müssen allerdings zunächst als zusätzliche HTML-Seiten generiert werden. Dafür wird in der conf.py die Variable html_additional_pages entsprechend gesetzt 1.

1

Es hat mich einen (EINEN!) Tag gekostet dies herauszufinden...

index.rst

Dies ist das Hauptdokument, das von jedem Sphinx-Builder geparst wird. Die Bezeichnung wird in der conf.py in der Variable master_doc festgelegt.

Als reguläre reST-Datei kann sie beliebig viel Inhalt aufnehmen. Es ist allerdings zu empfehlen und im Normalfall vermutlich sowieso bereits der Fall, das Dokument in mehrere Dateien aufzuteilen. Sphinx stellt dafür die eigene toctree-Directive zur Verfügung.

.. toctree::
    :maxdepth: 1
    :numbered:
    :caption: Inhalt

    teildokument1
    teildokument2
    ...

Dateien außerhalb von toctree werden per include-Directive hinzugefügt.

Es ist auch möglich, Inhalte nur von bestimmten Buildern berücksichtigen zu lassen:

.. only:: latex

    .. include:: info.rst

KindleGen

Amazon möchte zwar keine Epubs 2 unterstützen, aber sie bieten mit KindleGen ein Tool an, welches diese in die eigenen Formate (KF8, Mobi) überführt.

Auf diese Weise lässt sich mit

$ kindlegen input.epub

eine Mobi-Datei erzeugen.

2

oder Google-Apps...

Problem: Encoding

Das aus dem Epub erstellte E-Book im Mobi-Format hat ein Darstellungsproblem mit einigen (Sonder-)Zeichen.

Abhilfe schafft hier die Zeile

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

an Stelle von

<meta charset="utf-8" />

innerhalb des HTML-Heads. Sphinx bietet dafür die meta-Directive, die allerdings für jede Datei gesetzt werden muss:

.. meta::
    :http-equiv=Content-Type: text/html; charset=UTF-8

Wegpunkte

Manuelles Blättern

Durch die Wegpunkte einer Route lässt sich nun mit den N/S-Tasten blättern. Ein Druck auf die obere Taste blättert weiter, die untere zurück. Gelangt man an den letzten Wegpunkt, wird nach Bestätigung der Frage "Finished?" die Fahrt beendet.

An welchem Wegpunkt man sich befindet, sieht man auch weiterhin nicht auf dem BeeLine, wohl aber in der App.

App: Wegpunkteanzeige

Belegung der Bedienelemente

Wie bereits erwähnt, blättert man mit der oberen und unteren Taste durch die Wegpunkte. Ein längerer Druck auf die untere Taste schaltet die integrierte Beleuchtung an oder ab. Die Tasten rechts und links blättern jeweils durch folgende Anzeigen:

Kompass <-> Geschwindigkeit <-> Uhrzeit <-> Akkuladezustand (Phone und BeeLine) <-> Kompass

Es ist mir auch nicht mehr passiert, Fahrten unbeabsichtigt beendet zu haben. Dieses Problem (Punkt 2), ob nun Bedienfehler oder tatsächlich Bug, scheint sich also auch erledigt zu haben.

Routenimport (whoop, whoop)

Eine Route lässt sich nun nicht mehr nur direkt in der BeeLine-App erstellen, sondern auch als GPX-Datei importieren. Dabei wird der Track vereinfacht und (größere) Richtungsänderungen mit Wegpunkten markiert. Die Strecken zwischen den Wegpunkten sind immer in Luftlinie (beeline) dargestellt.

Links: importierte vereinfachte Route mit Wegpunkten. Rechts: Anzeige des GPS-Tracks in Locus-App

Anhand der Screenshots sieht man, dass das ziemlich gut funktioniert. So kann man für relevante Streckendetails (wichtige Richtungsänderungen an Kreuzungen, Brücken) Wegpunkte setzen, ohne komplett auf eine bestimmte Streckenführung fixiert zu sein oder auf der anderen Seite in Sackgassen zu landen.

Wenige Wegpunkte reichen zur Skizzierung der Strecke aus

Routen in umgekehrter Reihenfolge abfahren

Eine Option, die Richtung einer Route zu bestimmen, wäre praktisch.

Wegpunkte-Fortschritt

Es wäre cool, wenn wie in der App angezeigt würde, auf welchen Wegpunkt man sich gerade zubewegt. Ja, ich weiß, dass dies nichts über Entfernungen aussagt.

Fahrt pausieren

Eine Funktion zum Pausieren, aber nicht Beenden der Fahrt könnte sowohl bei größeren Touren (Fortsetzen an letztem Wegpunkt) als auch beim spontanen Stopp am Supermarkt (tatsächliche Durchschnittsgeschwindigkeit) hilfreich.

Kalibrierung

Wir hassen es alle: das Hufeisensymbol auf dem BeeLine - Lenker rechts, Lenker links, Vorderrad hoch und das Ganze noch einmal. Mit dem Rennrad eine Kleinigkeit, mit Gepäck am Tourenrad eine Qual.

Ich habe dazu keinen wirklich konstruktiven Vorschlag. Vielleicht reichte es ja bereits aus, die Empfindlichkeitsschwelle zu erhöhen, denn häufig erscheint das Symbol auch während der Fahrt und verschwindet dann nach kurzer Zeit wieder. Ich ignoriere es inzwischen weitgehend.

Me vs. me

1. Ich fahre häufig die selben Routen.

2. Jeder mag Statistiken.

Ich hätte gern eine Übersicht, wie häufig ich Routen gefahren bin, wie weit und lange und schnell ich dabei unterwegs war.

Stack

Ein Stack, zu finden in der Sidebar unter "Container", und dessen Unterseiten lassen sich einfach in Glade erstellen und bearbeiten. Als Unterwidgets kommen im Beispiel Gtk.Image, Vte.Terminal und Gtk.Notebook zum Einsatz.

Das Stackswitcher-Widget befindet sich unter "Steuerung und Anzeige" und wird der Headerbar hinzugefügt. Es kann aber auch in reguläre Container-Widgets wie einer Box platziert und die Unterseiten horizontal oder vertikal angezeigt werden. Unter "Allgemein > Stapel" wird der Stack ausgewählt, auf den sich das Widget beziehen soll. Die anzuzeigende Seitenbezeichnung wird im jeweiligen Stack-Unterwidget unter "Packen > Titel" festgelegt. Dies funktioniert aber erst, nachdem einer Unterseite ein Widget hinzugefügt wurde. Standardmäßig ist dies zunächst leer.

Notebook

Das Notebook findet sich ebenfalls unter "Container". Die Steuerungseinheit des Tabs ist ein bei Erstellung einer Seite generiertes Label-Child-Widget. Als Container-Widgets der Unterseiten werden hier Gtk.ScrolledWindows verwendet. Diese benötigt man auch z.B. für die Anzeige von (längeren) Tabellen (siehe auch Artikel zu List-/TreeStores Nr. 1 und Nr. 2).

Die Tab-Leiste des Notebooks bietet die Möglichkeit, sowohl am Anfang als auch am Ende ein Container-Widget bereitzustellen (unter "Allgemein > Start-Aktion/End-Aktion"), in dem zum Beispiel feste Buttons untergebracht werden können. Im Beispiel wird am Anfang ein "Home"-Button eingerichtet.

WebKit2

Die Darstellung von Webseiten wird im Beispiel von WebKit2 erledigt. Das zentrale Modul dabei ist WebKit2.WebView. Ein neues WebView-Objekt selbst ist bereits ein scrollbares Gtk+-Widget in einem Gtk.Viewport, muss also laut API-Referenz nicht mehr in ein Gtk.ScrolledWindow platziert werden. Dies funktionierte im Test zwar für Gtk.Stack, nicht aber für Gtk.Notebook, weshalb dort trotzdem als "Unterlage" ein ScrolledWindow-Widget verwendet wird.

Das WebView-Widget wird nach folgendem Muster erstellt:

# create new WebView widget
webview = WebKit2.WebView()
# send URL to widget
webview.load_uri("http://google.com")
# add webview to notebook
notebook.add(webview)
# add webview to stack
stack.add_titled(webview, name, "StackSwitcher title")

webview.show()

Weiterlesen…