Template Editor AEM not working as expected

Question

We are using template editor in AEM 6.2 to create templates , and we have followed below steps to create a template-

1.Created page template as done in we-retail site. 2.Create empty page template using above page template. 3.Created template using empty page template.

Did following modifications on top of we retail page component as per our requirement-

1. As we need to have header and footer as full width parsys i.e 1340 width and body as 940 width-

   .site-wrapper { width:1340px; } .container { width:940px; }

So we did following modifications in /apps//components/structure/page/partials/body.html -

<div class="site-wrapper">
<div  data-sly-resource="${ @ path='header', resourceType='/apps/<projectname>/components/structure/header'}" 
data-sly-unwrap>
</div>
    </div>
    <div class="container"
       data-sly-use.templatedContainer="com.day.cq.wcm.foundation.TemplatedContainer">
       <sly data-sly-repeat="${templatedContainer.structureResources}"
          data-sly-resource="${item.path @ resourceType=item.resourceType, decorationTagName='div'}" />
    </div>
    <div class="site-wrapper">
    <div  data-sly-resource="${ @ path='footer', resourceType='/apps/<projectname>/components/structure/footer'}" data-sly-unwrap></div>
    </div>

Also we have few more components which will take full width on the page so i have added responsivegrid component under full width div.

But i am not able to edit the header and footer component in template as they are not under templateresource.

Also even if i add design dialog under header and footer i am not able to edit those components directly on the page in design mode even if they are unlocked.

Please let me know if i am doing anything wrong here or we cant customize body.html as in we-retail site.

I thought of using different parsys for full width and for body. And i don't want to control using css as i have multiple components which are full width.

Regards Ankur

Answer 1

First, the objective of the Template Editor is precisely to not do any static includes like what you edited on your page component, because the Template Editor now provides a UI to include such components on the page level, allowing to define which included components can be edited or not by authors on the resultant pages. That way, if some page suddenly requires another header or footer, this can be edited through the UI of the Template Editor and doesn't require a development cycle.

So I'd recommend to remove your edits of the body.html, and rather make sure that your Header and Footer components are editable: meaning that the cq:Component node must have a title (jcr:title), a group (componentGroup), as well as an cq:editConfig, a classic dialog or a classic design dialog (in 6.2 and before, the classic dialogs were still needed to make a component editable, but this won't be the case anymore for future versions, where touch dialogs can be provided instead).

Once you're there, here are detailed instructions for setting up your site with the Template Editor UI in AEM 6.2:

Create the template

For now, we'll create the template in the global folder, later however you'll have to make sure that the chosen folder is specific to your site.

