Ahnenblattportal Forum Index
 •Portal  •Imprint  •Forum  •Search  •Profile  •Log in to check your private messages  •Log in   •Register  

 Plugins und Anderes Ab-Store tauglich machen

Post new topicReply to topic
Author Message
MarcP





Age: 39
Joined: 19 Apr 2010
Posts: 785
Topics: 37
Location: Bonn


blank.gif

PostPosted: 27.05.2013, 17:05    Plugins und Anderes Ab-Store tauglich machen  Reply with quoteBack to top

Zusammenfassung der Interaktion Ahnenblatt <> AbStore <> Download Portal

Kommentare/Fragen usw bitte in diesem Thread stellen.

Inhalt:
-abp Datei
-Download Portal
-Datei Struktur
-Zip Datei
-Deinstallationen

Allgemeines:
Um eine Einwandfreie Zuordnung "Lokales Plugin"<>"Download Potal" zu gewährleisten ist es wichtig das die "ID" Variable/Tag in der abp und im DownloadPortal gleich befüllt sind. Nur die Gross/Kleinschreibung wird ignoriert.


Last edited by MarcP on 24.11.2013, 10:59; edited 61 times in total

OfflineView user's profileSend private message    
MarcP





Age: 39
Joined: 19 Apr 2010
Posts: 785
Topics: 37
Location: Bonn


blank.gif

PostPosted: 27.05.2013, 17:10    (No subject)  Reply with quoteBack to top

abp Datei


da es (momentan?) nur bei Plugins die abp Dateien gibt (wie der Name auch sagt),befasst sich dieser Abschnitt eher mit Plugininformationen.

In ABP Dateien wird immer erst die [Plugin] Sektion ausgelesen und dabei versucht nötige Variablen zu finden.
Hat diese Datei auch eine [abstore] Sektion wird diese danach ausgelesen. Wurden vorher Werte schon befüllt und sind diese dann auch hier definiert dann werden diese Überschrieben.
> [abstore] hat höhere Prio als [plugin] da zuverlässiger.
zb ist die exe Erkennung schwierig durchzuführen da es keine Definition unter [plugin] gibt.

Die [Plugin Sektion] ist für Ahnenblatt selbst. dazu siehe hier: http://www.ahnenblattportal.de/viewtopic.php?t=3410

Auslesefunktionen welche Werte aus der [plugin] Sektion auslesen werden hier als "Legacy" bezeichnet. Diese Funktionen sind nötig um bei Dateien ohne oder unvollständiger [abstore] Sektion wichtige Variablen zu gewinnen damit ein Update möglich ist

-Alle hier definierten Werte müssen in der [abstore] Sektion eingetragen sein.
-Jeder Eintrag muss in einer eigenen Zeile stehen.
-Reihenfolge spielt keine Rolle
-Trennzeichen ist immer das Gleichheitszeichen. (Doppelpunkt nicht erlaubt)
-Alle Pfad und Dateiangaben sind relativ zum "Ahnenblatt\Plugin" verzeichniss zu sehen. Also von der abp Datei aus.
zb
"Directory=Ahnenblut" ist "..\Ahnenblatt\Plugins\Ahnenblut"
"Startfile=a.exe" ist "..\Ahnenblatt\Plugins\a.exe"
"Startfile=Ahnenblut\a.exe" ist "..\Ahnenblatt\Plugins\Ahnenblut\a.exe"

Ausname Dateien:
Befindet sich eine Datei im "Directory" Verzeichniss kann die Pfadangabe weggelassen werden.
zb:
"startfile=a.exe" kann "..\Ahnenblatt\Plugins\Ahnenblut\a.exe" sein wenn "directory=ahnenblut" ist

PluginVersion=x.x.x.x
empfohlen
Legacy: aus der Exe Versionsnr. (Wenn diese Datei gefunden werden kann.)
Version des Plugins. Fehlende "Zähler" werden intern hinten mit 0ern aufgefüllt.zb: PluginVersion=1.2 >> 1.2.0.0
Hinweis zu Versionsvergleiche:
jede Stelle ist als eigene Zahl anzusehen. Keine Kommastelle o.ä.. Es wird von links nach rechts verglichen Bsp.
2.3 > 1.4 (da 2 > 1)
2.10 > 2.9 (da 2 = 2 und.... 10>9. oder: 2.9 ist das gleiche wie 2.09 Nicht 2.90!)

