Skip to content

Commit

Permalink
Added section on API compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
dtdesign committed Jan 17, 2018
1 parent dfc9422 commit e119d64
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions pages/package/package_package-xml.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ It provides the meta data (e.g. package name, description, author) and the instr
<version>1.0.0</version>
<date>2016-12-18</date>
</packageinformation>

<authorinformation>
<author>YOUR NAME</author>
<authorurl>http://www.example.com</authorurl>
</authorinformation>

<requiredpackages>
<requiredpackage minversion="3.0.0">com.woltlab.wcf</requiredpackage>
</requiredpackages>

<instructions type="install">
<instruction type="file" />
<instruction type="template">templates.tar</instruction>
Expand Down Expand Up @@ -154,6 +154,26 @@ Example:

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.

### `<compatibility>`

WoltLab Suite 3.1 introduced a new versioning system that focused around the API compatibility and is intended to replace the `<excludedpackage>` instruction for the Core for most plugins.

The `<compatibility>`-tag holds a list of compatible API versions, and while only a single version is available at the time of writing, future versions will add more versions with backwards-compatibility in mind.

Example:

```xml
<compatibility>
<api version="2018" />
</compatibility>
```

#### Existing API versions

| WoltLab Suite Core | API-Version | Backwards-Compatible to API-Version |
|---|---|---|
| 3.1 | 2018 | n/a |

### `<instructions>`

List of instructions to be executed upon install or update. The order is important, the topmost `<instruction>` will be executed first.
Expand Down

0 comments on commit e119d64

Please sign in to comment.