SkinEditor Application

SkinEditor Application

The Skin Editor Application eases the development of XWiki Skins and Skin eXtensions. It embeds Mozilla's Bespin Editor to offer developers a new editing experience in the browser.

This application is licensed under the Mozilla Public License. Bespin's original code is the work of the Mozilla Labs Bespin Team

Features

Editing features

The Skin Editor provides edition of wiki skin and skin extensions files with Bespin's code editor. Syntax coloration is available for JavaScript and CSS files. Velocity templates will benefit from HTML coloration for the HTML bits of the templates. Bespin's default 3 themes are available : coffee, white and black. Three font sizes are available.

The list on the right displays all available files for the Skin or the Skin eXtension currently being edited. An option allows to hide files that are empty (which in general means that the skin uses instead the file with same name from the skin the edited skin inherits). Pseudo-locks allows you to know which files are currently being edited by other developers. The list of files and locks is updated automatically every 10 seconds while you are editing, so that you are informed of new locks, and of locks being released.

If you try to edit a locked file, as for regular wiki pages, a warning message will inform you the file is being locked, and will provide you a link to force the lock. Be aware then that when saving your changes you are potentially overwriting the other developer work.

Viewing features

In view mode, your skin or skin extension document will display a list of available files, and for each of them provide both a link to edit with the skin editor or a "zoom" link to view the source code for this file.

How to use

Download and import the application XAR in your wiki. Make sure the page XWiki.SkinEditor is saved with the programming right (If it's not, a warning message will inform you when you will try to use the skin editor.)

To make the skin editor available for a Skin or a Skin Extension document, simply write the following line as the content of this document :

#includeInContext("XWiki.SkinEditor")