ABVersion=x.x.x.x oder ABVersion=x.x.x.x-x.x.x.x
empfohlen
Legacy: aus Plugin Sektion. Hier kann nur "von" Angabe stehen.
benötigte AB Version. Kann nur "von" Angabe, sowie von-bis Bereich enthalten.
zb:abversion=2.50 oder Bereich: abversion=2.50-2.74

ID=xxx
zwingend wenn Ab store Sektion vorhanden. Sonst keine Zuordnung lokal<>store
Legacy: aus dem "Text=" Eintrag. Nicht dem Sprachtag. Unabhängig der eingestellten Sprache
Identifikation des Plugins
Oft gleichbedeutend mit dem Namen

Name=xxx und/oder Sprachtags z.B. name.1031=xxx als deutsche Angabe
empfohlen. wenn Bezeichnung im Abstore von der Bez in AB ("text=...") abweichen soll.
Legacy: aus dem "Text=" Eintrag. bzw dem entsprechenden Sprachtag. zb "text.1031=xxx" bei deutsch.
Bezeichnung des Plugins im AbStore

Autor=xxx oder Author=xxx
empfohlen
Legacy: aus den Exe Eigenschaften-Firma/Entwickler (Wenn diese Datei gefunden werden kann.)
Der Autor.

Status=xxx
optional
Status des Plugins. Momentan nur "beta" möglich
Beta: Plugin wurde vom Programmierer als Programm "in Entwicklung" bezeichnet und ist noch wenig getestet und kann diverse Bug enthalten. Noch nicht zum produktiven Einsatz gedacht.
Um diese Programme im Store zu sehen muss in den Optionen dieses aktiviert werden. Weiterhin werden diese "besonders" gekennzeichnet und bei Installation und Update wird immer darauf hingewiesen.

Directory=xxx
optional
Legacy: wird aus der gefundenen exe erzeugt wenn im Pluginverz.
Ist ein zusätzliches Verzeichniss. Normalerweise das Plugin Unterverzeichniss.
Hier wird immer zuerst gesucht wenn eine datei (startfile,picture,icon...) ohne pfad angegeben ist.
Bei Deinstallation wird dieses gelöscht und hat so neben der abp Datei das Plugin komplett deinstalliert (es ist nicht nötig Dateilisten zu führen)

Startfile=xxx.exe
optional
Legacy: unter "MustExist1, wenn hier nicht gefunden dann im Ablauf. Ist sehr unsicher da zb. mehrere exe'n oder auch ohne Erweiterung angegeben sein könnten.
Startdatei des Plugins.

Icon=xxx.ico
wird momentan nicht verwendet

Symbol=xxx.jpg
optional
ein Symbolbild für diverse Darstellungen im Store. Empfohlen 128x128pixel.

Picture=xxx.jpg
optional
ein Vorschaubild.

Language=xxx,xxx,xxx
optional
unterstützte Sprachen. durch Komma getrennt
Siehe Spalte IOC:
https://de.wikipedia.org/wiki/ISO-3166-1-Kodierliste

Description=xxxx und/oder Sprachtags z.B. Description.1031=xxx
optional
Kurzbeschreibung des Plugins.
Zeilenumbrüche sind mit /n zu markieren

notDelF=xxx,xxx
optional
Datei Auflistung. Diese werden bei einem Update nicht gelöscht.
Die Pfad Angabe ist ausgehend Hauptverzeichniss des Plugins zu sehen.
Befinden sich diese Dateien allerdings auch in der neuen Plugin Version (bzw zip), werden diese überschreiben.
Dies ist zb nützlich um Dateien welche das Plugin selbst erzeugt beim Update nicht zu löschen. (ABstore löscht normalerweise das komplette Verzeichniss des Plugins wenn dieses ein Update erhält)

notDelD=xxx,xxx
wie notDelF. Nur halt Verzeichnisse

DataTyp=xxxx
optional, für "Plugin Base"
Ein & Ausgabe Typ der Daten
Werte: "CSV" "GEDCOM"

DataInVersion=xxxx DataOutVersion=xxxx
optional, für "Plugin Base"
Bereichsangabe möglich zb "2.5-2.8"
Ein/Ausgabe Version der Daten welche der AB Version entspricht.(bei csv)
weitere Infos zu CSV Formatierung siehe hier: http://www.ahnenblattportal.de/viewtopic.php?t=5257

