Entwicklung/Erstellen einer Hello World LibreOffice-Erweiterung
TDF LibreOffice Document Liberation Project Community Blogs Weblate Nextcloud Redmine Ask LibreOffice Spende
In diesem Tutorial werden wir eine "Hello World"-Erweiterung für LibreOffice Calc unter Verwendung der LibreOffice Basic-Sprache erstellen. Es ist eine einfache Erweiterung, um einige der grundlegenden Elemente einer Erweiterung in LibreOffice zu veranschaulichen. Die Erweiterung fügt eine Schaltfläche (neben der Schaltfläche "Als PDF exportieren") zur Standardsymbolleiste hinzu, und wenn sie angeklickt wird, wird ein Dialog mit "Hello, World!" angezeigt. Der Quellcode für dieses Tutorial ist auf github.
Schritt 1. Erstellen eines Ordners für unsere Erweiterung
1) Wählen Sie einen Speicherort und erzeugen Sie einen Ordner namens helloworld.
Schritt 2. Erstellen einer Bibliothek für unser Makro
1) Öffnen Sie LibreOffice Calc. Wählen Sie in der Menüleiste Werkzeuge > Makros > Makros organisieren > LibreOffice Basic.
2) Klicken Sie auf die Schaltfläche Organisation.
3) Wählen Sie die Registerkarte Bibliotheken und klicken Sie auf die Schaltfläche Neu.
4) Nennen Sie sie HelloWorldLibrary und klicken Sie auf OK. Die erstellte Bibliothek ist in der Liste Library zu sehen.
5) Klicken Sie auf die Schaltfläche Schließen, um das Dialogfeld LibreOffice Basic Macro Organisation zu verlassen.
Schritt 3. Erstellen des Makros
1) Wählen Sie Meine Makros > HelloWorldLibrary >Module1 und klicken Sie auf die Schaltfläche Bearbeiten.
2) Kopieren Sie das unten stehende Makro und fügen Sie es in die LibreOffice Basic IDE ein, dann speichern Sie es (Strg+S).
Sub HelloWorldMacro
MsgBox "Hello, World!"
End Sub
Schritt 4. Exportieren unserer Bibliothek
1) Wählen Sie in der Menüleiste der LibreOffice Basic IDE Werkzeuge > Makros organisieren > LibreOffice Basic.
2) Klicken Sie auf die Schaltfläche Organisation.
3) Wählen Sie die Registerkarte Bibliotheken und wählen Sie HelloWorldLibrary aus der Bibliotheksliste, dann klicken Sie auf die Schaltfläche Exportieren.
4) Wählen Sie Export als BASIC-Bibliothek und klicken Sie auf OK.
5) Speichern Sie die Bibliothek in unserem Ordner helloworld und klicken Sie dann auf Schließen, um die LibreOffice Basic Makro Organisation und LibreOffice Basic Makros zu verlassen. Wie wir unten sehen, enthält die exportierte Bibliothek 3 Dateien.
Schritt 5. Hinzufügen einer Beschreibung zu unserer Erweiterung
1) Gehen Sie zum Ordner helloworld und erstellen Sie einen Unterordner mit dem Namen Pkg-Beschreibung.
2) Erstellen Sie im Ordner der pkg-Beschreibung eine Datei namens pkg-beschreibung.de.
3) Fügen Sie den folgenden Inhalt in die Datei pkg-beschreibung.de ein, klicken Sie auf Speichern (Strg+S) und schließen Sie die Datei.
Hello World LibreOffice-Erweiterung. Copyright (c) Ihr Name 2024.
Schritt 6. Hinzufügen einer Lizenz
1) Erstellen Sie im Ordner helloworld einen Unterordner mit dem Namen Registrierung.
2) Erstellen Sie im Ordner Registrierung eine Datei mit dem Namen Lizenz.txt, und fügen Sie den Inhalt von diesem Link ein. Speichern Sie dann (Strg+S) und schließen Sie die Datei.
Schritt 7. Hinzufügen der Manifestdatei
1) Erstellen Sie im Ordner helloworld einen Unterordner namens META-INF.
2) Erstellen Sie im Ordner META-INF eine Datei mit dem Namen manifest.xml und fügen Sie den unten stehenden Inhalt ein. Speichern Sie dann (Strg+S) und schließen Sie die Datei.
<?xml version="1.0" encoding="UTF-8"?>
<manifest:manifest>
<manifest:file-entry manifest:full-path="HelloWorldLibrary/" manifest:media-type="application/vnd.sun.star.basic-library"/>
<manifest:file-entry manifest:full-path="pkg-description/pkg-description.en" manifest:media-type="application/vnd.sun.star.package-bundle-description;locale=en"/>
<manifest:file-entry manifest:full-path="Addons.xcu" manifest:media-type="application/vnd.sun.star.configuration-data"/>
</manifest:manifest>Schritt 8. Hinzufügen von Bildern
1) Erstellen Sie im Ordner helloworld einen Unterordner namens Symbole.
2) Gehen Sie zu diesem Link und laden Sie dort die 2 Bilder herunter, speichern Sie sie im Ordner "Symbole".
Schritt 9. Hinzufügen der Beschreibungsdatei
1) Erstellen Sie im Ordner helloworld eine Datei namens Beschreibung.xml.
2) Fügen Sie den folgenden Inhalt in die Datei Beschreibung.xml ein. Dann speichern (Strg+S) und Datei schließen.
<?xml version='1.0' encoding='UTF-8'?>
<description
xmlns="http://openoffice.org/extensions/description/2006"
xmlns:dep="http://openoffice.org/extensions/description/2006"
xmlns:xlink="http://www.w3.org/1999/xlink">
<identifier value="org.broffice.helloworldmacro"/>
<icon>
<default xlink:href="icons/image_42.png" />
</icon>
<version value="1.0"/>
<registration>
<simple-license accept-by="admin" default-license-id="ID0" suppress-on-update="true" >
<license-text xlink:href="registration/license.txt" lang="en" license-id="ID0" />
</simple-license>
</registration>
<publisher>
<name xlink:href="mailto:youremail@smt.com">Your Name</name>
</publisher>
<display-name>
<name>Hello World</name>
</display-name>
</description>Schritt 10. Hinzufügen einer Schaltfläche zur Symbolleiste von LibreOffice Calc
1) Erstellen Sie im Ordner helloworld eine Datei namens Addons.xcu.
2) Kopieren Sie diesen Code und fügen Sie ihn in die Datei Addons.xcu ein. Dann speichern (Ctrl+S) und Datei schließen.
Schritt 11. Dies ist unsere bisherige Dateistruktur
Schritt 12. Verpacken der Erweiterung
1) Wählen Sie im Ordner helloworld alle Dateien aus (Strg+A).
2) Klicken Sie mit der rechten Maustaste, und komprimieren Sie zu helloworld.zip.
3) Benennen Sie helloworld.zip in helloworld.oxt um. Jetzt ist unsere Erweiterung fertig und im nächsten Schritt werden wir sie in LibreOffice Calc installieren.
Schritt 13. Installieren unserer Erweiterung in LibreOffice Calc
1) Öffnen Sie LibreOffice Calc und wählen Sie Werkzeuge > Erweiterungsmanager.
2) Klicken Sie auf die Schaltfläche Hinzufügen und wählen Sie unsere Erweiterung helloworld.oxt.
3) Akzeptieren Sie die Lizenzvereinbarung für die Erweiterungssoftware, um die Erweiterung zu installieren.
4) Klicken Sie auf die Schaltfläche Schließen und starten Sie LibreOffice Calc neu.
Wenn Sie beim Installieren der Erweiterung eine "!link" Warnung bekommen, entfernen Sie die HelloWorldLibrary bevor Sie die Erweiterung installieren, da LibreOffice keine Erweiterung über ein Makro mit dem selben Namen installieren kann:
- Öffnen Sie LibreOffice Calc. Wählen Sie in der Menüzeile Extras > Makros > Makros verwalten > Basic.
- Klicken Sie den Knopf Verwalten, gehen Sie auf den Tab Bibliotheken, wählen Sie HelloWorldLibrary aus der Liste Bibliothek:, dann klicken Sie auf den Knopf Löschen und bestätigen Sie, dass Sie die Bibliothek löschen wollen.
- Sie sollten nun in der Lage sein, die Erweiterung mit Schritt 1 bis 4 von oben zu installieren.
Schlussfolgerung
In diesem Tutorial haben wir eine Hello World-Erweiterung für LibreOffice Calc erstellt. Den vollständigen Quellcode finden Sie unter github.