Changes for page Flavor API

Last modified by Admin on 2024/03/28 01:17

<
From version < 28.3 >
edited by Vincent Massol
on 2019/11/28 16:25
To version < 28.1 >
edited by Vincent Massol
on 2019/11/28 16:23
>
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Description
... ... @@ -2,17 +2,17 @@
2 2  
3 3  This system is mostly visible since XWiki 9.5 which strongly rely on it.
4 4  
5 -= Flavor picker =
5 +== Flavor picker ==
6 6  
7 7  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.
8 8  
9 9  {{image reference="flavor-picker.png" /}}
10 10  
11 -== Valid flavors
11 +=== Valid flavors
12 12  
13 13  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.
14 14  
15 -== Known flavors
15 +=== Known flavors
16 16  
17 17  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.
18 18  
... ... @@ -29,7 +29,7 @@
29 29   </properties>
30 30  {{/code}}
31 31  
32 -== Known invalid flavors
32 +=== Known invalid flavors
33 33  
34 34  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+).
35 35  
... ... @@ -45,7 +45,7 @@
45 45   </properties>
46 46  {{/code}}
47 47  
48 -= How to create a Flavor =
48 +== How to create a Flavor ==
49 49  
50 50  {{warning}}
51 51  This part is technical and designed for technical users.
... ... @@ -126,7 +126,7 @@
126 126  </project>
127 127  {{/code}}
128 128  
129 -== Testing ==
129 +=== Testing ===
130 130  
131 131  To test a flavor you're developing follow these steps:
132 132  * Build the flavor: ##mvn clean install##
... ... @@ -133,7 +133,7 @@
133 133  * Edit the ##META-INF/extension.xed## file inside the XWiki WAR you're testing with and add your flavor id and version to the list
134 134   of known flavors. Note that this is a hack since normally the canonical way would be to deploy the flavor in a
135 135   searchable XWiki Extensions Repository but that's a lot more complex and time-consuming.
136 - * Modify the ##<xwiki.extension.knownFlavors>## tag to add the flavor id and version. For example if you wish to test the ##org.xwiki.contrib:flavor-demo/1.1-SNAPSHOT## flavor:(((
136 + * Modify the `<xwiki.extension.knownFlavors>` tag to add the flavor id and version. For example if you wish to test the ##org.xwiki.contrib:flavor-demo/1.1-SNAPSHOT## flavor:(((
137 137  {{code language='xml'}}
138 138   <xwiki.extension.knownFlavors>
139 139   org.xwiki.platform:xwiki-platform-distribution-flavor-mainwiki/11.10,

Get Connected