Metainformationen zur Seite

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
en:entwickler:grundlagen_zur_erstellung_eines_plugins [2025/01/23 19:17] – Braveen:entwickler:grundlagen_zur_erstellung_eines_plugins [2025/01/23 19:36] (aktuell) – Completely translated page Brave
Zeile 1: Zeile 1:
-FIXME **Diese Seite wurde noch nicht vollständig übersetzt. Bitte helfen Sie bei der Übersetzung.**\\ //(diesen Absatz entfernen, wenn die Übersetzung abgeschlossen wurde)// 
- 
 ====== Basics for creating a plugin ====== ====== Basics for creating a plugin ======
  
Zeile 36: Zeile 34:
 Zip the directory and install it on the LoxBerry. Ignore any installation errors - these come from the sample data of the sample plugin and can be corrected later.  You will then find your plugin in the plugin administration.  LoxBerry has created directories corresponding to the name of your plugin on the Raspberry. Zip the directory and install it on the LoxBerry. Ignore any installation errors - these come from the sample data of the sample plugin and can be corrected later.  You will then find your plugin in the plugin administration.  LoxBerry has created directories corresponding to the name of your plugin on the Raspberry.
  
-^Folder                                                    ^Function                                                                                                                                 ^ |/opt/loxberry/webfrontend/htmlauth/plugins///deinplugin///|Directory for your web interface (authentication required)                                                                          | |/opt/loxberry/webfrontend/html/plugins///deinplugin///    |Directory for Websites without authentication                                                                                         | |/opt/loxberry/templates/plugins///deinplugin///           |Especially when using Perl and HTML::Template, you store HTML templates here. The lang subdirectory contains the  Sprachdateien.| |/opt/loxberry/config/plugins///deinplugin///              |Directory for your configuration files                                                                                              | |/opt/loxberry/bin/plugins///deinplugin///                 |Directory for Executable files that should not be accessible from the web                                                        | |/opt/loxberry/log/plugins///deinplugin///                 |Directory for your log files                                                                                                         | |/opt/loxberry/data/plugins///deinplugin///                |Directory for any other data that your plugin requires or generates                                                           |+^Folder                                                    ^Function                                                                                                                        ^ 
 +|/opt/loxberry/webfrontend/htmlauth/plugins///deinplugin///|Directory for your web interface (authentication required)                                                                      | 
 +|/opt/loxberry/webfrontend/html/plugins///deinplugin///    |Directory for Websites without authentication                                                                                   | 
 +|/opt/loxberry/templates/plugins///deinplugin///           |Especially when using Perl and HTML::Template, you store HTML templates here. The lang subdirectory contains the Language files.| 
 +|/opt/loxberry/config/plugins///deinplugin///              |Directory for your configuration files                                                                                          | 
 +|/opt/loxberry/bin/plugins///deinplugin///                 |Directory for Executable files that should not be accessible from the web                                                       | 
 +|/opt/loxberry/log/plugins///deinplugin///                 |Directory for your log files                                                                                                    | 
 +|/opt/loxberry/data/plugins///deinplugin///                |Directory for any other data that your plugin requires or generates                                                             |
  
 ==== Step 4: Implement function ==== ==== Step 4: Implement function ====
Zeile 59: Zeile 64:
 Use readlanguage (Perl, PHP) to offer alternative languages for your plugin. Use readlanguage (Perl, PHP) to offer alternative languages for your plugin.
  
-==== Schritt 6: Installation anpassen ====+==== Step 6: Customize installation ====
  
-Wenn am installierten LoxBerry deine Sachen halbwegs funktionieren, aktualisiere dein Plugin-Paket:+If your things work reasonably well on the installed LoxBerry, update your plugin package:
  
-  * Kopiere die neuen Programmdateien in das Verzeichnis, wovon du anfangs das ZIP mit der geänderten plugin.cfg erstellt hast. +  * Copy the new program files into the directory from which you initially created the ZIP with the modified plugin.cfg. 
-  * Wenn während der Installation, oder während des Plugin-Updates spezielle Schritte nötig sind, aktualisiere in diesem Verzeichnis die Install-Scripts (z.B. Sichern der Config während des Updates) +  * If special steps are required during the installation or during the plugin update, update the install scripts in this directory (e.g. save the config during the update) 
-  * Wenn spezielle Debian-Pakete für dein Plugin nötig sind, aktualisiere im Ordner apt das apt-File und füge dort die Paketnamen ein.+  * If special Debian packages are required for your plugin, update the apt file in the apt folder and add the package names there.
  
