Skip to Content

Wiki source code of Skins

Version 15.1 by Sorin Burjan on 2011/04/13
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 == How to create a new Skin ==
15
16 {{warning}}
17 To create a new Skin, you must have access to the server side of the XWiki Enterprise instance.
18 {{/warning}}
19
20 To create a new Skin, you have to create a new direcory inside the webapps/xwiki/skins folder and then add Velocity templates,CSS stylesheets, Javascript files and images inside it. For example, if you want to remove the logo from the header of the pages, follow these steps:
21
22 1. Inside the webapps/xwiki/skins folder, create a folder named myskin. Copy all files from webapps/xwiki/skins/colibri folder into your new skin directory.
23 1. Change the Skin at global or instance level and set it as myskin ( see [[this>>AdminGuide.Skins]] page for more informations about how to change the Skin )
24 1. Open any page in view mode and you will notice that myskin layout is the same as the colibri layout (if the skin changes to albatross means that your theme wasn't used. Check the names of your skin directory. Note that skin names are case-sensitive)
25 1. Change the global template:
26 1*. to remove the logo, modify the global.vm template under the new Skin and delete the line:(((
27 {{code language="html"}}
28 <img src="$!logourl" alt="Wiki Logo"/>
29 {{/code}}
30 )))
31 1. Save the template
32
33 Open any page in view mode and you will notice that the XWiki logo is not displayed anymore. Congratulations! You have created a new minimal XWiki Skin.
34
35 == How to override a Skin ==
36
37 {{warning}}
38 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.
39 {{/warning}}
40
41 An alternative for creating a new Skin is the possibility to override an existing Skin. The advantage of overriding an existing Skin is the fact that you don't need access to the server filesystem in order to modify the files used by the current Skin.
42 To override a Skin, you have to use the same document that is used to store the Skin.
43 {{id name="5a"/}}
44
45 === A. Creating a Skin document ===
46
47 {{warning}}
48 You need to have the **advanced edit mode** activated to access the object editor. Please refer to [[platform:Features.PageEditing]] for more information.
49 {{/warning}}
50
51 To create a new Skin document, follow these steps:
52
53 1. Create a new page. Name it MySkinPage(((
54 [[image:createSkinPage.png||style="border:1px solid black; width:650px"]]
55 )))
56 1. Edit the document's objects (Edit -> Objects)
57 1. Add an object of type XWiki.XWikiSkins to the document
58 1. Click on add
59 1. Set the base skin property to colibri. Now, you use colibri as a base skin. As you can see, no files were copied on the file system, but your skin uses colibri.(((
60 [[image:addSkinObject.png||style="border:1px solid black; width:650px"]]
61 )))
62 1. Save the document
63
64 === B. Working with the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) class ===
65
66 The base element in overriding a Skin is the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) class ( http://localhost:8080/xwiki/bin/view/XWiki/XWikiSkins ). In order to modify the templates or the files used by a Skin, you have to work with the properties of this class.
67 By default, the Skin class contains a set of properties that allows you to override some of the templates and files used by the Skin, and it also allows you to set the name of the logo displayed in the header of the interface.
68 To override other templates or files, you have to add new properties to the Skin class. For example, if you want to override (% class="sectionblockcodecolored" %)myfile.vm(%%) ( or myfile.css, or myfile.js ), follow these steps:
69
70 |(% style="width: 60%; color: rgb(34, 34, 34);" %)(((
71 1. go to the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) document
72 1. click on the (% class="sectionblockcodecolored" %)add or modify the class properties(%%) link
73 ( or follow this link: http://localhost:8080/xwiki/bin/edit/XWiki/XWikiSkins?editor=class )
74 1. from the **ADD PROPERTY** panel in the right, set the name of the property as being (% class="sectionblockcodecolored" %)myfile.vm(%%), choose the (% class="sectionblockcodecolored" %)TextArea(%%) type, and click on (% class="sectionblockcodecolored" %)Add
75 1. save the document
76 )))|(((
77 [[[[image:5.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:5.png]]
78 )))
79
80 {{id name="5c"/}}
81
82 === C. Using a Skin document ===
83
84 To use a Skin document, follow these steps:
85
86 1. go to the (% class="sectionblockcodecolored" %)Skin(%%) property from inside the (% class="sectionblockcodecolored" %)Administration(%%) interface
87 1. set the value of the property as being the full name of the Skin document
88 1. save the preferences
89
90 {{id name="5d"/}}
91
92 === D. Overriding the Skin components ===
93
94 Let's add a "HELLO," before the username on the top right menu, not by modifying the (% class="sectionblockcodecolored" %)global.vm(%%) template on the server, but overriding it inside the Skin document. Follow these steps:
95
96 ==== Method 1: By editing the XWiki.XWikiSkins properties on the Skin document ====
97
98 |(% style="width: 60%; color: rgb(34, 34, 34); overflow-x: auto;" %)(((
99 1. add a (% class="sectionblockcodecolored" %)TextArea(%%) property named (% class="sectionblockcodecolored" %)global.vm(%%) to the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) class
100 1. edit the Skin document's objects ( use the top-left menu: (% class="sectionblockcodecolored" %)EDIT -> OBJECTS(%%) ) and open the properties of the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) object
101 1. copy the original content of the (% class="sectionblockcodecolored" %)global.vm(%%) template and paste it in the property field named (% class="sectionblockcodecolored" %)global.vm(%%); if you don't have access to the server filesystem, open the template by following one of these links:
102 1*. http://localhost:8080/xwiki/skins/mybaseskin/global.vm ( where mybaseskin is the current Skin used in the Skin document ), or
103 1*. if the previous link is not valid, go to http://localhost:8080/xwiki/templates/global.vm
104 1. replace the following code:(((
105 {{code language="xml"}}
106 <a class="glink"
107 href="$!xwiki.getURL($context.user, 'view')"
108 id="headeruser">
109 $!xwiki.getUserName($context.user, false)
110 </a>
111 {{/code}}
112 )))with(((
113 {{code language="xml"}}
114 <a class="glink"
115 href="$!xwiki.getURL($context.user, 'view')"
116 id="headeruser">
117 HELLO,
118 $!xwiki.getUserName($context.user, false)
119 </a>
120 {{/code}}
121 )))
122 1. save the document
123 )))|(((
124 [[[[image:6.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:6.png]]
125 )))
126
127 ==== Method 2: By attaching files to the current Skin document ====
128
129 1. create a copy of the global.vm template; if you don't have access to the server filesystem, open the template by following one of these links:
130 1*. http://localhost:8080/xwiki/skins/mybaseskin/global.vm ( where mybaseskin is the current Skin used in the Skin document ), or
131 1*. if the previous link is not valid, go to http://localhost:8080/xwiki/templates/global.vm
132 1. replace the following code inside the copy of global.vm template:(((
133 {{code language="xml"}}
134 <a class="glink"
135 href="$!xwiki.getURL($context.user, 'view')"
136 id="headeruser">
137 $!xwiki.getUserName($context.user, false)
138 </a>
139 {{/code}}
140 )))with(((
141 {{code language="xml"}}
142 <a class="glink"
143 href="$!xwiki.getURL($context.user, 'view')"
144 id="headeruser">
145 HELLO,
146 $!xwiki.getUserName($context.user, false)
147 </a>
148 {{/code}}
149 )))
150 1. attach the copy of global.vm template to the current Skin document page
151
152 Now, open any document in view mode and you will notice the nice "HELLO," before your username.
153 Follow the same process in order to override (% class="sectionblockcodecolored" %)Javascript(%%) and (% class="sectionblockcodecolored" %){{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}}(%%) files ( http://localhost:8080/xwiki/skins/colibri/myfile.css ).
154
155 ==== 3. Overriding a skin resource ====
156
157 Just like templates, resource files such as images or css/js files can be overridden. To do that, the replacement must be attached to the Skin document, making sure it complies with the naming convention explained below. To find out the right name for your replacement resource, here is the trick:
158
159 1. find the path on the filesystem of the resource to replace (you can easily obtain that information using development tools such as [[Firebug>>http://getfirebug.com/]]); for instance, let's say this path is either
160 {{code}}/xwiki/resources/icons/silk/myicon.gif{{/code}}
161 for a resource found in the general resource directry, or
162 {{code}}/xwiki/skins/colibri/myimage.png{{/code}}
163 if the resource is specific to a certain skin, in this case 'colibri'.
164 1. strip from this path everything from the beginning until 'resources/' or the name of the skin, included; in the previous examples, you will obtain in the first case
165 {{code}}icons/silk/myicon.gif{{/code}}
166 and in the second case simply
167 {{code}}myimage.png{{/code}}
168 1. in this path, replace '/' with '.'; after this operation, we will get {{code}}icons.silk.myicon.gif{{/code}} for the first image example, while the second one remains unchanged. **This is the name of the file corresponding to the resource that you need to attach to the Skin document in order to make the replacement**.
169 1. create a file named as explained above and attach it to your Skin
170
171 {{info}}
172 **Technical note**: This trick works for any resource whose URL is generated in the skin by the {{code}}$xwiki.getSkinFile(){{/code}}, {{code}}$xwiki.jsfx(){{/code}} or {{code}}$xwiki.ssfx(){{/code}} methods, for instance like this:
173
174 {{code language="none"}}
175 .infomessage {
176 background-image: url("$xwiki.getSkinFile('icons/silk/information.gif')");
177 }
178 {{/code}}
179
180 In this case, {{code}}$xwiki.getSkinFile('icons/silk/information.gif'){{/code}} will first search for an image called 'icons.silk.information.gif' attached to the configured Skin document, if any. If that image exists, it will generate its URL. Otherwise, it will continue to search for 'icons/silk/information.gif' in the base skins and finally in the general 'resources/' directory.
181 {{/info}}
182
183
184 {{id name="5e"/}}
185
186 === E. Adding new components to the Skin ===
187
188 If you want to add new files to the skin, like (% class="sectionblockcodecolored" %){{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} (%%) or (% class="sectionblockcodecolored" %)Javascript(%%) files, you have two options:
189
190 * attach the files to the Skin document and reffer them by their URL, or
191 * add new properties to the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) object from inside the Skin document, and refer them by their name
192
193 For example, if you want to add a new {{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} file to the Skin, named (% class="sectionblockcodecolored" %)mynewfile.css(%%), follow one of these set of steps:
194
195 |(% style="width: 60%; color: rgb(34, 34, 34);" %)(((
196 1. attach the {{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} file to the Skin document
197 1. override the stylesheets.vm template ( check the section [[D>>#5d]] to learn how to override a Skin component ), and add the reference to your file in the template:(((
198 {{code language="xml"}}
199 <link rel="stylesheet"
200 type="text/css"
201 href="$xwiki.getSkinFile('mynewfile.css')"
202 />
203 {{/code}}
204 )))
205 1. save the document
206 )))|(((
207 [[[[image:7.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:7.png]]
208 )))
209
210 OR
211
212 |(% style="width: 60%; color: rgb(34, 34, 34);" %)(((
213 1. add a new property to the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%), name it (% class="sectionblockcodecolored" %)mynewfile.css(%%) ( check the section [[B>>#5b]] for more information about how to work with this class ), edit the Skin document's objects ( use the top-left menu: (% class="sectionblockcodecolored" %)EDIT -> OBJECTS(%%) ), and paste the {{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} code into the (% class="sectionblockcodecolored" %)mynewfile.css(%%) field
214 1. override the (% class="sectionblockcodecolored" %)style.css(%%) component ( see the section [[D>>#5d]] for more information about how to override a Skin compoment ) and add the following line to the content of the (% class="sectionblockcodecolored" %)style.css(%%) property:(((
215 {{code language="css"}}
216 @import "mynewfile.css";
217 {{/code}}
218 )))the important thing is to add a reference to the new component from a existing one; you must know most of the components content, so that you will take the best decision about which existing component will contain a reference to the new one
219 1. save the document
220 )))|(((
221 [[[[image:8.png||style="border: 3px solid rgb(221, 221, 221);" width="100%"]]>>attach:8.png]]
222 )))
223
224 Open any document in view mode and you will notice that the stylesheet is now applied.
225
226 {{id name="5f"/}}
227
228 === F. Using (% class="sectionblockcodecolored" %)images(%%) in a Skin document ===
229
230 {{id name="5f1"/}}
231
232 ==== 1. Changing the (% class="sectionblockcodecolored" %)logo(%%) ====
233
234 For example, if you want to add an image named (% class="sectionblockcodecolored" %)myimage.jpg(%%) as being the logo for the current Skin, follow these steps:
235
236 1. attach the image to the Skin document
237 1. edit the document's objects ( use the top-left menu: (% class="sectionblockcodecolored" %)EDIT -> OBJECTS(%%) )
238 1. use the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) object and set the (% class="sectionblockcodecolored" %)Logo(%%) property as being the name of the attached image: (% class="sectionblockcodecolored" %)myimage.jpg
239 1. save the document
240
241 Open any page in view mode and you will notice that the logo is now changed.
242
243 {{id name="5f2"/}}
244
245 ==== 2. Adding images to the Skin interface ====
246
247 To add images to the interface, attach them to the Skin document and use them in the {{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} code. For example, if you want to use (% class="sectionblockcodecolored" %)myimage.jpg(%%) as background image for the pages inside your XWiki Enterprise instance, follow these steps:
248
249 1. attach the image to the Skin document
250 1. choose one of these actions:
251 1*. add a new {{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} component to the Skin, name it (% class="sectionblockcodecolored" %)pagebackground.css(%%) and add a reference to it from the (% class="sectionblockcodecolored" %)style.css(%%) component ( see the section [[E>>#5e]] for more information about how to add new components to the Skin )
252 1*. override the (% class="sectionblockcodecolored" %)mybaseskin.css(%%) component ( where mybaseskin is the name of the current Skin - for example: (% class="sectionblockcodecolored" %)albatross.css(%%), (% class="sectionblockcodecolored" %)toucan.css(%%) or (% class="sectionblockcodecolored" %)colibri.css(%%) )
253 1. paste the following code inside the {{html}}<acronym title="Cascading Style Sheets">CSS</acronym>{{/html}} component:(((
254 {{code language="css"}}
255 body{
256 background-image: url($xwiki.getSkinFile("myimage.jpg"));
257 }
258 {{/code}}
259 )))
260
261 Open any page in view mode and you will notice that the the background of the page contains your image.
262 Have fun taking advantage of the power of XWiki Skins!
263
264 == More about XWiki Skins ==
265
266 In order to find more about XWiki Skins, check the [[Skins Tutorial>>AdminGuide.Skins]] from inside the Admin Guide and the [[Skins Tutorial>>Features.Skins]] from inside the User Guide
267
268 == Further reading ==
269
270 * the [[XWiki Data Model>>http://platform.xwiki.org/xwiki/bin/view/DevGuide/DataModel]]
271 * using the [[Skin Editor Application>>extensions:Extension.Skin Editor Application]]
272 * [[edit only one object>>http://dev.xwiki.org/xwiki/bin/view/Drafts/EditOneObject]]

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected