Hide last authors
Manuel Smeria 29.4 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
Sorin Burjan 25.11 2 {{toc/}}
Manuel Smeria 29.4 3 {{/box}}
Vincent Massol 6.2 4
Ecaterina Moraru (Valica) 37.1 5 A XWiki skin is used to customize the interface of a XWiki instance.
Manuel Smeria 29.5 6 A skin is composed of:
Sorin Burjan 25.3 7
Sorin Burjan 25.2 8 * [[Velocity templates>>platform:DevGuide.Scripting#velocity]]
Ecaterina Moraru (Valica) 38.1 9 * [[CSS files (stylesheets)>>Documentation.DevGuide.Tutorials.Skins.CSS files]]
Sorin Burjan 25.2 10 * [[Javascript files>>platform:DevGuide.JavaScriptAPI]]
11 * Images
Gilles Sérasset 21.2 12
Ecaterina Moraru (Valica) 37.1 13 All these components are stored on the server that hosts the XWiki instance, inside the ##webapps/xwiki/## folder. Each XWiki skin has its own directory.
Manuel Smeria 29.4 14
Sorin Burjan 25.12 15 = The default XWiki Skins =
Gilles Sérasset 21.2 16
Ecaterina Moraru (Valica) 37.1 17 An XWiki instance contains several skins by default, such as:
Manuel Smeria 29.4 18
Guillaume Delhumeau 30.1 19 * The [[Flamingo Skin>>extensions:Extension.Flamingo Skin]]
20 * The [[Colibri skin (deprecated starting 6.2-m2)>>extensions:Extension.Colibri Skin]]
Sorin Burjan 29.7 21 * The [[Toucan skin (deprecated and removed starting with 4.4-rc1)>>extensions:Extension.Toucan Skin]]
Manuel Smeria 29.4 22
Vincent Massol 37.3 23 The [[full list of XWiki skins>>platform:Features.Skins]] that are included in your XWiki instance can be found on the server filesystem, inside the ##webapps/xwiki/skins## folder.
Vincent Massol 1.37 24
Sorin Burjan 25.12 25 = The usage level for a XWiki Skin =
Gilles Sérasset 21.2 26
Gilles Sérasset 21.3 27 A Skin can be used at different levels:
28
Ecaterina Moraru (Valica) 37.1 29 * For the entire XWiki instance. If no skin is set at other levels, the pages will use the global instance skin.
30 * For a space inside the XWiki instance. It has a higher priority than the instance level skin.
Ecaterina Moraru (Valica) 38.1 31 * For a specific user. It has a higher priority than the space level skin. For more details check [[this tutorial>>Documentation.AdminGuide.Skins||anchor="HChangingtheSkinforauser"]].
Manuel Smeria 29.5 32 * For other custom levels that can be created by modifying the Velocity templates inside the skin (for example, a skin can be set for a specific page, for a specific group of users and so on).
33
Silvia Macovei 26.2 34 == Changing the Skin ==
Sorin Burjan 25.12 35
Manuel Smeria 29.5 36 {{warning}}
37 To change the Skin, the user must have administrating rights. In the case that you have these rights, make sure that you switch to the Advanced mode in your profile, to enable the advanced options on the top main menu.
38 {{/warning}}
Gilles Sérasset 21.3 39
Manuel Smeria 29.5 40 === How to preview a Skin applied on a page ===
Gilles Sérasset 21.2 41
Buzila Vlad 36.1 42 To check how a page looks when changing the skin, you can add a parameter named skin to the page URL. For example, to preview the wiki main page with colibri skin, use the following URL: http://localhost:8080/xwiki/bin/view/Main/WebHome/?skin=colibri. If you want to preview the page using a skin document named MySpace.MySkinDoc, use the following URL: http://localhost:8080/xwiki/bin/view/Main/WebHome/?skin=MySpace.MySkinDoc.
Sorin Burjan 25.3 43
Silvia Macovei 26.2 44 === Changing the Skin at instance level ===
Sorin Burjan 25.3 45
Ecaterina Moraru (Valica) 37.1 46 Each XWiki instance contains a //skin document// that stores the skin for the instance. In order to find out which document is used to store the current skin, the user has to follow these steps:
Sorin Burjan 25.3 47
Manuel Smeria 29.5 48 * Hover over "Wiki" and click on "Administer Wiki"
Sorin Burjan 29.7 49 * Click on the **Presentation** link(((
Silvia Macovei 29.3 50 {{image reference="skin1.png"/}}
Sorin Burjan 25.7 51 )))
Sorin Burjan 29.7 52 * Click on the **Customize** button from the skin section(((
Silvia Macovei 29.2 53 [[image:skin2.png||style="border:1px solid silver; width:650px"]]
Sorin Burjan 25.7 54 )))
Sorin Burjan 29.7 55 * Edit the page in Objects mode(((
Silvia Macovei 29.2 56 [[image:skin3||style="border:1px solid silver; width:650px"]]
Sorin Burjan 25.7 57 )))
Manuel Smeria 29.5 58 * You have multiple text areas where you can override the default behavior of your skin. Make your desired modifications.
Sorin Burjan 25.5 59 * Click on **Save and View**
Manuel Smeria 29.5 60 * Your settings will be applied and the skin should change accordingly
Sorin Burjan 25.4 61
Silvia Macovei 26.2 62 === Changing the Skin at space level ===
Sorin Burjan 25.3 63
Sorin Burjan 29.7 64 A XWiki space can have its own skin. For example, if you want to set the your skin for the Main space you should follow these steps:
Gilles Sérasset 21.2 65
Manuel Smeria 29.5 66 * Go to any page inside the Main space
67 * From the top Space menu, click "Administer Space" to open the administration interface for the Main space
Sorin Burjan 29.7 68 * Click on the **Presentation** link(((
Silvia Macovei 29.3 69 {{image reference="skin5.png"/}}
Sorin Burjan 25.7 70 )))
Sorin Burjan 29.7 71 * If you have defined another skin, you should fill in the directory name which contains the skin.(((
Manuel Smeria 29.5 72 {{info}}
73 The names of the skins are case-sensitive.
74 {{/info}}
75 )))
76 * Click on **Save**
77 * If you open any page inside the Main space you will notice the layout difference
Gilles Sérasset 21.2 78
Silvia Macovei 26.2 79 === Changing the Skin for a user ===
Gilles Sérasset 21.2 80
Sorin Burjan 29.7 81 If you want to use your skin for a specific user follow these steps:
Sorin Burjan 25.9 82
83 * Go to the user's profile page
Manuel Smeria 29.5 84 * Edit the page in Objects mode
Sorin Burjan 29.7 85 * Set the value of the "skin" property (under //Objects of type XWiki.XWikiUsers//) to you custom skin (you must use lowercase letters)(((
Silvia Macovei 29.2 86 [[image:skin6.png||style="border:1px solid silver; width:650px"]]
Sorin Burjan 25.9 87 )))
88 * Click on **Save and View**
Sorin Burjan 29.7 89 * Now all the pages inside the wiki will use your new skin for that user
Sorin Burjan 25.9 90
Sorin Burjan 25.12 91 = More about XWiki Skins =
Gilles Sérasset 21.2 92
Vincent Massol 37.3 93 In order to find out more about the XWiki Skins, check the [[Skins Tutorial>>platform:DevGuide.Skins]] in the Developer Guide and the [[Skins Tutorial>>platform:Features.Skins]] in the User Guide.

Get Connected