<
From version < 29.4 >
edited by Manuel Smeria
on 2012/12/14
To version < 29.7 >
edited by Sorin Burjan
on 2013/01/16
>
Change comment: removed Toucan refference

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ManuelSmeria
1 +XWiki.Sorin
Content
... ... @@ -3,7 +3,7 @@
3 3  {{/box}}
4 4  
5 5  A XWiki skin is used to customize the interface of a XWiki Enterprise instance.
6 -A Skin is composed of:
6 +A skin is composed of:
7 7  
8 8  * [[Velocity templates>>platform:DevGuide.Scripting#velocity]]
9 9  * [[CSS files (stylesheets)>>platform:AdminGuide.CSS files]]
... ... @@ -17,80 +17,76 @@
17 17  An XWiki Enterprise instance contains several skins by default, such as:
18 18  
19 19  * The [[Colibri skin>>extensions:Extension.Colibri Skin]]
20 -* The [[Albatross skin>>extensions:Extension.Albatross Skin]]
21 -* The [[Toucan skin>>extensions:Extension.Toucan Skin]]
20 +* The [[Toucan skin (deprecated and removed starting with 4.4-rc1)>>extensions:Extension.Toucan Skin]]
22 22  
23 -The full list of XWiki Skins that are included in your XWiki Enterprise instance can be found on the server filesystem, inside the webapps/xwiki/skins folder.
22 +The [[full list of XWiki skins>>Features.Skins]] that are included in your XWiki Enterprise instance can be found on the server filesystem, inside the ##webapps/xwiki/skins## folder.
24 24  
25 25  = The usage level for a XWiki Skin =
26 26  
27 27  A Skin can be used at different levels:
28 -* For the entire XWiki Enterprise instance. If no Skin is set at other levels, the pages will use the global instance Skin
29 -* For a space inside the XWiki Enterprise instance. It has a higher priority than the instance level Skin
30 -* For a specific user. It has a higher priority than the space level Skin. Click [[here>>#HChangingtheSkinforauser]] for more details
31 -* 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)
32 32  
28 +* For the entire XWiki Enterprise instance. If no skin is set at other levels, the pages will use the global instance skin.
29 +* For a space inside the XWiki Enterprise instance. It has a higher priority than the instance level skin.
30 +* For a specific user. It has a higher priority than the space level skin. For more details check [[this tutorial>>#HChangingtheSkinforauser]].
31 +* 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).
32 +
33 33  == Changing the Skin ==
34 34  
35 -{{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}}
35 +{{warning}}
36 +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.
37 +{{/warning}}
36 36  
37 -=== How to preview a Skin applied on a page ===
39 +=== How to preview a Skin applied on a page ===
38 38  
39 -To check how a page looks on changing the Skin, you can add a parameter named skin to the page URL. For example, to preview the wiki main page with the Toucan Skin, use the following URL: http://localhost:8080/xwiki/bin/view/Main/WebHome/?skin=toucan. 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.
41 +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 your newly created skin, use the following URL: http://localhost:8080/xwiki/bin/view/Main/WebHome/?skin=toucan. 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.
40 40  
41 41  === Changing the Skin at instance level ===
42 42  
43 -Each XWiki Enterprise 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:
45 +Each XWiki Enterprise 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:
44 44  
45 -* Go to Wiki Administration page
46 -* Click on **Presentation** on the left tab
47 -(((
47 +* Hover over "Wiki" and click on "Administer Wiki"
48 +* Click on the **Presentation** link(((
48 48  {{image reference="skin1.png"/}}
49 49  )))
50 -* Check the Skin property that stores the full name of the document
51 -* Click on the **Customize** button from the Skin section
52 -(((
51 +* Click on the **Customize** button from the skin section(((
53 53  [[image:skin2.png||style="border:1px solid silver; width:650px"]]
54 54  )))
55 -* Click on the **Edit this skin** button or edit the page in Object mode
56 -(((
54 +* Edit the page in Objects mode(((
57 57  [[image:skin3||style="border:1px solid silver; width:650px"]]
58 58  )))
59 -* You have multiple text areas where you can override the default behavior of your skin
57 +* You have multiple text areas where you can override the default behavior of your skin. Make your desired modifications.
60 60  * Click on **Save and View**
61 -* Your settings will be applied and the skin should change accordingly.
59 +* Your settings will be applied and the skin should change accordingly
62 62  
63 63  === Changing the Skin at space level ===
64 64  
65 -An XWiki space can have its own Skin. For example, if you want to set the Albatross Skin for the Main space you should follow these steps:
63 +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:
66 66  
67 -* Go on any page inside the Main space
68 -* From the top Space menu, click Administer space to open the Administration interface for the Main space
69 -* Click on **Presentation** on the left tab
70 -(((
65 +* Go to any page inside the Main space
66 +* From the top Space menu, click "Administer Space" to open the administration interface for the Main space
67 +* Click on the **Presentation** link(((
71 71  {{image reference="skin5.png"/}}
72 72  )))
73 -* For example, to use the Toucan Skin you can write "toucan" in the **Skin** field. If you have defined another Skin, you should fill in directory name which contains the skin. Note that the names are case-sensitive.
74 -* Click **Save**
75 -* If you open any page inside the Main space you will notice the layout difference.
70 +* If you have defined another skin, you should fill in the directory name which contains the skin.(((
71 +{{info}}
72 +The names of the skins are case-sensitive.
73 +{{/info}}
74 +)))
75 +* Click on **Save**
76 +* If you open any page inside the Main space you will notice the layout difference
76 76  
77 77  === Changing the Skin for a user ===
78 78  
79 -For example, if you want to use the Toucan Skin for a specific user, follow these steps:
80 +If you want to use your skin for a specific user follow these steps:
80 80  
81 81  * Go to the user's profile page
82 -* Edit the user's objects. Use the top-left menu: Edit -> Objects
83 -* Set the value of the skin(%%) property (under 'Objects of type XWiki.XWikiUsers') to toucan. You must use lowercase letters, remember that skin names are case-sensitive.
84 -(((
83 +* Edit the page in Objects mode
84 +* Set the value of the "skin" property (under //Objects of type XWiki.XWikiUsers//) to you custom skin (you must use lowercase letters)(((
85 85  [[image:skin6.png||style="border:1px solid silver; width:650px"]]
86 86  )))
87 87  * Click on **Save and View**
88 -* Now, all the pages inside the wiki will have the (% class="sectionblockcodecolored"%)toucan(%%) Skin applied for that user.
88 +* Now all the pages inside the wiki will use your new skin for that user
89 89  
90 90  = More about XWiki Skins =
91 91  
92 92  In order to find out more about the XWiki Skins, check the [[Skins Tutorial>>DevGuide.Skins]] in the Developer Guide and the [[Skins Tutorial>>Features.Skins]] in the User Guide.
93 -
94 -
95 -
96 -

Get Connected