Entwickler (Dev)

Entwicklung mittels Template von Hibiscus-Scripting


Hier wird euch Hobby-Entwicklern nun endlich das schon lang angekündigte Template für die Entwicklung eines Scripts zur Unterstützung einer non-HBCI-Bank oder Institut und dessen Datenabruf in Jameica/Hibiscus vorgestellt.

Wichtig ist gleich vorweg zu erwähnen dass:
Jeder hat, in jeden Fall und zu jeder Zeit, die Lizenz und Vorgaben zum Verwenden, Einsetzen, Anpassen bzw. Verändern und Verbreiben eines Scripts oder Scripting-PlugIns basierend auf dem Template (oder auch eines anderen Scripts) von Hibiscus-Scripting (Sebastian Richter) einzuhalten.
Es sind von jedem die zusammengefassten Bedingungen hier weiter unten zu lesen und einzuhalten!

Die ausführliche Beschreibung findet man praktischerweise im Template selbst um dort auch gleich immer nachlesen zu können.

Unter keinen Umständen wird für dieses Template Support oder gar Entwicklungshilfe geleistet.
Für jeden Nutzer oder Hobby-Entwickler (Professionelle Entwickler sowieso) gilt auch hier das Prinzip:
"Lerning by doing" und "Google ist dein Freund"! (Tipp: http://stackoverflow.com)





Vorbereitung einer grundsätzlichen Arbeitsfläche für Einsteiger

Editor:

Hier wird vorwiegend natürlich auf Einsteiger eingegangen da ja etablierte Programmierer sich Ihre eigene und gewohnte Entwicklungsumgebung eingerichtet haben (wie zum Beispiel Eclipse)

Zunächst sollte man sich einen geeigneten Editor für die Entwicklung einrichten.
  • Für Windows ist der wohl beste und bekannteste Editor für solche Entwicklungszwecke: Editor++
  • Unter Mac oder auch Linux hat sich für mich direkt dieser Editor äußerst bewährt: Sublime Text 2

Diese Eigenschaften sollte ein Coding-Editor jedenfalls aufweisen können: Code-Highligting und intelligente Autovervollständigung


Log-Kontrolle:

Absolut empfehlenswert für die Live-Ausgabe der Log-Ereignisse ist für Windows (oder auch Mac als Crossover*) das Programm BareTail.
Hier kann man mit der Einstellung Highlighting alle seine Einträge in einer bestimmten Farbe aufzeigen lassen und z. B. auch gleich Fehlermeldungen mit Rot hinterlegen lassen.
Absolut sinnvoll und empfehlenswert und eine riesige Erleichterung beim Lesen der Log-Files:

* Wer von mir eine vorkonfigurierte APP-Version (basierend auf WineSkin) für Mac OS X haben möchte, bekommt diese gerne. Was es unter Linux gibt weiß ich nicht aber mit Wine läuft dass Ding da ja auch ;)



Der Browser zur Analyse des zu verarbeitenden Internetauftritts


Als beste Methode der Webseiten-Analyse hat sich der Opera und dass darin enthaltene Entwicklerwerkzeug herausgestellt.
(ohne Konfiguration und Einarbeitung dort sofort nutzbar für diese Zwecke)
(Dieses ist auch im Firefox enthalten, aber nach persönlicher Erfahrung bei weitem nicht so elegant zu bedienen, obwohl das gleich sein sollte)






Einarbeiten in das Template und Erstellen von Scripten

Das Scripting-Template wird mit folgenden Einstellungen bzw. Eigenschaften geliefert.

Es muss darauf geachtet werden dass diese beibehalten, eingehalten und bei jeder Script-Datei oder z. B. ChangeLog auch immer so verwendet werden.

  • Zeilenumbruch-Format: Unix
  • Kodierung: UTF-8 ohne BOM
  • Tabulatorgröße: 8

Die wesentliche Anleitung zur Vorgehensweise findet sich wie schon erwähnt im Template selbst.

Hier vorweg noch einmal die wichtigsten Punkte der Lizenz
und der Erstbedingungen zum Verwenden, Bearbeiten und Verbreiten dieses Templates

(oder auch Scripten) von Hibiscus-Scripting (Sebastian Richter)

  1. Bitte unbedingt den Autor Sebastian Richter (Hibiscus-Scripting) bei Umsetzung einer Banken-Unterstützung informieren, damit nicht gleichzeitig an ein und der selben Bank gearbeitet wird. Dass wäre echt unnötig und dann auch von der Verbreitung ausgeschlossen!
  2. In jedem Fall ist als Quellenverweis und Autor Sebastian Richter / the Hibiscus-Scripting Project anzugeben!
  3. Wie in den Lizenzbedingungen angegeben darf eine Modifikation dieses Scripts nur unter den gleichen Lizenzbedingungen (d. h. unter der gleichen Lizenz) veröffentlicht werden! Hierbei ist immer das Copyright von Sebastian Richter / the Hibiscus-Scripting Project anzugeben!
  4. Eine Veröffentlichung in ein Public GitHub-Repository ist somit strengstens untersagt und verstößt gegen die Lizenzbestimmungen!
  5. Scripting-PlugIns die mit dem Template erstellt wurden (oder auf einem anderen Script beruhen) werden in jedem Fall in das Online-Repository von Hibiscus-Scripting aufgenommen (zusätzlich erhält man ein eigenes Forum im Hibiscus-Scripting Community-Forum)
  6. Die genaue Beschreibung dieser Sätze findet man im Template, ist nur unwesentlich länger und sollte aber von jedem genauestens beachtet werden!


http://hibiscus-scripting.derrichter.de/entwicklung/template_ver2.7.js?attredirects=0&d=1

Kurzanleitung:

Zu aller erst muss nun natürlich das Template manuell wie ein Script in Jameica/Hibiscus hinzugefügt und eingebunden werden.
Dann sieht man auch Live im Log was passiert (Stichwort BareTail)

Dieses ist natürlich direkt frei von Syntaxfehlern was direkt beim initialisieren überprüft wird. Bei jedem Speichervorgang dauert es max. 5sec und es wird wieder auf richtigen Syntax durch Jameica geprüft. Sollte ein Fehler im Syntax herrschen sehen Sie dies sofort im Live-Log.
(einfach mal testen: ein einsames Zeichen in einer freien Zeile hinzufügen und speichern)

Die ersten Bearbeitungsschritte und weitere nützliche Hinweise befinden sich wie schon gesagt direkt im Template.
Es ist jedem empfohlen zuerst den gesamten Text im Template vollständig zu lesen bevor begonnen wird!




Erstellen eines Scripting-PlugIns
(einer ZIP-Datei die als PlugIn ins Repository aufgenommen und installiert werden kann)

Eine ausführliche Anleitung findet man im Wiki von Hibiscus.

Grundsätzlich sind folgende Inhalte einzuhalten um ein Scripting-PlugIn von und für Hibiscus-Scripting veröffentlichen und verbreiten zu dürfen und können:

 hibiscus.script.abcbank.zip
    |
    +-- hibiscus.script.abcbank (Ordner)
         |-- ChangeLog.txt
|-- hibiscus.script.abcbank.js
|-- License.txt
|-- plugin.xml         
(Ein lib-Ordner ist wie im Wiki-Eintrag eigentlich nie notwendig
vor allem darf hier NICHT HTMLUnit hinzugefügt werden da dafür ein zentrales PlugIn besteht!
)

Der Aufbau innerhalb der Datei darf nicht gelöscht werden sondern lediglich ergänzt und bedingt angepasst.

Alle notwendigen Dateien als Beispiele (außer des Scripting-Templates weiter oben) findet man unten im Anhang dieses Artikels.





Soweit ein frohes Programmieren und auf gute Zusammenarbeit.
Tipp: Speziell für die Zusammenarbeit und für Hilfe und Tipps zu Codes und Umsetzungsmöglichkeiten von Problemen wird empfohlen sich im Community-Forum anzumelden
und sich die Rechte für den Bereich für Entwickler zuordnen zu lassen.

Gruß

kostenlos Stromtarife vergleichen mit TopTarif.de

Creative Commons Lizenzvertrag
Hibiscus Scripting-PlugIns
von Sebastian Richter sind lizenziert unter einer
Creative Commons
Namensnennung - Nicht kommerziell - Keine Bearbeitungen
4.0 International Lizenz
.
Über diese Lizenz hinausgehende Erlaubnisse können Sie unter Kontakt erhalten.


ċ
ChangeLog.txt
(14k)
Sebastian Richter,
22.03.2016, 10:50
ċ
LICENSE.txt
(18k)
Sebastian Richter,
15.03.2014, 06:56
ċ
plugin.xml
(1k)
Sebastian Richter,
19.09.2016, 00:02
ċ
template_ver2.7.js
(162k)
Sebastian Richter,
15.08.2017, 22:50