Thema: Pluginentwicklung - Dokumentation

Schau dir einfach mal die Exemple.php's in den ordner der plugins an und dann die die drin sind. damit lernt man schon mal was.

Hallo,

was haltet ihr von sowas, Idee, Verbesserung, Lob und Tadel, alles ist willkommen. Achtung: Das Ergebnis stimmt nur nach Ansicht und wurde noch nicht auf einem Server getestet.

Erstellung eines Plugins für Joomla :: Joomlashare-Doc #001

INHALT:

01. ERSTELLUNG DER METADATEN ... fehlt
02. ERSTELLUNG DER DATEILISTE
03. ERSTELLUNG DER PARAMETER ... fehlt

02. ERSTELLUNG DER DATEILISTE

Problemstellung:
In der XML-Datei eines Plugin (früher "Mambot" genannt) muss jede einzelne Plugin-Datei mit vorangestelltem Dateipfad aufgeführt werden. Stellen Sie sich den Zeitaufwand bei einigen hundert oder gar tausend Dateien vor,
wenn diese abgetippt oder per Copy & Paste aus einem Browser heraus umständlich erstellt würden!

Problemlösung (mit Windows):
Es gibt viele kleine Programme ("Tools"), die Dateien- und Verzeichnisbäume rekursiv ausdrucken. Die meisten meiner Testkandidaten waren nicht intuitiv zu bedienen. Meistens war auch der Funktionsumfang nicht ausreichend. Angenehm unter all den Merkwürdigkeiten fällt das kleine Programmlein von Manfred Dietberg mit dem unscheinbaren Namen "Dirprint" auf. Aber Vorsicht, es gibt viele Programme, die diesen Namen tragen.
Mit Dirprint und einem Texteditor können sie in kurzer Zeit eine vollständige Dateiliste für ihre XML-Installationsdatei erzeugen.

Und zwar so:

1. Starten sie Dirprint, stellen Sie per Button (siehe Flaggen-Symbol) die deutsche Sprache ein.
2. Wählen sie bei Optionen "Verzeichnispfad anzeigen"
3. Suchen und klicken Sie links im Dateibrowser das Verzeichnis an, dass sie in eine Datei ausdrucken wollen
4. Gehen Sie im Menü auf "Aktion" und dort auf "mit Unterverzeichnissen einlesen" - die Dateinamen werden eingelesen
5. Speichern Sie die Datei oder wählen Sie rechts alles aus und kopieren sie den eingelesenen Text
6. Fügen Sie die Datei mit Laden oder Einfügen in den Text-Editor ihrer Wahl ein (z.B. UltraEdit)
7. Bereinigen Sie per Search&Replace den Dateipfad von unerwünschten Pfadanteilen
8. Im Fall eine Joomla-Plugins sollte der Verzeichnisname unterhalb des Plugin-Verzeichnisses am Anfang stehen
9. Üblicherweise sprechen Sie die Dateien auf einem Linux-Server an, wechseln Sie daher alls Backslash-Zeichen "\"
in Slash-Zeichen "/" mit Search&Replace.
10. Fügen Sie mit Search&Replace "<filename>" vor jeden Dateinamen ein.
Beispiel-Suchbegriff: "Pluginname/"
Beispiel-Ersetzung: "<filename>Pluginname/"
11. Mit Search&Replace fügen Sie anschließend das XML-End-Tag "</filename>" an das Zeilenende (jeder Zeile) an, also z.B. "<filename>" ersetzen durch "</filename><filename>" und anschließend Anfang und Ende der Datei noch per Hand korrigieren,

Mit Ultraedit sieht die Syntax für Windows/Dos am besten so aus:
Suche: "^p<filename>"
Ersetze: "</filename>^n<filename>"

Bitte auch danach am Datei-Anfang und -Ende noch nachkorrigieren.

11. Was fehlt dabei noch? Umranden Sie die Dateinamen mit den parent-Tags <files> und </files>
12. Kopieren Sie die Dateiliste in ihr Plugin. Normalerweise kommen dort zuerst die Metadaten, oft mit der Beschreibung, dann erst folgt die Dateiliste und zuletzt kommen die Parameter für Werteübergaben an das Plugin zur Laufzeit.
13. Voilá, packen Sie das Teil und testen Sie es.
14. Vielleicht muss noch jeweils eine seperate index.html in allen Ordnern erstellt werden - kein Ahnung.

Hinweis: Verzeichnisrechte für Linux-Server können nur unter Linux bzw. virtuellem Linux unter Windows/Mac
auf Dateien und Verzeichnisse übertragen werden (soweit ich das weiß). Daher sollte dann Linux zum
Einsatz kommen, wenn Schreibrechte bei der Installation Dateien und Verzeichnissen zugewiesen werden sollen.

Warum ich kein Wiki benutzt habe? Weil ich mir sicher war, dass ich nur wenig bzw. noch nicht alles Notwendige weiß. Und da ich kein Freund großer Bücher bin und man gute Infos über Joomla im www nur sehr verstreut findet, ist das Vorgehen sicher nicht ganz verkehrt.

Natürlich hast du Recht, das Problem ist bei allen Erweiterungen das gleiche, soweit habe ich in dem Moment der Plugin-Erstellung gar nicht gedacht.

Was deine Komponente easyCreator anbetrifft, die ich gerade mal ausprobiert habe, scheint sie ihren Dienst zu tun. Was mir sofort aufgefallen ist, dass die Bedienung des Assistenten zu unübersichtlich und nicht optimal sowie auch nicht barrierefrei ist. Aber du weißt ja, motzen kann man immer und ich weiß selbst, wieviel Arbeit in Design und Programmierung steckt.

Auf jeden Fall danke für deine Tipps.

Jau, das Wiki http://www.joomla-wiki.de finde ich super.

Weiteres per PM.