1. Go to the Template Editor (in AEM's global nav, select General > Templates).
2. Pick the global folder (or your site-specific folder).
3. Hit the "Create" button and choose "HTML5 Page", hit "Next" and give your template a name, like "Simple Page", then hit "Create" and choose "Open".

Add Client Libraries

Let's configure the page component to load the CSS and JS client libraries that are needed for our site.

4. In "Structure" mode of the Template Editor, select the second icon from the top-left ("Page Information") and choose "Page Policy". A policy is basically a reusable design configuration that can be shared and reused across multiple templates if desired. What we'll do is duplicate that policy and then edit it to instruct the page to load additional client libraries.
5. In the "Policy" dialog, duplicate the "Default Page" policy with the double-arrow icon and rename it for instance to " Config". Then click the checkmark at the top-right of the dialog to save.
6. Again in the top-left ("Page Information") menu, choose this time "Page Design" to edit the actual design configuration.
7. Edit the list to include all client libraries required by the components that you plan to use. If the template author isn't a developer, this is typically where the developer must instruct the template author what clientlibs must be loaded on the pages of a specific site. In case you have We.Retail installed, you can add a field and paste we-retail.base into it. Save by clicking the top-right checkmark.

Add Structure Components

Structure components are those that were usually hard-coded through static includes on the page components. We typically don't want the structure components to be editable by our page authors later on, unless explicitly defined.

8. On the page, select the empty parsys and in its toolbar, choose the 1st icon ("Policy") to edit policy.
9. In the "Policy" dialog, duplicate the "Default Layout Container" policy and rename it for instance to "Template Config". This will be the name of the configuration that tells what components are available in the template for that page-level layout container. Save.
10. As the page reloads, select the empty parsys again, and this time choose the 2nd icon ("Design") to edit the design configuration.
11. In the design dialog that opens, select all the components that you want to have available in the template editor (for example, in addition to the few General components already selected, also select the "We.Retail" and the "We.Retail.Structure" component groups at the bottom of the list, or the group name you assigned to your components with the componentGroup property). Make sure to have also the "Layout Container" component selected, as this is the paragraph system (aka parsys) that we'll require later to make the page editable. Save.
12. You should now see your components showing up in the left "Components" rail, which allows to drag & drop your header and footer components to the page (for We.Retail the header is named "We.Retail Page Header" and is at the very bottom of the component list, and it is similar for the footer).
13. Also drag a "Layout Container" component between your header and footer components, which is the actual parsys that we'll make editable for our page authors. So on your page, you should now at least have following components: your header (e.g. "We.Retail Page Header"), a "Layout Container", and your footer (e.g. "We.Retail Page Footer").

Make the template editable

We now have to specify which of the components added we want page authors to be able to edit.

14. Select the parsys placeholder that appears between the header and the footer, and click the last icon of the toolbar ("Unlock structure component").
15. Once this is done, the placeholder says "No allowed components for Layout Container", the reason is that this parsys has no policy yet assigned to define the list of allowed components for the page authors. Therefore, select this parsys placeholder again and from the toolbar select the second icon ("Policy").
16. To base our policy on the one previously edited, select the "Template Config", and the hit the duplicate icon and rename it to "Page Config". Save.
17. The list of allowed components now appear below the parsys placeholder, which looks good, except that we want to remove the components that we want available in for the template structure only. Therefore, let's select the placeholder once more and select the 3rd icon ("Design") from the toolbar.
18. In the design dialog, uncheck the structure-specific components and groups (for e.g. uncheck the "We.Retail.Structure" group). Save.

Use the template

That's it, we can now enable the template and use it on a site.

19. On the template admin (which should be still open in a previous browser tab), select your newly created template and hit "Enable" and confirm "Enable".
20. For pages to be able to be created from templates of the folder we used, one will need to put a cq:allowedTemplates property on a parent page (typically, this property will be set to the root page of the site). However, to create the very first root page, we'll initially just add that property to the /content node by using CRXDE Lite. So go to http://localhost:4502/crx/de/index.jsp#/content and on the root content node set cq:allowedTemplates multi-String property that equals to "/conf/global/settings/wcm/templates/.*" (or whatever folder you created your template in).
21. Save.
22. Back in AEM open the global menu and go to Sites and on the root folder, click "Create" and choose "Page".
23. Choose our "Simple Page" template, hit "Next", give the page a title, like "My Site" and click "Create" and "Open".

You should now see the page with the defined header and footer, but only the parsys in between that is editable. Also the desired components should show up in the left rail under the second "Components" tab.

Create a Template Type

In order to avoid having to repeat all these steps (mainly 1-18) each time one wants to create a new template, we can create a template type out of the template that we created.

24. In CRXDE Lite, go to the folder where you've created your template, like /conf/global/settings/wcm/templates and copy the template that should become a template type, like the simple-page node in our case.
25. Move to the template-types folder (e.g. /conf/global/settings/wcm/template-types in our case) and paste there the copied node.
26. Save.

Now, when creating a template in the global folder, one can choose the "Simple Page" as a starting point.

As you can see, the Template Editor introduces a very big change, not only technically, but also in the process: what required development steps can now be achieved through configuration. I'd therefore recommend to edit the page component only to adapt the technical HTML headers, but not to hard-code any visual items that should be displayed on the page, because surely enough in a few months/years the visual items will change and multiple variations of them will be required, for which you want to lighten the development need to allow faster changes.

Also helpful are following links:

• https://docs.adobe.com/docs/en/aem/6-2/develop/templates/page-templates-editable.html
• http://fr.slideshare.net/PatrickFauchre/empower-template-authors
• https://github.com/Adobe-Marketing-Cloud/aem-sites-example-custom-template-type

Answer 2

If you will check the resources included in template using calls such as <div data-sly-resource="${ @ path='footer', resourceType='/apps/<projectname>/components/structure/footer'}" data-sly-unwrap></div> tends to be problematic when it comes to editing, reason so far I have figured out it that if the nodes for the resources don't exist, these resources are not editable. Refer to an article around it here.

What we did was to create a scripts to create nodes on page load (EmbeddedComponent.js) -

"use strict";

/**
 * Creates a component node with name, if node does not yet exist.
 */
use([], function () {
    var newResourceName = this.name;
    var newResourceType = this.type;
    var resourceResolver = resource.getResourceResolver();
    var newNodePath = resource.path + "/" + newResourceName;
    var existingComponentResource = resourceResolver.getResource(newNodePath);

    if (existingComponentResource == null) {
        var properties = {
            "jcr:primaryType": "nt:unstructured",
            "sling:resourceType": newResourceType
        };
        resourceResolver.create(resource, newResourceName, properties);
        resourceResolver.commit();
    }
});

And in you HTML script you could do something like -

<div data-sly-use="${'Path to script/EmbeddedComponent.js' @ name='header', type=resTypHeader}"
     data-sly-resource="<header resource type>">

Answer 3

have you tried the data-sly-unwrap="${!wcmmode.edit}" on the header and footer include script?