Customizing Page Authoring customizing-page-authoring

Adobe Experience Manager as a Cloud Service provides mechanisms to let you customize the page authoring functionality (and the consoles) of your authoring instance.

Clientlibs clientlibs

Clientlibs let you extend the default implementation to enable new functionality, while reusing the standard functions, objects, and methods.

When customizing, you can create your own clientlib under /apps. The new clientlib must:

See Using Client-Side Libraries on AEM as a Cloud Service.

Overlays overlays

Overlays are based on node definitions and allow you to overlay the standard functionality in /libs with your own customized functionality in /apps.

When creating an overlay, a 1:1 copy of the original is not required, as the sling resource merger allows for inheritance.

For more information, see the JS documentation set.

For more information on overlays, see Overlays for Adobe Experience Manager as a Cloud Service.

Add New Layer (Mode) add-new-layer-mode

When you are editing a page, there are various modes available. These modes are implemented using layers. These allow access to differing types of functionality for the same page content. Standard AEM modes include Edit, Layout, Developer, Timewarp, Live Copy Status, and Targeting.

Layer Example: Live Copy Status layer-example-live-copy-status

A standard AEM instance provides the MSM layer. This accesses data related to multisite management and highlights it in the layer.

To see it in action, you may edit any language copy in the WKND sample content and select the Live Copy Status mode.

You can find the MSM layer definition (for reference) in:

/libs/wcm/msm/content/touch-ui/authoring/editor/js/msm.Layer.js

Code Sample code-sample

This is a sample package showing how to create a layer (mode) for MSM view.

You can find the code of this page on GitHub.

Add New Selection Category to Asset Browser add-new-selection-category-to-asset-browser

The asset browser shows assets of various types/categories (for example, images and documents). The assets can also be filtered by these asset categories.

Code Sample code-sample-1

aem-authoring-extension-assetfinder-flickr is a sample package showing how to add a group to the asset finder. This example connects to Flickr’s public stream and shows them in the side panel.

You can find the code of this page on GitHub.

Filtering Resources filtering-resources

When authoring pages, the user must often select from resources in a list.

To keep the list to a reasonable size and also relevant to the use case, a filter can be implemented in the form of a custom predicate. For example, if the pathbrowser Granite component is used to allow the user to select the path to a particular resource, the paths presented can be filtered in the following way:

For further detail on creating a custom predicate, see this article.

Add New Action to a Component Toolbar add-new-action-to-a-component-toolbar

Each component usually has a toolbar that provides access to a range of actions that can be taken on that component.

Code Sample code-sample-2

aem-authoring-extension-toolbar-screenshot is a sample package showing how to create a custom toolbar action to render components.

You can find the code of this page on GitHub.

Add New In-Place Editor add-new-in-place-editor

Standard In-Place Editor standard-in-place-editor

In a standard AEM installation:

The following is an example of defining aspect ratios for the image cropping plugin of the image component.

   <cq:inplaceEditing
           jcr:primaryType="cq:InplaceEditingConfig"
           active="{Boolean}true"
           editorType="image">
           <config jcr:primaryType="nt:unstructured">
               <plugins jcr:primaryType="nt:unstructured">
                   <crop jcr:primaryType="nt:unstructured">
                       <aspectRatios jcr:primaryType="nt:unstructured">
                           <_x0031_6-10
                               jcr:primaryType="nt:unstructured"
                               name="16 : 10"
                               ratio="0.625"/>
                       </aspectRatios>
                   </crop>
               </plugins>
           </config>
   </cq:inplaceEditing>

Creating a New In-Place Editor creating-a-new-in-place-editor

To implement a new in-place editor (within your clientlib):

Code Sample for Creating a New In-Place Editor code-sample-for-creating-a-new-in-place-editor

aem-authoring-extension-inplace-editor is a sample package showing how to create an in-place editor in AEM.

You can find the code of this page on GitHub.

Add a New Page Action add-a-new-page-action

To add a new page action to the page toolbar, for example, a Back to Sites (console) action.

Code Sample code-sample-3

aem-authoring-extension-header-backtosites is a sample package showing how to create a custom header bar action to jump back to the Sites console.

You can find the code of this page on GitHub.

Customizing the Request for Activation Workflow customizing-the-request-for-activation-workflow

The out-of-the-box workflow, Request for Activation:

To have customized behavior on such activation, you can overlay the Request for Activation workflow: