Changes for page Flavor API
Summary
-
Objects (1 modified, 4 added, 0 removed)
Details
- ExtensionCode.ExtensionClass[0]
-
- Last version
-
... ... @@ -1,1 +1,1 @@ 1 -11. 91 +11.10 - Properties
-
... ... @@ -1,5 +1,5 @@ 1 -maven.groupid=org.xwiki.platform maven.artifactid=xwiki-platform-flavor-api maven.Model=org.xwiki.platform:xwiki-platform-flavor-api:jar:11. 9xwiki.extension.recommendedVersions.commons=org.xwiki.commons:.*/[11.9] xwiki.extension.recommendedVersions=org.xwiki.commons:.*/[11.9],2 - org.xwiki.rendering:.*/[11. 9],3 - org.xwiki.platform:.*/[11. 9] xwiki.extension.recommendedVersions.platform=org.xwiki.commons:.*/[11.9],4 - org.xwiki.rendering:.*/[11. 9],5 - org.xwiki.platform:.*/[11. 9]1 +maven.groupid=org.xwiki.platform maven.artifactid=xwiki-platform-flavor-api maven.Model=org.xwiki.platform:xwiki-platform-flavor-api:jar:11.10 xwiki.extension.recommendedVersions.commons=org.xwiki.commons:.*/[11.10] xwiki.extension.recommendedVersions=org.xwiki.commons:.*/[11.10], 2 + org.xwiki.rendering:.*/[11.10], 3 + org.xwiki.platform:.*/[11.10] xwiki.extension.recommendedVersions.platform=org.xwiki.commons:.*/[11.10], 4 + org.xwiki.rendering:.*/[11.10], 5 + org.xwiki.platform:.*/[11.10]
- ExtensionCode.ExtensionDependencyClass[296]
-
- Dependency version constraint
-
... ... @@ -1,0 +1,1 @@ 1 +11.10 - Extension version
-
... ... @@ -1,0 +1,1 @@ 1 +11.10 - Dependency id
-
... ... @@ -1,0 +1,1 @@ 1 +org.xwiki.commons:xwiki-commons-extension-api - Repositories
-
... ... @@ -1,0 +1,1 @@ 1 +maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
- ExtensionCode.ExtensionDependencyClass[297]
-
- Dependency version constraint
-
... ... @@ -1,0 +1,1 @@ 1 +11.10 - Extension version
-
... ... @@ -1,0 +1,1 @@ 1 +11.10 - Dependency id
-
... ... @@ -1,0 +1,1 @@ 1 +org.xwiki.platform:xwiki-platform-extension-script - Repositories
-
... ... @@ -1,0 +1,1 @@ 1 +maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
- ExtensionCode.ExtensionDependencyClass[298]
-
- Dependency version constraint
-
... ... @@ -1,0 +1,1 @@ 1 +11.10 - Extension version
-
... ... @@ -1,0 +1,1 @@ 1 +11.10 - Dependency id
-
... ... @@ -1,0 +1,1 @@ 1 +org.xwiki.platform:xwiki-platform-rest-api - Repositories
-
... ... @@ -1,0 +1,1 @@ 1 +maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
- ExtensionCode.ExtensionVersionClass[104]
-
- Download URL
-
... ... @@ -1,0 +1,1 @@ 1 +extension:org.xwiki.platform%3Axwiki-platform-flavor-api/11.10?rid=maven-xwiki - id
-
... ... @@ -1,0 +1,1 @@ 1 +org.xwiki.platform:xwiki-platform-flavor-api - Repositories
-
... ... @@ -1,0 +1,1 @@ 1 +maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public - Version
-
... ... @@ -1,0 +1,1 @@ 1 +11.10
 | API to get flavors from the repositories. |
| Type | JAR |
| Developed by | |
| Active Installs | 0 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
Table of contents
Description
XWiki offers different Flavors. A Flavor is a collection of applications. When you install a Flavor, you get a wiki fully configured for a use-case.
This system is mostly visible since XWiki 9.5 which strongly rely on it.
Flavor picker
In some places, you will see the Flavor picker, which is designed to make you chose a Flavor between the extensions available in your repositories. Since 8.1 flavors are also searched in local repository.
Valid flavors
Since 8.0 the Flavor picker won't display all flavors found on various repositories right away. Instead it starts a background job which validate each flavor and find the right version for your distribution. You will see a progress bar and the valid flavor will be automatically added once found.
Known flavors
Since 8.1 it's possible for a distribution to indicate known flavors, which means flavors id and version known to be valid with this distribution. Its usually flavors in sync with the distribution itself or well known like XWiki Flavor or XWiki Enterprise Flavors.
In a Maven project it must be indicated the pom.xml of the distribution package (or its parent) the following way:
org.xwiki.platform:xwiki-platform-distribution-flavor/${project.version},
org.xwiki.enterprise:xwiki-enterprise-ui-mainwiki/${project.version},
org.xwiki.enterprise:xwiki-enterprise-ui-wiki/${project.version}
Known invalid flavors
Since 9.5 it's possible for a distribution to indicate known invalid flavors, which means flavors id known to be invalid with this distribution (a good example is XWiki Enterprise which are invalid in 9.5+).
In a Maven project it must be indicated the pom.xml of the distribution package (or its parent) the following way:
org.xwiki.enterprise:xwiki-enterprise-ui-mainwiki,
org.xwiki.enterprise:xwiki-enterprise-ui-wiki
How to create a Flavor
Technically, a Flavor is nothing but a simple Extension with category flavor (as in
Usually it's a XAR (but it does not have to) with a few Flavor specific pages like the home page and dependencies on various applications.
Here is an example of a Flavor, built with Maven:
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-flavor-api 11.9):
Dependencies for this extension (org.xwiki.platform:xwiki-platform-flavor-api 11.10):
- org.xwiki.commons:xwiki-commons-extension-api 11.9
- org.xwiki.commons:xwiki-commons-extension-api 11.10
- org.xwiki.platform:xwiki-platform-extension-script 11.9
- org.xwiki.platform:xwiki-platform-extension-script 11.10
- org.xwiki.platform:xwiki-platform-rest-api 11.9
- org.xwiki.platform:xwiki-platform-rest-api 11.10
