Ein Add-On erstellen

Sie erstellen aus Ihrem benutzerspezifischen Framework ein Add-On und stellen dieses für andere User zur Verfügung.

  1. Erstellen Sie einen Ordner mit dem Namen Ihres Frameworks, z.B. ediarum.MeineEdition.edit.
  2. Kopieren Sie alle Ordner und zugehörigen Dateien aus Ihrem Framework (u.a. CSS-, Schema- oder Template-Verzeichnisse sowie Layout-, Framework- und Projektdateien) in das neu erstellte Verzeichnis.
  3. Erstellen Sie aus dem Verzeichnis eine ZIP-Datei. Die Benennung der ZIP-Datei sollte den Namen Ihres Projekts und eine Versionsangabe beinhalten. (z.B. ediarum.MeineEdition.edit_v1.5.2.zip)
    Sie haben eine versionierte ZIP-Datei mit den Inhalten Ihres Frameworks erstellt.
  4. Erstellen Sie eine Datei update.xml. Diese wird später von Oxygen XML zur Verwaltung von Add-On-Updates genutzt.
    Beispiel für die update.xml: 
    
    
    <xt:extensions xmlns:xt="http://www.oxygenxml.com/ns/extension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.oxygenxml.com/ns/extension http://www.oxygenxml.com/ns/extension/extensions.xsd">
        <!-- ID des Add-Ons -->
        <xt:extension id="ediarum.MeineEdition.edit">
        
            <!-- Name der aktuellen ZIP-Datei des Add-Ons. -->
            <xt:location href="ediarum.MeineEdition.edit_v1-5-2.zip"/>
            
            <!-- Version des aktuellen Add-Ons. -->
            <xt:version>1.5.2</xt:version>
            
            <!-- Mindestens benötigte Oxygen-Version. -->
            <xt:oxy_version>21.0+</xt:oxy_version>
            
            <!-- Typ des Add-Ons: Framework -->
            <xt:type>framework</xt:type>
            
            <!-- Autorenangabe -->
            <xt:author>TELOTA-Arbeitsgruppe an der Berlin-Brandenburgischen Akademie der Wissenschaften</xt:author>
            
            <!-- Name des Frameworks (Wird bei Add-On-Installation und -Update angezeigt.) -->
            <xt:name>ediarum.MeineEdition.edit</xt:name>
            
            <!-- Beschreibung des Frameworks (= Changelog) als HTML. (Wird bei Add-On-Installation und -Update angezeigt.)-->
            <xt:description xmlns="http://www.w3.org/1999/xhtml">
                <html>
                    <head>
                        <!-- Titel des Frameworks -->
                        <title>ediarum.MeineEdition.edit</title>
                    </head>
                    <body>
                        <h1>Erweiterungsframework der digitalen Arbeitsumgebung "ediarum" für das Editionsvorhaben "MeineEdition" der ediarum.SETUP-Doku.</h1>
                        <p>Entwickelt von TELOTA - The Electronic Life of the Academy.</p>
                        <h2>Changelog</h2>
                        <h3>Version 1.5.2 vom 04.10.2023</h3>
                        <ul>
                            <li>HOTFIX: Hier steht die Beschreibung zum aktuellen Hotfix.</li>
                        </ul>
                        <h3>Version 1.5.1 vom 18.07.2023</h3>
                        <ul>
                            <li>Beschreibung eines neuen Features.</li>
                            <li>Anpassung am CSS für XY.</li>
                            <li>BUGFIX: ABC</li>
                            <li>BUGFIX: 123</li>
                        </ul>
                        
                        <!-- Hier folgen weitere Listeneinträge mit Informationen zu den vorherigen Versionen. -->
                    </body>
                </html>
            </xt:description>
            
            <!-- Angabe zur Lizenz des Frameworks. -->
            <xt:license>
                END USER LICENSE AGREEMENT 
                Die digitale Arbeitsumgebung steht ausschließlich fuer den Gebrauch im Rahmen der Arbeitsvorhaben der Berlin-Brandenburgischen Akademie der Wissenschaften zur Verfügung.
            </xt:license>
        </xt:extension>
    </xt:extensions>
    HINWEIS: Der Name der XML-Datei kann frei gewählt werden.
    HINWEIS: Sie können neben der update.xml auch eine weitere XML-Datei (z.B. test.xml) hinterlegen. Dies ermöglicht es Ihnen später, Probe-Updates durchzuführen, ohne dass der Produktivbetrieb davon gestört wird. (Siehe: Ein Add-On updaten)
  5. Speichern Sie die ZIP-Datei mit dem Framework und die update.xml an der gewünschten Stelle (z.B. auf einem Server oder in einem Netzlaufwerk).
Sie haben Ihr Framework zu einem Add-On verpackt und können dieses nun ausspielen.