Wiki source code of Flavors
Last modified by Eleni Cojocariu on 2026/11/13 12:35
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | A flavor is a set of [[Extensions>>doc:documentation.xs.user.extensions.WebHome]] chosen to work together, so that a freshly installed wiki is usable on the first page you open instead of being empty. Where an extension adds one capability, a flavor decides what kind of wiki you end up with. | ||
| 2 | |||
| 3 | You choose one when the wiki is first set up: the [[Distribution Wizard>>doc:documentation.xs.admin.distribution-wizard.WebHome]] lists the flavors it can reach and [[installs the one you pick>>doc:documentation.xs.admin.distribution-wizard.install-flavor.WebHome]]. A standard installation offers the [[XWiki Standard Flavor>>doc:extensions:Extension.XWiki Standard Flavor.WebHome]], the general-purpose flavor maintained by the XWiki Development Team; the [[Extensions catalogue>>doc:extensions:Main.WebHome]] lists the rest. | ||
| 4 | |||
| 5 | {{plantuml}} | ||
| 6 | @startuml | ||
| 7 | !theme bluegray | ||
| 8 | ' ---- XWiki accessible diagram palette (WCAG 2.1 AA): paste verbatim under | ||
| 9 | ' !theme bluegray. Canonical copy: xwiki-doc-writing/tools/ in xwiki-dev-llm. | ||
| 10 | skinparam activity { | ||
| 11 | BackgroundColor #0568AE | ||
| 12 | BorderColor #034873 | ||
| 13 | FontColor #FFFFFF | ||
| 14 | StartColor #04538B | ||
| 15 | EndColor #04538B | ||
| 16 | BarColor #5A5A5A | ||
| 17 | ' Diamonds are blue with white text, not light with dark text: a labelled | ||
| 18 | ' `repeat :x;` takes its fill from DiamondBackgroundColor but its font from | ||
| 19 | ' FontColor above, so a light fill draws that one box white on white, and no | ||
| 20 | ' selector reaches it without reaching the decision diamonds too. | ||
| 21 | DiamondBackgroundColor #0568AE | ||
| 22 | DiamondBorderColor #034873 | ||
| 23 | DiamondFontColor #FFFFFF | ||
| 24 | } | ||
| 25 | skinparam state { | ||
| 26 | BackgroundColor #0568AE | ||
| 27 | BorderColor #034873 | ||
| 28 | FontColor #FFFFFF | ||
| 29 | AttributeFontColor #FFFFFF | ||
| 30 | StartColor #04538B | ||
| 31 | EndColor #04538B | ||
| 32 | } | ||
| 33 | skinparam class { | ||
| 34 | BackgroundColor #0568AE | ||
| 35 | BorderColor #034873 | ||
| 36 | FontColor #FFFFFF | ||
| 37 | HeaderBackgroundColor #0568AE | ||
| 38 | AttributeFontColor #FFFFFF | ||
| 39 | StereotypeFontColor #262626 | ||
| 40 | } | ||
| 41 | skinparam object { | ||
| 42 | BackgroundColor #0568AE | ||
| 43 | BorderColor #034873 | ||
| 44 | FontColor #FFFFFF | ||
| 45 | AttributeFontColor #FFFFFF | ||
| 46 | StereotypeFontColor #262626 | ||
| 47 | } | ||
| 48 | skinparam participant { | ||
| 49 | BackgroundColor #0568AE | ||
| 50 | BorderColor #034873 | ||
| 51 | FontColor #FFFFFF | ||
| 52 | } | ||
| 53 | skinparam actor { | ||
| 54 | BackgroundColor #F5F5F5 | ||
| 55 | BorderColor #5A5A5A | ||
| 56 | FontColor #262626 | ||
| 57 | } | ||
| 58 | skinparam component { | ||
| 59 | BackgroundColor #0568AE | ||
| 60 | BorderColor #034873 | ||
| 61 | FontColor #FFFFFF | ||
| 62 | } | ||
| 63 | skinparam collections { | ||
| 64 | BackgroundColor #0568AE | ||
| 65 | BorderColor #034873 | ||
| 66 | FontColor #FFFFFF | ||
| 67 | } | ||
| 68 | skinparam queue { | ||
| 69 | BackgroundColor #0568AE | ||
| 70 | BorderColor #034873 | ||
| 71 | FontColor #FFFFFF | ||
| 72 | } | ||
| 73 | skinparam stack { | ||
| 74 | BackgroundColor #0568AE | ||
| 75 | BorderColor #034873 | ||
| 76 | FontColor #FFFFFF | ||
| 77 | } | ||
| 78 | ' database, control, entity, boundary and interface draw their label beside or | ||
| 79 | ' under the icon, on the page, in some diagram types: their text stays dark. | ||
| 80 | skinparam database { | ||
| 81 | BackgroundColor #F5F5F5 | ||
| 82 | BorderColor #5A5A5A | ||
| 83 | FontColor #262626 | ||
| 84 | } | ||
| 85 | skinparam control { | ||
| 86 | BackgroundColor #0568AE | ||
| 87 | BorderColor #034873 | ||
| 88 | FontColor #262626 | ||
| 89 | } | ||
| 90 | skinparam entity { | ||
| 91 | BackgroundColor #0568AE | ||
| 92 | BorderColor #034873 | ||
| 93 | FontColor #262626 | ||
| 94 | } | ||
| 95 | skinparam boundary { | ||
| 96 | BackgroundColor #0568AE | ||
| 97 | BorderColor #034873 | ||
| 98 | FontColor #262626 | ||
| 99 | } | ||
| 100 | skinparam usecase { | ||
| 101 | BackgroundColor #0568AE | ||
| 102 | BorderColor #034873 | ||
| 103 | FontColor #FFFFFF | ||
| 104 | StereotypeFontColor #FFFFFF | ||
| 105 | } | ||
| 106 | skinparam card { | ||
| 107 | BackgroundColor #04538B | ||
| 108 | BorderColor #034873 | ||
| 109 | FontColor #FFFFFF | ||
| 110 | } | ||
| 111 | skinparam note { | ||
| 112 | BackgroundColor #04538B | ||
| 113 | BorderColor #034873 | ||
| 114 | FontColor #FFFFFF | ||
| 115 | } | ||
| 116 | skinparam storage { | ||
| 117 | BackgroundColor #8A4A00 | ||
| 118 | BorderColor #8A4A00 | ||
| 119 | FontColor #FFFFFF | ||
| 120 | } | ||
| 121 | skinparam agent { | ||
| 122 | BackgroundColor #8A4A00 | ||
| 123 | BorderColor #8A4A00 | ||
| 124 | FontColor #FFFFFF | ||
| 125 | } | ||
| 126 | skinparam interface { | ||
| 127 | BackgroundColor #A62222 | ||
| 128 | BorderColor #A62222 | ||
| 129 | FontColor #262626 | ||
| 130 | } | ||
| 131 | skinparam node { | ||
| 132 | BackgroundColor #F5F5F5 | ||
| 133 | BorderColor #5A5A5A | ||
| 134 | FontColor #262626 | ||
| 135 | } | ||
| 136 | skinparam cloud { | ||
| 137 | BackgroundColor #F5F5F5 | ||
| 138 | BorderColor #5A5A5A | ||
| 139 | FontColor #262626 | ||
| 140 | } | ||
| 141 | skinparam artifact { | ||
| 142 | BackgroundColor #F5F5F5 | ||
| 143 | BorderColor #5A5A5A | ||
| 144 | FontColor #262626 | ||
| 145 | } | ||
| 146 | skinparam file { | ||
| 147 | BackgroundColor #F5F5F5 | ||
| 148 | BorderColor #5A5A5A | ||
| 149 | FontColor #262626 | ||
| 150 | } | ||
| 151 | skinparam rectangle { | ||
| 152 | BackgroundColor #FFFFFF | ||
| 153 | BorderColor #5A5A5A | ||
| 154 | FontColor #262626 | ||
| 155 | StereotypeFontColor #0568AE | ||
| 156 | } | ||
| 157 | skinparam folder { | ||
| 158 | BackgroundColor #F5F5F5 | ||
| 159 | BorderColor #8A4A00 | ||
| 160 | FontColor #8A4A00 | ||
| 161 | } | ||
| 162 | skinparam frame { | ||
| 163 | BackgroundColor #F5F5F5 | ||
| 164 | BorderColor #04538B | ||
| 165 | FontColor #04538B | ||
| 166 | } | ||
| 167 | skinparam package { | ||
| 168 | BackgroundColor #FFFFFF | ||
| 169 | BorderColor #0568AE | ||
| 170 | FontColor #262626 | ||
| 171 | } | ||
| 172 | skinparam partition { | ||
| 173 | BackgroundColor #FFFFFF | ||
| 174 | BorderColor #0568AE | ||
| 175 | FontColor #0568AE | ||
| 176 | } | ||
| 177 | skinparam swimlane { | ||
| 178 | BorderColor #0568AE | ||
| 179 | TitleBackgroundColor #F5F5F5 | ||
| 180 | TitleFontColor #0568AE | ||
| 181 | } | ||
| 182 | skinparam sequence { | ||
| 183 | BoxBackgroundColor #F5F5F5 | ||
| 184 | BoxBorderColor #5A5A5A | ||
| 185 | BoxFontColor #262626 | ||
| 186 | DelayFontColor #262626 | ||
| 187 | GroupBorderColor #5A5A5A | ||
| 188 | GroupFontColor #262626 | ||
| 189 | LifeLineBorderColor #5A5A5A | ||
| 190 | LifeLineBackgroundColor #F5F5F5 | ||
| 191 | TitleFontColor #0568AE | ||
| 192 | StartColor #0568AE | ||
| 193 | EndColor #0568AE | ||
| 194 | BorderColor #0568AE | ||
| 195 | } | ||
| 196 | skinparam arrow { | ||
| 197 | Color #0568AE | ||
| 198 | FontColor #262626 | ||
| 199 | } | ||
| 200 | skinparam legend { | ||
| 201 | BackgroundColor #F5F5F5 | ||
| 202 | BorderColor #5A5A5A | ||
| 203 | FontColor #262626 | ||
| 204 | } | ||
| 205 | skinparam stereotype { | ||
| 206 | CBackgroundColor #F5F5F5 | ||
| 207 | CBorderColor #5A5A5A | ||
| 208 | ABackgroundColor #F5F5F5 | ||
| 209 | ABorderColor #5A5A5A | ||
| 210 | IBackgroundColor #F5F5F5 | ||
| 211 | IBorderColor #5A5A5A | ||
| 212 | EBackgroundColor #F5F5F5 | ||
| 213 | EBorderColor #5A5A5A | ||
| 214 | NBackgroundColor #F5F5F5 | ||
| 215 | NBorderColor #5A5A5A | ||
| 216 | } | ||
| 217 | skinparam ArrowColor #0568AE | ||
| 218 | ' titleFontColor only: the nested `skinparam title { BackgroundColor }` form | ||
| 219 | ' leaks its background onto every element in the diagram. | ||
| 220 | skinparam titleFontColor #0568AE | ||
| 221 | skinparam titleBorderColor #5A5A5A | ||
| 222 | ' Links otherwise take bluegray's white root colour, unreadable on a light fill. | ||
| 223 | <style> | ||
| 224 | root { | ||
| 225 | HyperLinkColor #0568AE | ||
| 226 | } | ||
| 227 | element { | ||
| 228 | HyperLinkColor #FFFFFF | ||
| 229 | } | ||
| 230 | actor, artifact, boundary, cloud, control, database, entity, file, folder, frame, interface, | ||
| 231 | legend, node, package, rectangle { | ||
| 232 | HyperLinkColor #0568AE | ||
| 233 | } | ||
| 234 | </style> | ||
| 235 | ' ---- end XWiki accessible diagram palette ---- | ||
| 236 | skinparam componentStyle rectangle | ||
| 237 | |||
| 238 | component "**XWiki Standard Flavor**\nwhat a default\ninstallation gives you" as FL | ||
| 239 | |||
| 240 | component "App Within Minutes\nApplication" as A | ||
| 241 | component "Dashboard\nApplication" as B | ||
| 242 | component "Search\nApplication" as C | ||
| 243 | component "Office Importer\nApplication" as D | ||
| 244 | component "Help\nApplication" as E | ||
| 245 | component "Panels\nApplication" as G | ||
| 246 | component "Administration\nApplication" as H | ||
| 247 | component "...and the rest of\nthe standard set" as F | ||
| 248 | |||
| 249 | FL --> A | ||
| 250 | FL --> B | ||
| 251 | FL --> C | ||
| 252 | FL --> D | ||
| 253 | FL --> E | ||
| 254 | FL --> G | ||
| 255 | FL --> H | ||
| 256 | FL --> F | ||
| 257 | @enduml | ||
| 258 | {{/plantuml}} | ||
| 259 | |||
| 260 | A flavor is itself an extension, which is why it has a version of its own and why the wiki's content is [[upgraded as a flavor>>doc:documentation.xs.admin.upgrade.flavor.WebHome]] after the distribution has been upgraded. |