Ben's Blog » Web Applications

Web Studio, Web Editor and the Web Editor Framework

admin — Thu, 10 Jun 2010 09:23:25 +0000

I have been receiving a steady stream of questions around Web Studio and enquiries around our strategy for future releases with regards to similar functionality, so thought it would be helpful to discuss the product focus.

Firstly to clarify, Web Studio is no longer part of the Community Alfresco product so is no longer available for download. Web Studio was not part of an Enterprise release and was therefore not supported as part of the core product by Alfresco. The Surf framework that Web Studio utilised has been committed to Spring Source. The Surf framework is the underlying framework for Alfresco Share and Alfresco will continue to invest in Surf and surrounding developer tools.

With 3.3 Alfresco started to heavily invest in WCM utilising the core Alfresco repository (non AVM). As part of this strategy we introduced the Web Editor (in-context editing) and Web Editor Framework (WEF). The Web Editor Framework provides a standard plug-in framework that people can develop any type of functionality on. The framework can be loosely considered to be a ribbon toolbar that can be customised e.g. adding custom tabs, buttons and any other UI required. Most importantly it is a common framework that Alfresco, the Alfresco community, partners, customers, the Spring community and anyone else can develop on. A lot of effort has gone into the way that toolbars, buttons and components in general can be packaged into a single file, allowing for new plug-in’s to easily be “dropped in” to a WEF environment.

The Web Editor was Alfresco’s first core product (documented, supported) feature that was built utilising the Web Editor Framework i.e. the Web Editor has a dependency upon the WEF. The Web Editor addresses a single specific use case which is to edit content (semantic page content) in the context of the web site. In context editing. This functionality is something we are now looking to build on in future releases, expanding this functionality above and beyond simple editing. The Web Editor focus however of the next release (internally named “Swift”) is still on the content editorial process for the Web Editor.

There is also a great deal of interest in what I will term “presentation management”, and this is where Web Studio really sparked peoples thoughts around Alfresco WCM. By this I mean providing the ability for a site administrator to manage sites, site structures, templates, components, navigation etc. In order to provide these features in a consistent, supportable manner, an underlying model is required within the repository which can then be utilised by a delivery framework. As the WCM functionality moves forward, we will start to implement such a model, and utilise Spring Surf and the WEF to deliver the presentation management functionality. The Swift release remains focused on web content production, so no presentation management capabilities are in scope for this release, however the building blocks around the model and Spring Surf will start emerge.

Speaking to Alfresco partners, customers and community member recently, I know people are already starting to implement the Web Editor Framework and build out their required functionality. We have current customers who have built presentation management capabilities with full custom clients, and the Web Editor Framework provides a powerful alternative to this route.

SURF Part 3 – Alfresco WCM Content

admin — Mon, 09 Mar 2009 18:24:02 +0000

**NOTE: This articles uses features found in HEAD which are considered to be work-in-progress. This article is for demo purposes only.**

In this article I will look at deploying and consuming WCM content from a SURF web application. To make this very simple, we have created a standalone Tomcat 6 bundle which has an example SURF web application pre-configured (thanks to Michael Uzquiano for all the assistance!). This is the same web app as used in the previous articles, so all previous material is still relevant.

Once the Tomcat bundle is deployed and your WCM instance configured, you will have working examples of:

An AVM layout separating Surf content (components, templates etc) and Web content (XML content, CSS, images etc).
Deployment configuration allowing the Surf and/or Web content to be deployed to a local file system directory.
An FSR – configured for the deployment as above
A Surf website example of including static content e.g. an HTML file from the local file system.
A surf website example of dispatching dynamic content from the remote Alfresco repository.
Web form examples for the creation of example content.

Initially I will describe the steps required to get up and running, and then I will dissect the configuration so that we fully understand how it is working.

Prerequisites

It is expected that you are familiar with Alfresco concepts such as CIFS, Web Scripts, Web Forms etc. This is not a beginners tutorial to Alfresco WCM!
Alfresco v3.x installed with WCM configured and running at http://localhost:8080. If this address is different, you will need to re-configure the Alfresco endpoint. This is detailed below within the “Dynamic Content Example”, so do not be alarmed if your “Products” section does not work after the install.
This article is based on the Surf Deployment Configurations wiki article which I would highly recommend reading.

Download

Download the surf-sample Tomcat bundle and extract to your local file system e.g. c:\surf-sample.

Installation

Download the Surf demo Tomcat bundle and extract to your local file system. Have a browse through the files and you will see that the following is included:

surf-sample\sample – The Tomcat 6 bundle directory
surf-sample\setup\AVM – An example directory structure to be loaded into the AVM
surf-sample\setup\FSR – An example FSR
surf-sample\setup\web forms – Example web forms for creating news and product items
surf-sample\setup\web scripts – Example web scripts for the products section

Alfresco Setup

Create a new web project with the DNS name – “demo”. If you do not use this name, you will have to make a small change to the “Product” web script. See the “Web Scripts” section below.
Connect via CIFS to the AVM as the “admin” user.
Copy the contents of the AVM structure dir from the surf-sample\setup\AVM\ROOT to the admin user sandbox via CIFS. (You could also zip up and bulk import if you prefer)
Submit this content to the Staging sandbox.

The AVM directory structure should look like the following:

Web Forms

I have included two example web forms with the files so that you can quickly create some example content to be used with deployment, and for testing the example functionality. There are two web forms which need to be installed, one for the news articles and one for products.

Article Web Form

Create a new article web form using the C:\surf-sample\setup\web forms\article\article.xsd file. Add the output path pattern of /${webapp}/content/news/source/${name}.xml
Add C:\surf-sample\setup\web forms\article\latestNews.html.ftl as a rendition with the output path pattern /${webapp}/content/news/latestNews.html

Products Web Form

The product XML items are read dynamically by the Surf webapp.

Create a new product web form using the C:\surf-sample\setup\web forms\product\product.xsd. Add the output path pattern of /${webapp}/content/products/source/${name}.xml

Note there is also a article.html.ftl file, however at present this is not used. Once the web forms are installed, you can test creating some content. Verify that the output is being populated to the correct locations as listed above.

Web Scripts

The Products section uses a web script which must be installed.

Copy the C:\surf-sample\setup\web scripts\products folder in to the Alfresco Data Dictionary\web scripts folder and refresh the web scripts. If your site name is not “demo”, you will need to edit the site reference within C:\surf-sample\setup\web scripts\products\products.get.js i.e.

var storeid = ("demo");

Deployment Setup

All content is deployed to the C:\surf-sample\sample\deploy directory. This represents a stand alone directory which is configured to deliver the Alfresco content. This directory is separated into two sections as follows:

Web Content – e.g. HTML renditions, JS, CSS etc – deployed to C:\surf-sample\sample\deploy\webroot\ROOT
Surf Content – surf items such as templates, components etc – deployed to C:\surf-sample\sample\deploy\alfresco

Configure two deployment targets:

Edit your Web Project and add two File System Receivers using the details below.