NeedNoData=xxxx
optional, für "Plugin Base"
Plugin kann ohne Daten gestartet werden
Werte: "yes" "no" "ja" "nein"

PluginBase=xxxx
optional, für "Plugin Base"
ob Plugin kompatibel für das Plugin "Plugin Base" ist.
Werte: "yes" "no" "ja" "nein"


Bsp abp:
Quote:
[plugin]
version=2.50
filemustbeopened=1
text=AB Positiv
MustExist.1=%abpluginpath%\AB Positiv\AB Positiv.exe
1=$SAVEAS(CSVFILE-UNICODE,%abpluginpath%\AB Positiv\ABPositiv.csv)
2=%abpluginpath%\AB Positiv\AB Positiv.exe

[abstore]
PluginVersion=0.1.0.0
Author=MarcP
ID=AB Positiv
Name=AB Positiv
Directory=AB Positiv
Startfile=AB Positiv.exe
Picture=folder.png
Symbol=symbol.jpg
Description=Ermittelt Verwandschaftsbeziehung, erstellt Listen aller Vor-Nachfahren, gemeinsamer Ahn und mehr.
Status=beta
data_in_typ=csv
data_in_version=2.5-2.74
data_out_typ=csv
data_out_version=2.74


Last edited by MarcP on 24.08.2017, 22:23; edited 83 times in total

OfflineView user's profileSend private message    
MarcP





Age: 39
Joined: 19 Apr 2010
Posts: 785
Topics: 37
Location: Bonn


blank.gif

PostPosted: 27.05.2013, 22:03    (No subject)  Reply with quoteBack to top

DownloadPortal


Der Store unterscheidet Plugins, Rahmen und Tafeln anhand des Textes im "Name" Feld. Es wird nicht nach der Kategorie in welchen sich der Download befindet unterschieden!
Bsp:
"Plugin: Ahnenblut", "Rahmen: Laubblatt", "Tafel: Mammutbaum"
Vor dem Doppelpunkt ist die Kategorie, der Text danach kann als "Name" genommen werden (alternativ).

Alle folgenden Angaben müssen in runden Klammern in den Beschreibungstext gesetzt sein. Es ist egal ob zeilenweise oder mit zeilenumbruch.
Es wird das Gleichheitszeichen und Doppelpunkt als Trennzeichen akzeptiert. zb (Version:2) und (Version=2)
Bedeutung der folgenden Variablen entspricht den gleichnamigen aus den abp Dateien und werden hier nicht nochmals erklärt.
Alle folgenden Angaben beziehen sich auf Plugins.
Rahmen und Tafeln dürfen die Angaben haben. Müssen aber nicht.

(PluginVersion=x.x.x.x) oder (Version=x.x.x.x)
benötigt

(ABVersion=x.x.x.x) oder (ABVersion=x.x.x.x-x.x.x.x)
optional
ab oder bei welchen AB Versionen das Plugin läuft.
Entspricht der "Version" in der abp Sektion [Plugin].

(ID=xxx)
benötigt

(Author=xxx) oder (Autor=xxx)
optional

(Name=xxx)
optional
Alternativ aus dem Namensfeld.

(Lang=xxx,xxx,xxx)
optional
Unterstützte Sprachen durch Komma getrennt.
Siehe Spalte IOC
https://de.wikipedia.org/wiki/ISO-3166-1-Kodierliste

(Status:xxx)
optional

(Forum:xxx)
optional
Link zum Forumbeitrag wenn vorhanden. Damit im Browser der Link direkt aufgerufen werden kann sollte nach dem ":" oder "=" eine Leertaste gesetzt werden.

alle weiteren Werte wie "Klicks;Bewertungen;Urls" werden aus den Entsprechenden HTML Feldern ausgelesen.

Es gibt, nur für Admins editierbar, noch extra Eingabefelder für Version und Autor. Diese werden nur bis Abstore0.8 berücksichtigt.


Last edited by MarcP on 20.03.2017, 22:32; edited 32 times in total

OfflineView user's profileSend private message    
MarcP





Age: 39
Joined: 19 Apr 2010
Posts: 785
Topics: 37
Location: Bonn


blank.gif

PostPosted: 27.05.2013, 23:42    (No subject)  Reply with quoteBack to top

DateiStruktur

Plugins

