Umbraco XSLT Editor Manual

Prerequisites

The Xmbraco XSLT Editor (uxeditor) requires an V3 installation of Umbraco. This installation must have the Umbraco webservices installed and enabled and you must have access to the FileService webservice. Below is a snip from the umbracoSettings.config file:

<webservices enabled="True">
    <!-- You must set user-rights for each service. Enter the usernames seperated with comma (,) -->
    <documentServiceUsers>username</documentServiceUsers>
    <fileServiceUsers>username</fileServiceUsers>
    <fileServiceFolders>css,xslt,data</fileServiceFolders>
    <stylesheetServiceUsers>username</stylesheetServiceUsers>
    <memberServiceUsers>username</memberServiceUsers>
</webservices>


The important thing here is that <fileServiceUsers>username</fileServiceUsers> contains your username and that the <fileServiceFolders>css,xslt,data</fileServiceFolders> contains both the xslt and data folders.

The webservices must off course be enabled like this <webservices enabled="True">.

Installation

There are two possible ways to install the uxeditor. The first is using ClickOnce deployment and the second is using the regular installer. The advantage of using the ClickOnce deployment is that whenever the application your installation is automatically updated.

ClickOnce installation

The first step is to load the ClickOnce deployment site. If you are using firefox you need to download the firefox ClickOnce Add-on.

uxeditor_ClickOnce_Firefox.png

The press the install button to start the installation. If you are using firefox you will be prompted to download the uxeditor.application file. You need to choose the "Run ClickOnce application" as shown below:

uxeditor_ClickOnce_Firefox_Run.png

If you are using internet explorer it should work right away and show you this step:

uxeditor_ClickOnce_Firefox_Install.png

Now all you have to do is press the "Install" button and the application should install itself and open right away.

Regular installer installation

If you are having trouble using the ClickOnce installer you might want to try the other regular installer instead. The most recent version of this installer can always be downloaded from the release tab.

The first step is to unpack the .zip file containing the installer. Then you should run the setup.exe file from the location where you unpacked the installer.

Now just accept the default values in the installation wizard and start the application from your startmenu:

uxeditor_Regurlar_MenuItem.png

Connecting to the Umbraco instance

When the uxeditor first starts it shows the "Connect to Umbraco instance" dialog as shown below:

uxeditor_Connect.png

In this dialog you must enter your username, password and URL to the Umbraco FileService webservice.
Please make sure that the URL is correct or the connection dialog will reappear.

Working with the uxeditor

When the uxeditor has just been connected to an umbraco instance the editor looks something like this:

uxeditor_Connected.png

There are two groups of controls in the editor that are interresting. The toolbar controls and the tabs.

The toolbar has two dropdown lists. The first dropdown shows the all the XSLT files within the instance and the first available XSLT file is selected. The first dropdown determines which XSLT is loaded into the XSLT tab.

uxeditor_XsltDropDown.png

The second dropdown shows all the nodes from the Umbraco.config XML file (cache) in the Umbraco instance and the first node is selected.
The second dropdown determines which node in the Umbraco cache is selected as the $currentPage variable during transformation.

uxeditor_NodeDropDown.png

The toolbar also has a single button which actually performs the transformation of the Umbraco XML file with the XSLT in the XSLT tab.

There are three tabs in the editor; the XSLT, XML and Output tabs.

The XSLT tab displays the XML code for the XSLT file selected in the XSLT dropdown in the toolbar. This tab allows you to edit the XSLT file, thus allowing you to test/develop your XSLT against the umbraco cache.

uxeditor_XsltTab.png

The XML tab shows your working copy of the Umbraco XML file. This working copy is updated each time you connect to an Umbraco instance.
It is not possible to edit the working copy, however it is really nice to be able to view all the XML element/attribute names etc. If you need to refresh the working copy you can always use the File -> Connect menu to access the "Connect to Umbraco instance" dialog.

uxeditor_NodeTab.png

The Output tab shows the result of the XSLT transform and is displayed whenever you press the "Transform" button. This allows you to verify that your XSLT produces the correct output based on the your working copy of the Umbraco XML file and the selected currentPage node.

uxeditor_OutputTab.png

Last edited May 20, 2007 at 10:43 AM by edberg, version 8

Comments

enzo_dello Dec 31, 2008 at 9:11 AM 
Hi, will it work for umbraco 4 ?