Name: Content Production
Excludes: [A-Za-z0-9:/_]*ROOT/WEB-INF/*
Target Name: content

Name: Surf Production
Source Path: /ROOT/WEB-INF/classes/alfresco
Target Name: alfresco

FSR

There is an example FSR located within C:\surf-sample\setup\FSR. You can copy this directory to another location if required e.g. c:\FSR. The C:\surf-sample\setup\FSR\application-context.xml file has an example configuration which will need to be edited to match your file system locations depending upon where the surf-sample app is located. See the dir locations in bold below:

C:\surf-sample\sample\deploy\alfresco admin admin C:\surf-sample\sample\deploy\webroot admin admin
Once complete, you should be able to start the surf-sample Tomcat and give the site a test. Create some content using the web forms and deploy it to the surf-sample app. Start the Tomcat using C:\surf-sample\sample\bin\startup.bat and hit http://localhost/surf/page?p=index

Static Content Example

The Home Page of the site includes a static HTML file that is created using the article.xsd web form. This creates the latestNews.html file within the repository to ROOT\content\news which is then deployed to the C:\surf-sample\sample\deploy\webroot\ROOT\content\news. The Surf web application then includes the latestNews.html at request time.

The HTML include import is done by the Surf component, however before this will function, we need to configure Surf (using Spring) to look into the C:\surf-sample\sample\deploy directory for the static content and web scripts. If you open C:\surf-sample\sample\shared\classes\alfresco\web-extension\custom-web-framework-application-context.xml you will see the example configuration:

/surf-sample/sample/deployalfresco/site-webscripts

Once this is configured, components can access this static content. The component that is used on the Home Page is C:\surf-sample\sample\deploy\alfresco\site-data\components\page.main.index.xml and looks like:
page main index /component/common/include div /content/news/latestNews.html

You can see that we are using one of the web scripts that comes bundled with Surf which is referenced by /component/common/include. The resource id is then passed in i.e. the html fragment.

Finally, it is also worth noting at this point that we have mapped a Tomcat alias to point to the “deploy” directory also. This allows us to reference files such as CSS and images if required, using the “/files” alias. Here is the server.xml extract:

Dynamic Content Example

The second example is the Products page which dynamically loads content from the Alfresco repository. A list of products is dynamically generated using a web script connecting top the remote Alfresco repository. When a link is clicked, the relevant content item is dispatched and loaded from the local file system.

The first part of this is a web script that is called to list all of the product items. This web script is actually located on the remote Alfresco server and therefore we have to configure Surf to search this location for web scripts.

Like configuring the local file store, there is a custom Spring file located in C:\surf-sample\sample\shared\classes\alfresco\web-extension. Open the web-framework-config-custom.xml file and if you scroll to the bottom, you will see the following extract:

alfresco-system Alfresco - System access System account access to Alfresco alfresco http://localhost:8080/alfresco/s declared admin admin true alfresco-system
This extract configures the remote Alfresco repository as an end-point. You may also notice just above this that there is another entrance as follows:
webapp Alfresco Web Application Resource Resolver Resolves data access for web application assets org.alfresco.web.framework.resource.AlfrescoWebProjectResourceResolver /files demo

This lets Surf bind to web application resources, like static files, in this case, the actual product XML item we wish to view.

With the end-point and resource resolver in place we can call the remote web script. So the process is fairly straight forward – the Surf component calls the remote web script that returns a list of products via JSON. We then need a way to load an appropriate template to display each product, and that is done by a page-association item. This tells Surf that there is an association between the content that is being loaded and the template we would like to use to display it. Take a look at C:\surf-sample\sample\deploy\alfresco\site-data\page-associations\products.xml:
{http://www.alfresco.org/model/wcmmodel/1.0}avmplaincontent products content-type default
You can see here that the source-id is “{http://www.alfresco.org/model/wcmmodel/1.0}avmplaincontent” and that the dest-id is “products” meaning that all content of the type avmplaincontent would be rendered via the “products” template.

Summary

Hopefully this provides a preview of how nicely WCM content will integrate with Surf powered websites, and Web Studio is also on the horizon to complete the suite. As noted previously, this Surf configuration and setup is based on the Surf Deployment Configurations wiki article which I would highly recommend reading. This provides a really good and detailed overview of other possible Surf configurations.

Thanks to Michael Uzquiano for all the assistance!

SURF Part 2 – Pages and Navigation

admin — Thu, 19 Feb 2009 15:59:41 +0000

During part 1, the process of creating a simple web page using the SURF framework was discussed detailing creating a basic template and various components. Next I will look at adding additional pages and building some simple navigation utilising SURF’s “Page Association” features.

Setup

If you have not got the basic home page up and running from part 1, download the sample web application here and deploy to your local Tomcat (or any other web app server). Once installed and started you should be able to hit the home page using http://localhost:8080/surf/page?p=index as long as you are using your local machine and have not renamed the web app folder. You should then get the HTML template home page as follows:

Overview

The process of creating a new page is relatively simple. It basically involves creating a new “page” item, and the relevant components that will make up that page as covered in part 1. In this example I am also going to introduce a new template so that we have a different layout for our new page. Here is an overview of the steps involved:

Create the new FTL template file (for the different layout)
Create the new “template instance” so that the new template can be referenced from a page component
Create the new page component

I will then move on the introduce some simple navigation using the Page Association item.

Templates and Pages

As noted, the process for creating the new template and page is identical to that covered in part 1 and therefore I will not describe the code in detail. If you are in any doubt, refer to Part 1 accordingly.

I have decided to introduce a new template so that we can use a different page layout from that of the home page. I have called this template “content.ftl” as it is a generic page for displaying any type of content.

Start by preparing a basic HTML page that will be used as a generic “content” page. If you downloaded an HTML template for part 1, perhaps a second content page was also provided. If not, you can take a copy of the current home page template. It does not really matter at this stage what it looks like, as long as you can see it is different from your current home page layout. You can always come back later and make CSS and other layout changes. If you are using the template that is included as part of the download, you can use the following example content.ftl page:
<@region id="top" scope="global" />



<@region id="header" scope="global" />





Example list item


Example list item


Example list item


Example list item








Aliquam metus turpis, luctus ac, sagittis eget




Suspendisse egestas fringilla odio. Donec lacinia tristique ante. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Etiam 




<@region id="footer" scope="global" />

You will note above that I have included the different components that we have available using the tag. This just allows us to re-use the global components we require e.g. header and footers.

Create the new content.ftl file in the /WEB-INF/classes/alfresco/templates directory.
Copy in your source HTML for your new layout, or the above example code into the new content.ftl file.
Add in your global components where needed e.g. headers and footers using the tag.
Create a new template instance file in /WEB-INF/classes/alfresco/site-data/template-instances named content.xml. You can copy the current “index.xml” file and remember to amend the to point to the new content template.
Now create the new page. Lets create a page called “products“. Create the page xml item within /WEB-INF/classes/alfresco/pages named products.xml. Remember to reference the new content template instance.

Once this is complete, you should be able to manually request the page to test it using http://localhost/surf/page?p=products. Here is my example products page using the “content.ftl” template:

You can now go ahead and componentise the new page as you wish. Perhaps separate the main content from the left pane and create web scripts to return the HTML where required.

Is is important that the navigation pane is componentised, as this is what we will be working with. The image below shows the navigation component:

Here are the steps involved to create the navigation component:

Create the new component in /WEB-INF/classes/alfresco/site-data/components. I have named my example global.nav.xml as this will be a globally scoped/used component.
Create a new web script FTL and descriptor file within /WEB-INF/classes/alfresco/site-webscripts. Remember to match the same URL references as defined within the component.
Chop out the HTML for the header navigation into the web script FTL file.
Include the component using the region tag into both the index and content template files:

<@region id="nav" scope="global" />

Test the pages so that the new nav component is being included correctly on both the index and the products pages.

We can now go ahead and create some dynamic navigation using Page Associations.

Page Association

From the Alfresco Wiki page – The Page Association objects allows you to link two pages together. Most commonly, this link is of type child and is meant to depict a fixed structure like a navigation tree. However, other types are possible and there is no requirement to use Page Associations as a means to support only a single fixed tree.

Using associations, multiple trees are possible. The nature of the associations, when expanded beyond child, is very similar to that of classifiers, categories, or tags. In other words, Pages may be associated to other pages, but they may also be laterally associated to other elements. This allows for implementations of faceted navigation and tag clouds.

In this example, we will create a very simple navigation to link the Home page (index) to the new Products page. To do this we will create a page association item.

Create a new Page Association item within /WEB-INF/classes/alfresco/site-data/page-associations named index-products.xml
Add the following code. Note the source and destination id’s relate the pages together:

index products child 1

Once the association file is in place, we now need to modify the global nav web script to process the relationships and display the menu. You should already have in place the nav.get.desc.xml file and nav.get.html.ftl (or files of similar name and purpose) web script files which currently just return the example menu HTML code, nothing dynamic.

In order to process the menu items, we will need to include some logic making use of a JavaScript file as part of the web script.

Create a nav.get.js (or relative name if your nav web script is named differently) file within the web scripts directory – /WEB-INF/classes/alfresco/site-webscripts.

// renderer attribute var renderer = instance.properties["renderer"]; if(renderer == null) { renderer = "horizontal"; } model.renderer = renderer;
// set up rendering attributes model.rootpage = sitedata.getRootPage(); model.linkbuilder = context.getLinkBuilder();

This code makes use of an example basic navigation component with horizontal and vertical renderers. This is included as part of the surf starter war.

Edit the nav.get.html.ftl file and remove the static HTML content. Add the following code:

<#if renderer == "horizontal"> <@horizontal page=rootpage showChildren=true/> <#macro horizontal page showChildren>





<#assign href = linkbuilder.page(page.id, context.formatId)>

<#assign classId = ''>

<#if page.id == context.page.id>

<#assign classId = 'current'>



${page.title}



<#-- Children of Home Page -->

<#list sitedata.findChildPages(page.id) as parentPage>



<#assign href = linkbuilder.page(parentPage.id, context.formatId)>

<#assign classId = ''>

<#if parentPage.id == context.page.id>

<#assign classId = 'current'>



${parentPage.title}

The above code makes use of the findChildPages(sourceId) Surf API call which simply finds all child page objects for the given top level page id. It also demonstrates usage of the linkBuilder facility which dynamically creates the URL. You will also notice that a style is being applied if we are viewing the current page i.e. parentPage.id == context.page.

This example could easily be extended for second level navigation simply by passing in the parent item id:
<#-- Children of Home Page --> <#list sitedata.findChildPages(page.id) as parentPage> <#-- Sub Pages --> <#list sitedata.findChildPages(parentPage.id) as childPage>

This is a simplified version of the navigation code used within the Green Energy site which is part of the Alfresco Surf Code Camp material. Jeff Potts has kindly made this available for download, and I would recommend taking a look to learn more about Surf in general (including an example of second level navigation).

Refresh the web scripts using http://localhost:8080/surf/service/

You should now have working navigation showing the Home page and the Products page:

Summary

Here we have just created a new template (so we can alter the style of the page), and created a new page using the new template. We then created a simple page association so that the navigation item could build the links. You can probably start to see how useful Web Studio will be, allowing new pages and navigation to be created using a GUI rather than hand coding each new page.

Next I will look at using Alfresco WCM with Surf, along with some deployment options.

Download

The completed web application is available for download here – SURF Part 2 – Pages and Navigation.

SURF Part 1 – Getting Started

admin — Mon, 02 Feb 2009 10:39:48 +0000

This article is a step-by-step guide to manually building a simple standalone web site with the SURF framework. This will familiarise you with some of the major components and building blocks used by SURF and provide a good foundation for understanding how Web Studio works under the covers.

As described by the Alfresco Wiki – Alfresco Surf is a lightweight, scriptable web framework built on top of Alfresco’s Web Script and Templating runtime. It is packaged as a single WAR file meaning it can exist as a standalone application. One of the nice things about the SURF framework is that you do not HAVE to use Alfresco, or any other data source to construct a web application, so for the purposes of this example, we will simply construct a basic standalone website without using Alfresco. We will take a static HTML web site template, componentise it and demonstrate loading different areas of the page using very basic Web Scripts.

09 Feb 2009 – Updated to use SURF starter WAR instead of alfwf.

Overview

SURF utilises the MVC pattern using various components and objects. XML files are effectively bound together to allow a page to be loaded and rendered. These include things like Pages, Templates, Components and Themes.

The array of Objects and configurations available to SURF is extensive and powerful and can be somewhat overwhelming for the purposes of just “getting started”. For this reason, I have chosen not to include the majority of these features and functions, however more advanced usage will be discussed in future articles. I would reccomend reading the Alfresco Wiki SURF Overview, as this explains the context of SURF in detail – http://wiki.alfresco.com/wiki/Surf_Platform. The SURF Platform Developers Guide also discusses in detail all of the available objects.

Take a look at the following diagram that represent a simplified path to how a page is loaded:

In simple terms, the page is specified and requested by the URL. The page definition then looks up the Template Instance, which then calls the actual template. This could be for example a Freemarker template file. The template file is broken down into regions which can each call page components.

Build the SURF war file

The SURF starter WAR file can be built from source using:
ant incremental-surf-starter

This creates the starter WAR file which includes example components and configurations. Alternatively you can download the WAR file here. Please be aware this was built on 09 Feb and may have changed since then, so building from source is reccomended.

When the WAR file is deployed, you should be able to access the splash page on http://localhost:8080/surf/page providing that you are using your local machine (localhost) and you have not renamed the webapp folder i.e. surf.

Cache

The SURF framework includes a cache facility and at the time of writing this was enabled by default. To save application server restarts it is a good idea to disable it during the development process.

Edit the /WEB-INF/classes/alfresco/web-framework-application-context.xml file.
Search for the word “updateDelay” and amend the value to “0″. There are two occurances and properties to change.

0

Restart your application server for the change to take effect.

Site Configuration

Create a new site configuration file within /WEB-INF/classes/alfresco/site-data/configurations named default.site.configuration.xml.
Add the following code to configure the default page to be “index”:

Sample Site Configuration Sample Site Configuration site index

Creating The Home Page

Create a new page file within the pages dir – /WEB-INF/classes/alfresco/site-data/pages named index.xml. This will be the website home page.

/WEB-INF/classes/alfresco/site-data/pages/index.xml
Home Site Home page index none

Template-Instance

The template-instance references the appropriate renderer, and uses freemarker by default.

Create a new template-instance within /WEB-INF/classes/alfresco/site-data/template-instances
Call it index.xml. This must match the name used within the parameters within the page example above.

/WEB-INF/classes/alfresco/site-data/template-instances/index.xml
index
In this example /WEB-INF/classes/alfresco/site-data/template-instances/index.xml references index.ftl within /WEB-INF/classes/alfresco/templates.

Templates

Next, we will create the corresponding template as referenced above by the in /WEB-INF/classes/alfresco/templates named “index.ftl”. This is the main page structure of our site. As mentioned previously, for the purposes of this article, we will construct a new site using an HTML site template. Choose an example HTML template for your site. There are plenty available on the web e.g. http://www.solucija.com/free-templates. Select a basic layout so that the site construction is simple.

Open the main page of your new downloaded HTML template (typically index.html) and copy the source code of the index.html into your newly created index.ftl.
Save the index.ftl template.

Now you should be able to test the new page by hitting your app server using the URL http://localhost:8080/surf/page?p=index. You should see your web template (probably with missing style and image data).

Now we will add in any missing page furniture files e.g. images, css, JavaScript etc so that the page will render correctly.

Copy the CSS file from the downloaded HTML template into /surf/css.

Repeat the file copy for any other page furniture that may be part of your web template e.g. images and JavaScript files. For example, images should be copied to /surf/images and JavaScript to /surf/js etc.
Edit your main freemarker template (/WEB-INF/classes/alfresco/templates/index.ftl) to reference these CSS/image/JS files. You can also use the Freemarker reference to URL context – ${url.context} to navigate to the correct directory, for example:

Do the same for any other CSS, JS and images which are referenced within your HTML template.
Refresh your browser and make sure that all of the referenced files are present. Remember you may have to alter the css file itself if it is referencing image files etc. You should then have a working home page.

Cache Refresh

When working with SURF editing files regularly, it may be required that the cache is cleared before your pages will render correctly. This can be done browsing to the cache invalidate page as follows:

http://localhost:8080/surf/control/cache/invalidate

Componentise The Page

A component is an instance of a component type that has been “bound” into a region or a slot. Basically the page is made up of components which can have different scopes. These can be either global, template or page depending on where you would like to use each component.

Global – Components to be used on ALL pages e.g. a logo
Template – components to be used on SOME pages i.e. > 1 but < all
Page – component to be used on a single page

Global Components

Start by creating a global component such as the page header. These are sections of the page that will not change from one page to the next. On my example HTML template, the logo and general header section will not change between pages (with the exception of the top navigation which i will componentise later), so I will start with that.

Create a new file in /WEB-INF/classes/alfresco/site-data/components named global.header.xml.

Naming Components

Naming SURF components is very important as it binds the component to a specific region of the page (i.e. where the component will be displayed), and defines the scope. The name is defined as follows scope.regionId.sourceId.xml so in the above example (global.header.xml) the component is of global scope, it is bound to a page region using header. Note there is no third parameter of the name (the sourceId binding to a specific page) in this example as this is a global scope component and therefore is used on all pages.

To provide a little further information on the Source ID, as noted above the value depends on the scope of the binding. So for page it’s the pageId, template it’s the templateId and as noted above global it’s always “global” so we ignore it and don’t make it part of the binding. The value is optional in the XML definitions for pages/templates/components because it can always be derived from the file name of the item – because the ID is bound in the filename.

Go ahead and create the global.header.xml as listed below:

/WEB-INF/classes/alfresco/site-data/components/global.header.xml
global header global /header

Web Scripts

One of the great things about SURF is the ability to run web scripts without requiring a connection to Alfresco. Introducing/detailing web scripts is out of scope for the purposes of this article however web scripts are discussed in detail on the Alfresco Wiki. I would recommend a basic understanding of Web Scripts before continuing.

For the purposes of this article, we will be using very simple Web Scripts to return our HTML components i.e. the html components that will make up our page. We actually have a couple of options here as to how the Web Scripts will work. For example, we could componentise the HTML into different physical files stored in a specific directory, and then use a web script to actually include the required HTML fragment file. Alternatively, we can simply store the HTML fragment within the Web Script Freemarker template file, so that this is the content that is rendered. Either option is fine, but I will use the latter for absolute simplicity! So for each Web Script, we will have two files – the XML descriptor file and the FTL renderer file.

You may have noticed above within the global.header.xml component definition that there is a parameter named . This specifies the web script url to request. With this example, the web script to be executed is being called by /header. Lets setup the /header web script and the related Freemarker file to return the header HTML.

Web scripts within SURF are typically stored within /WEB-INF/classes/alfresco/site-webscripts.

Create a web script descriptor file named header.get.desc.xml within /WEB-INF/classes/alfresco/site-webscripts.
Add the following to the file:

/WEB-INF/classes/alfresco/site-webscripts/header.get.desc.xmlHeader Loads global Header /header

Save and close this file and create the accompanying Freemarker template within the same directory. Name it header.get.html.ftl.

Next we will chop out the HTML from our index.ftl that represents the region we are componentising i.e. the header HTML. Using my example, this is the header HTML that makes up outlined area in the image above.

Edit the /WEB-INF/classes/alfresco/templates/index.ftl file and locate the HTML specific to your chosen global region e.g. header.
Cut this code so that it is saved to the clipboard and then paste it into the newly created WEB-INF/classes/alfresco/site-webscripts/header.get.html.ftl file. My HTML looks like the following, obviously this will be different depending upon what HTML template you downloaded:

/WEB-INF/classes/alfresco/site-webscripts/header.get.html.ftl



HomeAboutArchiveSitemap











Home


Services


Products


Clients


Services


About Us


Contact Us

Now we just need to reference the new component from the main index.ftl template – /WEB-INF/classes/alfresco/templates/index.ftl using the “region” tag. This is effectively a pointer to the component.

Edit the /WEB-INF/classes/alfresco/templates/index.ftl once again and locate the section of the page where the header HTML was previously removed.
Insert the region tag pointing to the header component as follows:

<@region id="header" scope="global" />

Save and close the file.

Once you have created and saved the two web script files and referenced the component from the template, we can refresh the web script environment to register the new script and test it. To refresh the web script environment access http://localhost:8080/surf/service/. You will see a button at the bottom of the page named “Refresh Web Scripts”. Select this and the new script will be registered. You can then test the Web Script by accessing it via the URL as listed within the descriptor file i.e. http://localhost:8080/surf/service/header. You should see the page header HTML:

Now when you hit the index home page once again, you should see your full page with the header global component being included – http://localhost:8080/surf/page?p=index

Page Scope Components

Once the header component is in place and running fine, we can move on to create some more components, this time using the page scope i.e. components that will change with each page. In my example, im going to build 2 for the home page named main and sidebar. I have highlighted where these components will be used within the index page:

The process is the same as we have just completed i.e.:

Create the two component files within /WEB-INF/classes/alfresco/site-data/components
Name them accordingly using scope.regionId.sourceId.xml
Create two new web scripts to return the required HTML for each area of the page
Chop the HTML out of the index.ftl page and paste into each of the corresponding web script FTL files
Edit the index.ftl and put in the placeholders to reference the components
Register the new web scripts
clear the SURF cache

I will detail another example (as listed above), this time for the main content part of my page (the left hand body text).

Create a new component within /WEB-INF/classes/alfresco/site-data/components named page.main.index.xml.
Configure the component for page scope, mapping to a region of choice e.g. “main” and mapping the source id to the index page. Finally map the url to the web script with a suitable URL e.g. /index/main

/WEB-INF/classes/alfresco/site-data/components/page.main.index.xml
page main index /index/main

Create the new web script within /WEB-INF/classes/alfresco/site-webscripts. First the descriptor file which I will call index.main.get.desc.xml. Make sure the url mapping matches that set in the component file above i.e. /index/main.

/WEB-INF/classes/alfresco/site-webscripts/index.main.get.desc.xml
index Returns the main page content for the index page. /index/main

Next the Freemarker part of the web script. I will name it index.main.get.html.ftl. Chop out the HTML for the appropriate region from your index.ftl file and paste it into this file. Save again to /WEB-INF/classes/alfresco/site-webscripts.
Edit the /WEB-INF/classes/alfresco/templates/index.ftl file again and put in the region placeholder where the component will be bound to. The id must match that set within the component definition.

<@region id="main" scope="page" />

Register the new web script by hitting http://localhost:8080/surf/service/ and select “Refresh Web Scripts”
Clear the SURF cache by visiting http://localhost:8080/surf/control/cache/invalidate
Refresh your home page to see the component included – http://localhost:8080/surf/page?p=index

Summary

Once the above is completed you will have successfully setup a SURF page, created several components and bound them to the page in the appropriate areas. You will also have created some basic web scripts to return the HTML components. Go ahead and create any other required page components for your home page, and remember to use the appropriate scope e.g. global for a footer etc.

Its now probably a good time re visit the Wiki documentation on SURF as this will give you a good understanding of what other features and capabilities are available. What we have completed here has barely scratched the surface, however should be useful for moving forward. Next I will look at adding new pages and navigation.

Download

The finished web application is available for download here – SURF Part 1 – Getting Started.

XML Processing Using JSP / JSTL

admin — Fri, 16 Jan 2009 14:55:41 +0000

Recently I have been using Will’s libary for processing XML files in at request time using JSTL, and thought i would post some working examples which may be of use.

This example traverses into all folders below the ‘partner-data’ folder and matches all XML documents with the root element pe:partner_entrance:

Name -

The second example loads a single XML document and creates an HTML drop down list item. It matches on the “code” item and prints the name for each element: