Show last authors
1 {{velocity}}
2 $xwiki.ssx.use($doc.fullName)
3 {{/velocity}}
4
5 (% class="floatinginfobox" %)
6 (((
7 **Contents**
8
9 {{toc depth="3" start="2"/}}
10 )))
11
12 = XWiki Skins =
13
14 {{id name="s1"/}}
15 == What is a XWiki Skin used for? ==
16
17 A XWiki Skin is used to customize the interface of a XWiki Enterprise instance.
18
19 {{id name="s2"/}}
20 == What are the components that define a XWiki Skin? ==
21
22 A XWiki Skin is composed of:
23
24 * (% class="sectionblockcodecolored" %)[[Velocity templates>>platform:DevGuide.Scripting#velocity]]
25 * (% class="sectionblockcodecolored" %)[[{{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} stylesheets>>platform:AdminGuide.CSS files]]
26 * (% class="sectionblockcodecolored" %)[[Javascript files>>platform:DevGuide.JavaScriptAPI]](%%) and
27 * (% class="sectionblockcodecolored" %)Images
28
29 All these components are stored on the server that hosts the XWiki Enterprise instance, inside the (% class="sectionblockcodecolored directory" %)webapps/xwiki(%%) folder.
30
31 {{id name="s3"/}}
32 == How to change the Skin ==
33
34 {{id name="3a"/}}
35 === A. The default XWiki Skins ===
36
37
38 A XWiki Enterprise instance contains by default a [[list of Skins>>code:Skins.WebHome]] like:
39
40 * the (% class="sectionblockcodecolored" %)[[albatross>>code:Skins.AlbatrossSkin]](%%) Skin
41 * the (% class="sectionblockcodecolored" %)[[toucan>>code:Skins.ToucanSkin]](%%) Skin
42 * the (% class="sectionblockcodecolored" %)[[colibri>>code:Skins.ColibriSkin]](%%) Skin and
43 * other skins ( the full list of XWiki Skins that are included in your XWiki Enterprise instance can be found on the server filesystem, inside the (% class="sectionblockcodecolored directory" %)webapps/xwiki/skins(%%) folder )
44
45 {{id name="3b"/}}
46 === B. The usage level for a XWiki Skin ===
47
48 A Skin can be used at different levels:
49 * for the entire XWiki Enterprise (% class="sectionblockcodecolored" %)instance(%%) ( if there is no Skin set other levels, the pages will use the global (% class="sectionblockcodecolored" %)instance(%%) Skin )
50 * for a (% class="sectionblockcodecolored" %)space(%%) inside the XWiki Enterprise instance ( it has a higher priority then the (% class="sectionblockcodecolored" %)instance(%%) level Skin )
51 * for a specific (% class="sectionblockcodecolored" %)user(%%) (it has a higher priority then the (% class="sectionblockcodecolored" %)space(%%) level Skin) and
52 * for other (% class="sectionblockcodecolored" %)custom(%%) levels that can be created by modifying the Velocity templates from inside the Skin ( for example, a Skin can be set for a specific page, for a specific group of users and so on )
53
54 {{id name="3c"/}}
55 ===C. Changing the Skin===
56 {{warning}}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.{{/warning}}
57
58 {{id name="3c1"/}}
59 ====1. How to preview a Skin applied on a page====
60 To check how a page looks on changing the Skin, you can add a parameter named (% class="sectionblockcodecolored" %)skin(%%) to the page URL. For example, to preview the wiki main page on using the (% class="sectionblockcodecolored" %)toucan(%%) Skin, use the following URL: http://localhost:8080/xwiki/bin/view/Main/WebHome/?skin=toucan . If you want to preview the page on using a Skin document named (% class="sectionblockcodecolored" %)MySpace.MySkinDoc(%%), use the following URL: http://localhost:8080/xwiki/bin/view/Main/WebHome/?skin=MySpace.MySkinDoc .
61
62 {{id name="3c2"/}}
63 ====2. Changing the Skin at (% class="sectionblockcodecolored" %)instance(%%) level====
64 Each XWiki Enterprise instance contains a document ( (% class="sectionblockcodecolored" %)Skin Document(%%) ) that stores the Skin for the instance. To find out which document is used to store the current Skin, the user has to follow these steps:
65
66 |(% style="width: 60%; color: rgb(34, 34, 34);" %)(((
67 1. go into the (% class="sectionblockcodecolored" %)Administration(%%) interface
68 1. go into the (% class="sectionblockcodecolored" %)Presentation(%%) section
69 1. check the (% class="sectionblockcodecolored" %)Skin(%%) property that stores the full name of the document
70 )))|(((
71 [[[[image:1.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:1.png]]
72 )))
73
74 {{id name="3c2steps"/}}
75 To change the current Skin, follow these steps:
76
77 |(% style="width: 60%; color: rgb(34, 34, 34);" %)(((
78
79
80 1. click on the (% class="sectionblockcodecolored" %)CUSTOMIZE(%%) button right beside the (% class="sectionblockcodecolored" %)Skin(%%) property, to open the document
81 1. click on the (% class="sectionblockcodecolored" %)Edit this skin(%%) button to edit the document, or go to the top menu and select (% class="sectionblockcodecolored" %)EDIT -> OBJECTS
82 1. change the (% class="sectionblockcodecolored" %)Skin(%%) property ( the property is set to (% class="sectionblockcodecolored" %)colibri(%%) by default ) with the name of another Skin ( for example, (% class="sectionblockcodecolored" %)albatross(%%) )
83 1. save the document
84 )))|(((
85 [[[[image:2.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:2.png]]
86 )))
87
88 You can now open any page inside the wiki instance and you will notice the layout difference.
89
90 {{id name="3c3"/}}
91 ====3. Changing the Skin at (% class="sectionblockcodecolored" %)space(%%) level====
92 A XWiki space can use it's own Skin. For example, if you want to set as Skin for the space (% class="sectionblockcodecolored" %)Main(%%) as being the (% class="sectionblockcodecolored" %)albatross(%%) Skin, follow these steps:
93
94 |(% style="width: 60%; color: rgb(34, 34, 34);" %)(((
95 1. go on any page inside the (% class="sectionblockcodecolored" %)Main(%%) space ( for example, go on the home page: http://localhost:8080/xwiki/bin/view/Main/ )
96 1. from the top right menu, choose (% class="sectionblockcodecolored" %)Administration -> Administer space: Main(%%) to open the (% class="sectionblockcodecolored" %)Administration(%%) interface for the space (% class="sectionblockcodecolored" %)Main
97 1. go into the (% class="sectionblockcodecolored" %)Presentation(%%) section
98 1. follow the steps 4, 5, 6 and 7 from inside the section [[C-2>>#3c2]]
99 )))|(((
100 [[[[image:3.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:3.png]]
101 )))
102
103 You can now open any page inside the (% class="sectionblockcodecolored" %)Main(%%) space and you will notice the layout difference.
104
105 {{id name="3d"/}}
106
107 == More about XWiki Skins ==
108
109 In order to find more about XWiki Skins, check the [[Skins Tutorial>>DevGuide.Skins]] from inside the Developer Guide and the [[Skins Tutorial>>Features.Skins]] from inside the User Guide
110
111
112

Get Connected