-==== Schritt 7: Testen und weitermachen ====+==== Step 7: Test and continue ====
  
-//Bevor zu deinen Quellordner neu zippst und installierst, stelle sicher, dass wirklich alle Dateien vom LoxBerry in deiner Quelle am PC sind - während des Updates werden alle Ordner am LoxBerry gelöscht, um diese bei der Installation wieder anzulegen.//+//Before you rezip and install your source folder, make sure that all files from the LoxBerry are really in your source on the PC - during the update, all folders on the LoxBerry are deleted in order to recreate them during the installation.//
  
-Danach kannst du die Installation testen. Meist kommt man dabei auf etwaige Fehler in den Installationsscripten drauf. Du kannst danach alles so durchtesten, wie es sich dann auch bei anderen Benutzern verhält. +You can then test the installation. This usually reveals any errors in the installation scripts. You can then test everything in the same way as it behaves for other users.  
  
-==== Schritt 8: Hilfe holen ====+==== Step 8: Get help ====
  
-Manche Sachen sind beim ersten Mal ungewöhnlich, deswegen nicht verzweifeln sondern Rat einholen.+Some things are unusual the first time, so don't despair but seek advice.
  
-Alle LoxBerry-Plugin-Entwickler schauen regelmäßig im LoxForum in den Entwickler-Bereich für LoxBerry: [[https://www.loxforum.com/forum/projektforen/loxberry/entwickler]]+All LoxBerry plugin developers regularly check the LoxForum in the developer area for LoxBerry: [[https://www.loxforum.com/forum/projektforen/loxberry/entwickler]]
  
-Außerdem betreiben wir eine WhatsApp-Gruppe für LoxBerry-Entwickler, wo das Troubleshooting viel schneller geht. Bitte dafür mit [[https://loxwiki.atlassian.net/wiki/people/6166fb1fc5388b0069f9351f?ref=confluence|Christian Fenzl]]Kontakt aufnehmen (inkl. Name und Telefonnummer).+We also run a WhatsApp group for LoxBerry developers, where troubleshooting is much faster. Please join with [[https://loxwiki.atlassian.net/wiki/people/6166fb1fc5388b0069f9351f?ref=confluence|Christian Fenzl]] Contact us (incl. name and telephone number).
  
-==== Schritt 9: Öffentlicher Test ====+==== Step 9: Public test ====
  
-Schlussendlich würden wir vorerst deine Alpha/Beta-Version im LoxForum anbieten zum Testen (mit entsprechendem Disclaimer, dass es noch Alpha-Stand ist). Wenn die gröberen Probleme ausgeräumt sind, solltest du im LoxWiki dein neues Plugin anlegen und dokumentieren. Machs so, wie es die anderen Plugin-Autoren machen.+Finally, we would first offer your alpha/beta version in the LoxForum for testing (with a corresponding disclaimer that it is still alpha). Once the major problems have been resolved, you should create and document your new plugin in the LoxWiki. Do it like the other plugin authors do.
  
-===== Empfehlungen =====+===== Recommendations =====
  
-==== Codeverwaltung mit GitHub ====+==== Code management with GitHub ====
  
-Mit der Windows-Software GitHub Desktop kannst du dein Plugin-Quellverzeichnis als öffentliches Repository bei Github hosten. Vorteile sind: Du hast eine echte Code-Verwaltung mit Änderungsverfolgung und der Möglichkeit, Änderungen rückgängig zu machen. Außerdem können dich andere Entwickler bei Problemen oder Fehlern leichter unterstützen, wenn sie direkt Einblick in deinen Code bekommen.+With the Windows software GitHub Desktop, you can host your plugin source directory as a public repository on Github. The advantages are: You have real code management with change tracking and the ability to undo changes. In addition, other developers can support you more easily with problems or errors if they have direct insight into your code.
  
-Die in LoxBerry eingebaute Update-Funktion für Plugins ist für GitHub optimiert.+LoxBerry's built-in update function for plugins is optimized for GitHub.