Generell sollte das System: "jedes Plugin hat sein eigenes Unterverzeichniss" verwendet werden da es die sauberste Lösung darstellt.
Beispiele:

-------------------------------------------------------------------------------------
* so soll es sein:

-\Plugins\
-\Plugins\myTool.abp
-\Plugins\MyToolDir\
-\Plugins\MyToolDir\myTool.exe
-\Plugins\MyToolDir\mydatei1.txt
-\Plugins\MyToolDir\mybild.bmp

abp, [ab store] abschnitt:

name=mytool
Startfile=mytool.exe
directory=MyToolDir

Bei der Deinstallation wird die abp datei und das Unterverzeichnis welches in "directory" steht gelöscht >> Plugin ist mit allen Dateien restlos entfernt.
-------------------------------------------------------------------------------------
* so nicht:

-\Plugins\
-\Plugins\myTool.abp
-\Plugins\myTtool.exe
-\Plugins\mydatei1.txt
-\Plugins\mybild.bmp

abp, [ab store] abschnitt:

name=mytool
Startfile=mytool.exe

Bei einer Deinstallation werden wie immer die abp datei und die startdatei gelöscht. Die text und bmp Datei können dem Plugin nicht zugeordnet werden und bleiben demnach zurück. Keine Problem für die restlichen Plugins aber das Verzeichnis müllt zu.
Ein weiteres Problem kann eintreten wenn Plugins Dateien mit identischen Namen benutzen. zb Config Dateien bei .Net Programmen heißen alle gleich. oder die beliebte "liesmich.txt" usw

Tafeln



Rahmen


Last edited by MarcP on 24.11.2013, 10:51; edited 14 times in total

OfflineView user's profileSend private message    
MarcP





Age: 39
Joined: 19 Apr 2010
Posts: 785
Topics: 37
Location: Bonn


blank.gif

PostPosted: 28.05.2013, 09:01    (No subject)  Reply with quoteBack to top

Die Zip Datei


Plugins:

im Hauptverzeichniss der zip muss die abp Datei sein.
dazu die weiteren Dateien und Verzeichnisse wie diese auch im Ahnenblatt\Plugin Verzeichnis erscheinen sollen.

Bsp:

Zip:
download.zip>myTool.abp
download.zip>MyToolDir\
download.zip>MyToolDir\myTool.exe
download.zip>MyToolDir\mydatei1.txt
download.zip>MyToolDir\mybild.bmp

Installiert:
...\ahnenblatt\plugins\myTool.abp
...\ahnenblatt\plugins\MyToolDir\
...\ahnenblatt\plugins\MyToolDir\myTool.exe
...\ahnenblatt\plugins\MyToolDir\mydatei1.txt
...\ahnenblatt\plugins\MyToolDir\mybild.bmp

Tafel und Rahmen

Alle Dateien müssen sich im zip Hauptverzeichniss befinden.
Unterverzeichnisse sind nicht erlaubt.
Kein Vermischen von Rahmen- und Tafelbilder. >> getrennte Downloadpakete im Portal einstellen


Last edited by MarcP on 24.11.2013, 01:48; edited 1 time in total

OfflineView user's profileSend private message    
MarcP





Age: 39
Joined: 19 Apr 2010
Posts: 785
Topics: 37
Location: Bonn


blank.gif

PostPosted: 24.11.2013, 01:30    (No subject)  Reply with quoteBack to top

Deinstallation (was wird gelöscht):



Plugin:

- abp Datei
- "Directory" Verzeichniss. Normalerweise das Unterverzeichniss des Plugins in "Ahnenblatt\Plugins\"

Exe Startdateien werden nicht gesondert gelöscht. Es wird davon ausgegangen das Plugins immer ein eigenes UnterVerzeichniss ("Directory") besitzen in welchem sich die Exe befinden sollte.

Rahmen:

- ini Datei
- m & w Rahmenbild welche in der ini stehen

Tafel:

- Tafelhintergrundbild

_________________
>> Übersetzer gesucht <<

AB Store Plugin

OfflineView user's profileSend private message    
Display posts from previous:      
Post new topicReply to topic


 Jump to:   




Show permissions


Board Security

Powered by Orion based on phpBB © 2001, 2002 phpBB Group
CBACK Orion Style based on FI Theme
All times are GMT + 2 Hours



[ Page generation time: 0.1223s (PHP: 88% - SQL: 12%) | SQL queries: 32 | GZIP enabled | Debug on ]