Aikau Pages

Aikau pages are the new type of pages that the Share UI will use in the future. Currently only the following pages are implemented in Aikau:

The Web Script controller is where all the fun happens. It is where you define your page layout in JSON, including all the Aikau Widgets that make up the page. It will look something like this for a Hello World page:

model.jsonModel = {
    widgets: [
        {
            id: "SET_PAGE_TITLE",
            name: "alfresco/header/SetTitle",
            config: {
                title: "Hello World"
            }
        }
    ]
};   

The template will be very simple and the only thing it does is this:

<@processJsonModel />   

It basically just processes the JSON model that we set-up in the controller. Here we have used an out of the box Aikau widget called SkyVault/header/SetTitle, and the only thing left to do is to create the Web Script descriptor:

<webscript>
    <shortname>Hello World</shortname>
    <description>Hello World page definition</description>
    <family>Share</family>
    <url>/helloworld</url>
</webscript>   

An Aikau page is processed and generated via the Spring Surf and Spring MVC framework. The following picture gives an overview of how it works:

As we can see in the picture, all dynamic content that should go onto the page is fetched indirectly via Aikau Widgets, which can get the content from either the SkyVault Repository or from some other remote Web Service. Worth noting here is that we are actually using a Surf Page when we are invoking an Aikau page, in the Hello World example we are used the hybrid dynamic page (hdp) to get the Share header and footer included.

• tomcat/shared/classes/alfresco/web-extension/site-webscripts/ (Untouched by re-depolyments and upgrades)
• tomcat/shared/classes/alfresco/web-extension/site-data/extensions (Untouched by re-depolyments and upgrades)
• tomcat/webapps/share/js/ (when web resources are included, such as Aikau Widgets, you need to put them directly into the exploded webapp, this is NOT recommended.)

• share-amp/src/main/amp/config/alfresco/web-extension/site-webscripts/ - Aikau page Web Scripts
• share-amp/src/main/amp/config/alfresco/web-extension/site-data/extensions/ - Extension modules with Dojo package definitions
• share-amp/src/main/amp/web/js/<dojo package> - web resources, such as Aikau Widgets

• Introduction to Aikau Pages - This page contains a walk-through on how to create an Aikau page, and it also has links to a page that shows how to create the same page with old-school Surf.
• Introduction to Aikau
• Creating an Aikau page with Menus
• Aikau Widget Reference - this is the place to look for widgets that you can use in your pages.

• Adding new AMD packages for Aikau Widgets
• Aikau Tutorials on GitHub

• Creating a simple Aikau page with Cascading Menu
• Creating a simple Aikau page with a button on it
• Aikau background and concepts
• Deep dive into Dojo, Dijit, and Aikau development
• Aikau Tutorial