Wiki source code of Skins
Version 30.2 by Vincent Massol on 2017/09/05
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="floatinginfobox" %) | ||
| 2 | ((( | ||
| 3 | **Contents** | ||
| 4 | |||
| 5 | {{toc depth="3" start="2"/}} | ||
| 6 | ))) | ||
| 7 | |||
| 8 | = XWiki Skins = | ||
| 9 | |||
| 10 | == How to create a new Skin == | ||
| 11 | |||
| 12 | {{warning}} | ||
| 13 | To create a new Skin, you must have access to the server side of the XWiki instance. | ||
| 14 | {{/warning}} | ||
| 15 | |||
| 16 | To create a new Skin, you have to create a new directory 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: | ||
| 17 | |||
| 18 | * 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. | ||
| 19 | * Change the Skin at global or instance level and set it as myskin ( see [[this>>platform:AdminGuide.Skins]] page for more informations about how to change the Skin ) | ||
| 20 | * 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) | ||
| 21 | * Change the global template:to remove the logo, modify the global.vm template under the new Skin and delete the line:((( | ||
| 22 | {{code language="html"}} | ||
| 23 | <img src="$!logourl" alt="Wiki Logo"/> | ||
| 24 | {{/code}} | ||
| 25 | ))) | ||
| 26 | * Save the template | ||
| 27 | |||
| 28 | 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. | ||
| 29 | |||
| 30 | === skin.properties === | ||
| 31 | |||
| 32 | {{info}}Since 6.4.{{/info}} Inside your new skin, you should have a file called ##skin.properties##. This file contains some properties about the skin and looks like this: | ||
| 33 | |||
| 34 | {{code language="cfg"}} | ||
| 35 | parent=... | ||
| 36 | outputSyntax=... | ||
| 37 | {{/code}} | ||
| 38 | |||
| 39 | |=Property|=Description | ||
| 40 | |##parent##|Indicate another skin to inherit from. If it is set to an empty value (##parent=##) the skin will directly inherit from the WAR. If it is not set at all it will inherit from whatever is configured in ##xwiki.cfg##'s ##xwiki.defaultbaseskin## property. | ||
| 41 | |##outputSyntax##|{{info}}Since 7.1M1.{{/info}} Indicate the output syntax the skin is using. XWiki will use the correct renderer to generate valid HTML code. If it is set to an empty value (##outputSyntax=##) or not set at all, this setting will be inherited from the parent skin. If there is no parent, the syntax used is XHTML1.0 (for compatibility with old skins that did not set this property). Supported values are ##html/5.0## and ##xhtml/1.0##. | ||
| 42 | |||
| 43 | == How to override a Skin == | ||
| 44 | |||
| 45 | {{warning}} | ||
| 46 | 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. | ||
| 47 | {{/warning}} | ||
| 48 | |||
| 49 | 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. | ||
| 50 | To override a Skin, you have to use the same document that is used to store the Skin.\\ | ||
| 51 | |||
| 52 | === A. Creating a Skin document === | ||
| 53 | |||
| 54 | {{warning}} | ||
| 55 | You need to have the **advanced edit mode** activated to access the object editor. Please refer to [[platform:Features.PageEditing]] for more information. | ||
| 56 | {{/warning}} | ||
| 57 | |||
| 58 | To create a new Skin document, follow these steps: | ||
| 59 | |||
| 60 | * Create a new page. Name it MySkinPage((( | ||
| 61 | [[image:createSkinPage.png||style="border: 1px solid black; width: 650px;"]] | ||
| 62 | ))) | ||
| 63 | * Edit the document's objects (Edit -> Objects) | ||
| 64 | * Add an object of type XWiki.XWikiSkins to the document | ||
| 65 | * Click on add | ||
| 66 | * Set the base skin property. The base skin property points to the skin you wish to override. You can use either the filesystem skin directory name (for a filesystem skin to override) or the page name where the skin is defined (for overriding a page-based skin). Set it to ##colibri## for using the ##colibri## skin as a base skin. As you can see, no files were copied on the file system, but your skin uses colibri.((( | ||
| 67 | [[image:addSkinObject.png||style="border: 1px solid black; width: 650px;"]] | ||
| 68 | ))) | ||
| 69 | * Save the document | ||
| 70 | |||
| 71 | === B. Working with the XWiki.XWikiSkins class === | ||
| 72 | |||
| 73 | {{warning}} | ||
| 74 | Since 7.0RC1, this mechanism is deprecated. You don't need to edit the XWiki.XWikiSkins class anymore. You should simply use the [[extensions:Extension.Skin Application]]). | ||
| 75 | {{/warning}} | ||
| 76 | |||
| 77 | The base element in overriding a Skin is the 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. 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. | ||
| 78 | To override other templates or files, you have to add new properties to the Skin class. For example, if you want to override myfile.vm ( or myfile.css, or myfile.js ), follow these steps: | ||
| 79 | |||
| 80 | |||
| 81 | * Go to the XWiki.XWikiSkins document | ||
| 82 | * Edit the document's class (Edit -> Class) or follow this link: http:~/~/localhost:8080/xwiki/bin/edit/XWiki/XWikiSkins?editor=class | ||
| 83 | * Add a new property myfile.vm as TextArea type | ||
| 84 | * Click on Add. The myfile.vm property should appear in the list((( | ||
| 85 | [[image:editXWikiSkins.png||style="border: 1px solid black; width: 650px;"]] | ||
| 86 | ))) | ||
| 87 | * Save the document | ||
| 88 | |||
| 89 | === C. Using a Skin document === | ||
| 90 | |||
| 91 | To use a Skin document, follow these steps: | ||
| 92 | |||
| 93 | * Go to the skin property from inside the Administrationpage, Presentation section | ||
| 94 | * Set the value of the files as being the full name of the Skin document. For our skin page created above, we will type Main.MySkinPage | ||
| 95 | * Save the preferences | ||
| 96 | |||
| 97 | === D. Overriding the Skin components === | ||
| 98 | |||
| 99 | Let's add a "Hello" before the username on the top right menu, not by modifying the menuview.vm template on the server, but overriding it inside the Skin document. Follow these steps: | ||
| 100 | |||
| 101 | ==== Method 1: By editing the XWiki.XWikiSkins properties on the Skin document ==== | ||
| 102 | |||
| 103 | {{warning}} | ||
| 104 | Since 7.0RC1, this method is deprecated. You don't need to edit the XWiki.XWikiSkins class anymore. You should simply use the [[extensions:Extension.Skin Application]]). | ||
| 105 | {{/warning}} | ||
| 106 | |||
| 107 | * Add a TextArea property named menuview.vm to the XWiki.XWikiSkins class((( | ||
| 108 | [[image:XWikiSkinsMenuView.png||style="border: 1px solid black; width: 650px;"]] | ||
| 109 | ))) | ||
| 110 | * Edit your skin document's objects (Edit -> Objects) and open the properties of the object | ||
| 111 | * Copy the original content of the menuview.vm template and paste it in the property field named menuview.vm. If you don't have access to the server filesystem, open the template by following http:~/~/localhost:8080/xwiki/templates/menuview.vm (to access a template from the skin, use http:~/~/localhost:8080/xwiki/skins/colibri/) | ||
| 112 | * Replace the following code:((( | ||
| 113 | {{code language="html"}} | ||
| 114 | #xwikitopmenuentrystart($xwiki.getURL($xcontext.user, 'view') "$msg.get('core.menu.type.profile')__SEPARATOR__$!xwiki.getUserName($xcontext.user, false)" 'tmUser' 'hasIcon') | ||
| 115 | {{/code}} | ||
| 116 | |||
| 117 | with | ||
| 118 | |||
| 119 | {{code language="html"}} #xwikitopmenuentrystart($xwiki.getURL($xcontext.user, 'view') "$msg.get('Hello')__SEPARATOR__$!xwiki.getUserName($xcontext.user, false)" 'tmUser' 'hasIcon'){{/code}} | ||
| 120 | [[image:MySkinPageWithMenuView.png||style="border: 1px solid black; width: 650px;"]] | ||
| 121 | ))) | ||
| 122 | * Save the document | ||
| 123 | |||
| 124 | ==== Method 2: By attaching files to the current Skin document ==== | ||
| 125 | |||
| 126 | * Create a file on your computer called menuview.vm. Copy the original content of the menuview.vm into your local file. If you don't have access to the server filesystem, open the template by following http:~/~/localhost:8080/xwiki/skins/colibri/menuview.vm | ||
| 127 | * Replace the following code:((( | ||
| 128 | {{code language="html"}} | ||
| 129 | #xwikitopmenuentrystart($xwiki.getURL($xcontext.user, 'view') "$msg.get('core.menu.type.profile')__SEPARATOR__$!xwiki.getUserName($xcontext.user, false)" 'tmUser' 'hasIcon') | ||
| 130 | {{/code}} | ||
| 131 | |||
| 132 | with | ||
| 133 | |||
| 134 | {{code language="html"}} | ||
| 135 | #xwikitopmenuentrystart($xwiki.getURL($xcontext.user, 'view') "$msg.get('Hello')__SEPARATOR__$!xwiki.getUserName($xcontext.user, false)" 'tmUser' 'hasIcon') | ||
| 136 | {{/code}} | ||
| 137 | ))) | ||
| 138 | * Attach the copy of menuview.vm template to the current Skin document page | ||
| 139 | |||
| 140 | Now, open any document in view mode and you will notice the nice "Hello" before your username. Follow the same process in order to override Javascript and CSS files ( http:~/~/localhost:8080/xwiki/skins/colibri/myfile.css ). | ||
| 141 | |||
| 142 | ==== 3. Overriding a skin resource ==== | ||
| 143 | |||
| 144 | 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 | ||
| 145 | |||
| 146 | * 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 | ||
| 147 | |||
| 148 | {{code}}/xwiki/resources/icons/silk/myicon.gif{{/code}} | ||
| 149 | for a resource found in the general resource directry, or | ||
| 150 | {{code}}/xwiki/skins/colibri/myimage.png{{/code}} | ||
| 151 | if the resource is specific to a certain skin, in this case 'colibri'. | ||
| 152 | |||
| 153 | * 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{{code}}icons/silk/myicon.gif{{/code}} | ||
| 154 | and in the second case simply | ||
| 155 | {{code}}myimage.png{{/code}} | ||
| 156 | * 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**. | ||
| 157 | * Create a file named as explained above and attach it to your Skin | ||
| 158 | |||
| 159 | {{info}} | ||
| 160 | **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: | ||
| 161 | |||
| 162 | {{code language="none"}} | ||
| 163 | .infomessage { | ||
| 164 | background-image: url("$xwiki.getSkinFile('icons/silk/information.gif')"); | ||
| 165 | } | ||
| 166 | {{/code}} | ||
| 167 | |||
| 168 | 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. | ||
| 169 | {{/info}} | ||
| 170 | |||
| 171 | === E. Adding new components to the Skin === | ||
| 172 | |||
| 173 | If you want to add new files to the skin, like CSS or Javascript files, you have two options: | ||
| 174 | |||
| 175 | * attach the files to the Skin document and reffer them by their URL, or | ||
| 176 | * add new properties to the (% class="sectionblockcodecolored" %)XWiki.XWikiSkins(%%) object from inside the Skin document, and refer them by their name | ||
| 177 | |||
| 178 | 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: | ||
| 179 | |||
| 180 | |||
| 181 | * Attach the CSS file to the Skin document | ||
| 182 | * Override the stylesheets.vm template and add the reference to your file in the template:((( | ||
| 183 | {{code language="html"}} | ||
| 184 | <link rel="stylesheet" | ||
| 185 | type="text/css" | ||
| 186 | href="$xwiki.getSkinFile('mynewfile.css')" | ||
| 187 | /> | ||
| 188 | {{/code}} | ||
| 189 | ))) | ||
| 190 | * Save the document | ||
| 191 | |||
| 192 | ((( | ||
| 193 | OR | ||
| 194 | ))) | ||
| 195 | |||
| 196 | ((( | ||
| 197 | * Add a new property to the XWiki.XWikiSkins, name it mynewfile.css, edit the Skin document's objects ( Edit -> Objects ), and paste the CSS code into the mynewfile.css field | ||
| 198 | * Override the Style component and add the following line to the content of the Style property:((( | ||
| 199 | {{code language="css"}} | ||
| 200 | @import "mynewfile.css"; | ||
| 201 | {{/code}} | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | 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 . | ||
| 206 | |||
| 207 | [[image:importCSS.png||style="border: 1px solid black; width: 650px;"]] | ||
| 208 | ))) | ||
| 209 | |||
| 210 | * Save the document | ||
| 211 | |||
| 212 | Open any document in view mode and you will notice that the stylesheet is now applied. | ||
| 213 | |||
| 214 | |||
| 215 | === F. Using images in a Skin document === | ||
| 216 | |||
| 217 | ==== 1. Changing the logo ==== | ||
| 218 | |||
| 219 | For example, if you want to add an image named myimage.jpg as being the logo for the current Skin, follow these steps: | ||
| 220 | |||
| 221 | * Attach the image to the Skin document | ||
| 222 | * Edit the document's objects | ||
| 223 | * Use the XWiki.XWikiSkins object and set the Logo property as being the name of the attached image myimage.jpg | ||
| 224 | * Save the document | ||
| 225 | |||
| 226 | Open any page in view mode and you will notice that the logo is now changed. | ||
| 227 | |||
| 228 | |||
| 229 | ==== 2. Adding images to the Skin interface ==== | ||
| 230 | |||
| 231 | To add images to the interface, attach them to the Skin document and use them in the CSS code. For example, if you want to use myimage.jpg as background image for the pages inside your XWiki instance, follow these steps: | ||
| 232 | |||
| 233 | * Attach the image to the Skin document | ||
| 234 | * Choose one of these actions: | ||
| 235 | ** Add a new CSS component to the Skin, name it pagebackground.css and add a reference to it from the style.css component | ||
| 236 | ** Override the mybaseskin.css component (where mybaseskin is the name of the current Skin - for example: albatross.css, toucan.css or colibri.css) | ||
| 237 | * Paste the following code inside the CSS component:((( | ||
| 238 | {{code language="css"}} | ||
| 239 | body{ | ||
| 240 | background-image: url($xwiki.getSkinFile("myimage.jpg")); | ||
| 241 | } | ||
| 242 | {{/code}} | ||
| 243 | ))) | ||
| 244 | |||
| 245 | Open any page in view mode and you will notice that the the background of the page contains your image. Have fun taking advantage of the power of XWiki Skins! | ||
| 246 | |||
| 247 | == More about XWiki Skins == | ||
| 248 | |||
| 249 | In order to find more about XWiki Skins, check the [[Skins Tutorial>>platform:AdminGuide.Skins]] from inside the Admin Guide and the [[Skins Tutorial>>platform:Features.Skins]] from inside the User Guide | ||
| 250 | |||
| 251 | == Further reading == | ||
| 252 | |||
| 253 | * the [[XWiki Data Model>>platform:DevGuide.DataModel]] | ||
| 254 | * using the [[Skin Editor Application>>extensions:Extension.Skin Editor Application]] | ||
| 255 | * [[edit only one object>>dev:Drafts.EditOneObject]] | ||
| 256 | ))) |
