Modernize package.xml
authorTim Düsterhus <duesterhus@woltlab.com>
Mon, 17 Jan 2022 12:24:19 +0000 (13:24 +0100)
committerTim Düsterhus <duesterhus@woltlab.com>
Mon, 17 Jan 2022 12:39:16 +0000 (13:39 +0100)
docs/package/package-xml.md
snippets/package/package.xml
snippets/tutorial/basic-app/package.xml

index d26557d8b86504f514d5115c52daec6f0c4f9a0f..c26811cb22711a2974f63329d11c8b7d49adf518 100644 (file)
@@ -95,7 +95,7 @@ A list of packages including their version required for this package to work.
 Example:
 
 ```xml
-<requiredpackage minversion="2.0.0" file="requirements/com.woltlab.wcf.tar">com.woltlab.wcf</requiredpackage>
+<requiredpackage minversion="2.7.5" file="requirements/com.example.foo.tar">com.example.foo</requiredpackage>
 ```
 
 The attribute `minversion` must be a valid version number as described in [`<version>`](#version).
@@ -110,7 +110,7 @@ A list of optional packages which can be selected by the user at the very end of
 Example:
 
 ```xml
-<optionalpackage file="optionals/com.woltlab.wcf.moderatedUserGroup.tar">com.woltlab.wcf.moderatedUserGroup</optionalpackage>
+<optionalpackage file="optionals/com.example.bar.tar">com.example.bar</optionalpackage>
 ```
 
 The `file` attribute specifies the location of the optional package's archive relative to the `package.xml`.
@@ -124,10 +124,10 @@ List of packages which conflict with this package. It is not possible to install
 Example:
 
 ```xml
-<excludedpackage version="3.1.0 Alpha 1">com.woltlab.wcf</excludedpackage>
+<excludedpackage version="6.0.0 Alpha 1">com.woltlab.wcf</excludedpackage>
 ```
 
-The attribute `version` must be a valid version number as described in the [\<version\>](#version) section. In the example above it will be impossible to install this package in WoltLab Suite Core 3.1.0 Alpha 1 or higher.
+The attribute `version` must be a valid version number as described in the [\<version\>](#version) section. In the example above it will be impossible to install this package in WoltLab Suite Core 6.0.0 Alpha 1 or higher.
 
 ### `<compatibility>`
 !!! info "Available since WoltLab Suite 3.1"
index 992231d2e59a878f03f5cbb186284a5d741ca6af..428db0381bff257a900131189c45a4be54ebfca7 100644 (file)
@@ -4,7 +4,7 @@
                <packagename>Simple Package</packagename>
                <packagedescription>A simple package to demonstrate the package system of WoltLab Suite Core</packagedescription>
                <version>1.0.0</version>
-               <date>2016-12-18</date>
+               <date>2022-01-17</date>
        </packageinformation>
 
        <authorinformation>
@@ -13,7 +13,7 @@
        </authorinformation>
 
        <requiredpackages>
-               <requiredpackage minversion="3.0.0">com.woltlab.wcf</requiredpackage>
+               <requiredpackage minversion="5.4.10">com.woltlab.wcf</requiredpackage>
        </requiredpackages>
 
        <excludedpackages>
@@ -24,4 +24,4 @@
                <instruction type="file" />
                <instruction type="template">templates.tar</instruction>
        </instructions>
-</package>
\ No newline at end of file
+</package>
index b4754e6d1be8dc536e636ea2caadd97493097736..b48422868f5a03dfd3359b467714979301470a90 100644 (file)
@@ -4,8 +4,8 @@
                <packagename>Example App</packagename>
                <packagedescription>A very basic example of an app.</packagedescription>
                <isapplication>1</isapplication>
-               <version>3.1.0</version>
-               <date>2018-03-29</date>
+               <version>5.4.0</version>
+               <date>2022-01-17</date>
        </packageinformation>
        
        <authorinformation>
        </authorinformation>
        
        <requiredpackages>
-               <requiredpackage minversion="3.1.0">com.woltlab.wcf</requiredpackage>
+               <requiredpackage minversion="5.4.10">com.woltlab.wcf</requiredpackage>
        </requiredpackages>
        
-       <compatibility>
-               <api version="2018" />
-       </compatibility>
+       <excludedpackages>
+               <excludedpackage version="6.0.0 Alpha 1">com.woltlab.wcf</excludedpackage>
+       </excludedpackages>
        
        <instructions type="install">
                <instruction type="file" />