DokumentationAEM 6.5Användarhandbok

Sidmallar - redigerbara page-templates-editable

Last update: Thu Aug 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Utvecklare

Redigerbara mallar har lagts till:

  • Tillåt specialiserade författare att skapa och redigera mallar.

    • Sådana specialiserade författare kallas mallskapare
    • Mallförfattare måste vara medlemmar i gruppen template-authors.

  • Tillhandahåll mallar som behåller en dynamisk anslutning till alla sidor som skapas från dem. Om du gör det ser du till att alla ändringar i mallen återspeglas på själva sidorna.

  • Gör sidkomponenten mer generisk så att kärnsideskomponenten kan användas utan anpassning.

Med redigerbara mallar isoleras de delar som utgör en sida inuti komponenterna. Du kan konfigurera nödvändiga kombinationer av komponenter i ett användargränssnitt så att du slipper skapa en ny sidkomponent för varje sidvariant.

NOTE
Statiska mallar är också tillgängliga.

Det här dokumentet:

  • Ger en översikt över hur du skapar redigerbara mallar

  • Beskriver de admin-/utvecklaråtgärder som krävs för att skapa redigerbara mallar

  • Beskriver de tekniska grunderna för redigerbara mallar

Det här dokumentet förutsätter att du redan är bekant med att skapa och redigera mallar. Se redigeringsdokumentet Skapa sidmallar, som beskriver funktionerna i redigerbara mallar så som de visas för mallskaparen.

NOTE
Följande självstudiekurs kan också vara intressant för att konfigurera en redigerbar sidmall i ett nytt projekt:
Komma igång med AEM Sites del 2 - Skapa en bassida och mall

Skapa en ny mall creating-a-new-template

Skapandet av redigerbara mallar görs huvudsakligen med mallkonsolen och mallredigeraren av en mallskapare. I det här avsnittet ges en översikt över processen och en beskrivning av vad som händer på teknisk nivå.

Mer information om hur du använder redigerbara mallar i ett AEM projekt finns i Skapa ett AEM projekt med Lazybone.

När du skapar en redigerbar mall:

  1. Skapa en mapp för mallarna. Den här mappen är inte obligatorisk, men rekommenderas.

  2. Välj en malltyp. Den här typen kopieras för att skapa malldefinitionen.

    note note
    NOTE
    Du kan välja mellan olika malltyper direkt. Du kan även skapa egna webbplatsspecifika malltyper, om det behövs.

  3. Konfigurera den nya mallens struktur, innehållsprinciper, ursprungliga innehåll och layout.

    Struktur

    • Strukturen gör att du kan definiera komponenter och innehåll för mallen.

    • Komponenter som definieras i mallstrukturen kan inte flyttas till en resultatsida eller tas bort från eventuella resultatsidor.

      • Om du skapar en mall i en anpassad mapp utanför exempelinnehållet We.Retail kan du välja Foundation Components (Foundation-komponenter) eller använda Core Components.

    • Om du vill att sidförfattare ska kunna lägga till och ta bort komponenter lägger du till ett styckesystem i mallen.

    • Komponenter kan låsas upp och låsas igen så att du kan definiera ursprungligt innehåll.

    Mer information om hur en mallskapare definierar strukturen finns i Skapa sidmallar.

    Mer teknisk information om strukturen finns i Struktur i det här dokumentet.

    Profiler

    • Innehållsprinciperna definierar designegenskaperna för en komponent.

      • Till exempel de tillgängliga komponenterna eller minimi-/maximidimensionerna.

    • Dessa profiler gäller för mallen (och sidor som skapas med mallen).

    Mer information om hur en mallskapare definierar principer finns i Skapa sidmallar.

    Mer teknisk information om profiler finns i Innehållsprinciper i det här dokumentet.

    Inledande innehåll

    • Ursprungligt innehåll definierar innehåll som visas när en sida skapas baserat på mallen.
    • Det initiala innehållet kan sedan redigeras av sidförfattare.

    Mer information om hur en mallskapare definierar strukturen finns i Skapa sidmallar.

    Teknisk information om ursprungligt innehåll finns i Inledande innehåll i det här dokumentet.

    Layout

    • Du kan definiera mallayouten för ett antal olika enheter.
    • Responsiv layout för mallar fungerar på samma sätt som för sidredigering.

    Mer information om hur en mallskapare definierar mallayouten finns i Skapa sidmallar.

    Mer teknisk information om mallayout finns i Layout i det här dokumentet.

  4. Aktivera mallen och tillåt den sedan för specifika innehållsträd.

    • En mall kan aktiveras eller inaktiveras för att göra den tillgänglig eller inte tillgänglig för sidförfattare.
    • En mall kan göras tillgänglig eller otillgänglig för vissa sidgrenar.

    Mer information om hur mallskaparen aktiverar en mall finns i Skapa sidmallar.

    Mer teknisk information om hur du aktiverar en mall finns i Aktivera och tillåta en mall för användaree i det här dokumentet

  5. Använd det för att skapa innehållssidor.

    • När du använder en mall för att skapa en sida finns det ingen synlig skillnad och ingen indikation mellan statiska och redigerbara mallar.
    • För sidförfattaren är processen genomskinlig.

    Mer information om hur en sidförfattare använder mallar för att skapa en sida finns i Skapa och ordna sidor.

    Mer teknisk information om hur du skapar sidor med redigerbara mallar finns i Gällande innehållssidor i det här dokumentet.

TIP
Ange aldrig någon information som måste internationaliseras i en mall. För internalisering rekommenderas lokaliseringsfunktionen för kärnkomponenterna.
NOTE
Mallar är kraftfulla verktyg som effektiviserar arbetsflödet för att skapa sidor. Alltför många mallar kan överbelasta författarna och göra det förvirrande att skapa sidor. En bra tumregel är att hålla antalet mallar under 100.
Adobe rekommenderar inte att ha fler än 1 000 mallar på grund av potentiella prestandaeffekter.
NOTE
Redigerarens klientbibliotek förutsätter att namnområdet cq.shared finns på innehållssidorna. Om den inte finns resulterar det i JavaScript-felet Uncaught TypeError: Cannot read property 'shared' of undefined.
Alla exempelinnehållssidor innehåller cq.shared, så allt innehåll som baseras på dem inkluderar automatiskt cq.shared. Om du vill skapa egna innehållssidor från grunden utan att basera dem på exempelinnehåll måste du se till att inkludera namnutrymmet cq.shared.
Mer information finns i Använda bibliotek på klientsidan.

Mallmappar template-folders

Du kan använda följande mappar för att ordna dina mallar:

  • global
  • Webbplatsspecifik
    De platsspecifika mappar som du skapar för att ordna dina mallar skapas med kontoadministratörsbehörighet.
NOTE
Även om du kan kapsla dina mappar visas de som en platt struktur när användaren visar dem i konsolen Mallar.

I en AEM finns mappen global i mallkonsolen. Den här mappen innehåller standardmallar och fungerar som reserv om inga principer och/eller malltyper hittas i den aktuella mappen. Du kan lägga till dina standardmallar i den här mappen eller skapa en mapp (rekommenderas).

NOTE
Det är bäst att skapa en mapp som innehåller dina anpassade mallar och inte använda den globala mappen.
CAUTION
Mappar måste skapas av en användare med admin rättigheter.

Malltyper och profiler ärvs i alla mappar enligt följande prioritetsordning:

  1. Den aktuella mappen.
  2. Överordnad eller överordnad till den aktuella mappen.
  3. /conf/global
  4. /apps
  5. /libs

En lista över alla tillåtna poster skapas. Om några konfigurationer överlappar ( path/ label) visas endast den instans som ligger närmast den aktuella mappen för användaren.

Så här skapar du en mapp:

  • Programmerat eller med CRXDE Lite
  • Använda Konfigurationsläsaren

Använda CRXDE Lite using-crxde-lite

  1. En ny mapp (under /conf) kan skapas för din instans antingen programmatiskt eller med CRXDE Lite.

    Följande struktur måste användas:

    code language-xml 
    /conf
    <your-folder-name> [sling:Folder]
        settings [sling:Folder]
            wcm [cq:Page]
                templates [cq:Page]
                policies [cq:Page]

  2. Du kan sedan definiera följande egenskaper på mappens rotnod:

    <your-folder-name> [sling:Folder]

    Namn: jcr:title

    • Typ: String

    • Värde: Den rubrik (för mappen) som du vill ska visas i konsolen Mallar.

  3. I tillägg till de vanliga redigeringsbehörigheterna och -behörigheterna (till exempel content-authors) tilldelar du grupper och definierar de åtkomstbehörigheter (ACL) som krävs för att författarna ska kunna skapa mallar i den nya mappen.

    Gruppen template-authors är standardgruppen som måste tilldelas. Mer information finns i följande avsnitt, ACL:er och grupper.

    Mer information om hur du hanterar och tilldelar åtkomsträttigheter finns i Hantering av åtkomsträttigheter.

Använda Konfigurationsläsaren using-the-configuration-browser

  1. Gå till Global navigering > Verktyg > Konfigurationsläsaren.

    De befintliga mapparna visas till vänster inklusive mappen global.

  2. Klicka på Skapa.

  3. I dialogrutan Skapa konfiguration måste följande fält konfigureras:

    • Titel: Ange en rubrik för konfigurationsmappen
    • Redigerbara mallar: Markera för att tillåta redigerbara mallar i den här mappen

  4. Klicka på Skapa

NOTE
I konfigurationsläsaren kan du redigera den globala mappen och aktivera alternativet Redigerbara mallar om du vill skapa mallar i den här mappen. Denna metod rekommenderas dock inte.
Mer information finns i dokumentationen för Configuration Browser.

Behörighetslistor och grupper acls-and-groups

När mallmapparna har skapats (antingen med CRXDE eller med Configuration Browser) måste åtkomstkontrollistor definieras för rätt grupper för mallmapparna för att säkerställa att de är skyddade.

Mallmapparna för referensimplementeringen We.Retailkan användas som exempel.

Mallförfattargruppen the-template-authors-group

Gruppen template-authors är den grupp som används för att hantera åtkomst till mallar och levereras som standard med AEM, men är tom. Användare måste läggas till i gruppen för projektet/webbplatsen.

CAUTION
Gruppen template-authors är endast för användare som måste kunna skapa mallar.
Att redigera mallar är kraftfullt och om det inte görs på rätt sätt kan befintliga mallar brytas. Därför bör denna roll vara inriktad och endast omfatta kvalificerade användare.

Följande tabell visar vilka behörigheter som krävs för mallredigering.

Bana
Roll/grupp
Behörigheter
Beskrivning
/conf/<your-folder>/settings/wcm/templates
Mallförfattare
läsa, skriva, replikera
Mallförfattare som skapar, läser, uppdaterar, tar bort och replikerar mallar i det platsspecifika /conf-området
Anonym webbanvändare
read
En anonym webbanvändare måste läsa mallar när en sida återges
Innehållsförfattare
replikera
replicateInnehållsförfattare måste aktivera sidans mallar när en sida aktiveras
/conf/<your-folder>/settings/wcm/policies
Template Author
läsa, skriva, replikera
Mallförfattare som skapar, läser, uppdaterar, tar bort och replikerar mallar i det platsspecifika /conf-området
Anonym webbanvändare
read
En anonym webbanvändare måste läsa principer när en sida återges
Innehållsförfattare
replikera
Innehållsförfattare måste aktivera profilerna för en sidmall när en sida aktiveras
/conf/<site>/settings/template-types
Mallförfattare
read
Mallförfattare skapar en mall baserad på en av de fördefinierade malltyperna.
Anonym webbanvändare
ingen
En anonym webbanvändare får inte komma åt malltyperna

Den här standardgruppen template-authors täcker bara projektinställningarna, där alla template-authors-medlemmar har åtkomst till och kan redigera alla mallar. För mer komplexa konfigurationer, där det finns ett behov av flera mallskapargrupper för att åtskilja mallarna, måste fler anpassade mallskapargrupper skapas. Behörigheterna för mallförfattargrupperna är dock fortfarande desamma.

Äldre mallar under /conf/global legacy-templates-under-conf-global

Lagra inte mallar i /conf/global. För vissa äldre installationer kan det dock fortfarande finnas mallar på den här platsen. Endast i sådana äldre situationer bör följande /conf/global sökvägar konfigureras explicit.

Bana
Roll/grupp
Behörigheter
Beskrivning
/conf/global/settings/wcm/templates
Mallförfattare
läsa, skriva, replikera
Mallförfattare som skapar, läser, uppdaterar, tar bort och replikerar mallar i /conf/global
Anonym webbanvändare
read
En anonym webbanvändare måste läsa mallar när en sida återges
Innehållsförfattare
replikera
Innehållsförfattare måste aktivera sidmallarna när en sida aktiveras
/conf/global/settings/wcm/policies
Template Author
läsa, skriva, replikera
Mallförfattare som skapar, läser, uppdaterar, tar bort och replikerar mallar i /conf/global
Anonym webbanvändare
read
En anonym webbanvändare måste läsa principer när en sida återges
Innehållsförfattare
replikera
Innehållsförfattare måste aktivera profilerna för en sidmall när en sida aktiveras
/conf/global/settings/wcm/template-types
Mallförfattare
read
Mallförfattare skapar en mall baserad på en av de fördefinierade malltyperna
Anonym webbanvändare
ingen
En anonym webbanvändare får inte komma åt malltyperna

Malltyp template-type

När du skapar en mall anger du en malltyp:

  • Malltyper tillhandahåller effektivt mallar för en mall. När du skapar en mall används strukturen och det ursprungliga innehållet för den valda malltypen för att skapa mallen.

    • Malltypen kopieras för att skapa mallen.
    • När kopian är klar är den enda kopplingen mellan mallen och malltypen en statisk referens i informationssyfte.

  • Med malltyper kan du definiera:

    • Sidkomponentens resurstyp.
    • Rotnodens princip, som definierar vilka komponenter som tillåts i mallredigeraren.
    • Adobe rekommenderar att du definierar brytpunkterna för det responsiva stödrastret och konfigurationen av mobilemulatorn på malltypen. Det här steget är valfritt eftersom konfigurationen också kan definieras för den enskilda mallen (se Malltyp och Mobila enhetsgrupper).

  • AEM innehåller ett litet urval av färdiga malltyper som HTML5 Page och Adaptive Form Page.

    • Ytterligare exempel finns som en del av exempelinnehållet We.Retail.

  • Malltyper definieras vanligtvis av utvecklare.

Malltyperna som inte finns lagrade under:

  • /libs/settings/wcm/template-types
CAUTION
Ändra ingenting i sökvägen /libs. Orsaken är att innehållet i /libs skrivs över nästa gång du uppgraderar din instans (och kan skrivas över när du använder en snabbkorrigering eller ett funktionspaket).

Platsspecifika malltyper bör lagras på samma plats som:

  • /apps/settings/wcm/template-types

Definitioner för dina anpassade malltyper ska lagras i användardefinierade mappar (rekommenderas) eller i global. Till exempel:

  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/template-types
  • /conf/<my-folder>/settings/wcm/template-types
  • /conf/global/settings/wcm/template-types
CAUTION
Malltyperna måste respektera rätt mappstruktur (d.v.s. /settings/wcm/...), annars går det inte att hitta malltyperna.

Malltyp och mobila enhetsgrupper template-type-and-mobile-device-groups-br

De enhetsgrupper som används för en redigerbar mall (anges som relativ sökväg för egenskapen cq:deviceGroups) definierar vilka mobila enheter som är tillgängliga som emulatorer i layoutlägetför sidredigering. Det här värdet kan anges på två platser:

  • På den redigerbara malltypen
  • På den redigerbara mallen

När du skapar en redigerbar mall kopieras värdet från malltypen till den enskilda mallen. Om värdet inte anges för typen kan det anges i mallen. När en mall har skapats finns det inget arv från typen till mallen.

CAUTION
Värdet för cq:deviceGroups måste anges som en relativ sökväg, till exempel mobile/groups/responsive, och inte som en absolut sökväg, till exempel /etc/mobile/groups/responsive.
NOTE
Med statiska mallar kan värdet cq:deviceGroups anges i platsens rot.
Med redigerbara mallar lagras det här värdet nu på mallnivå och stöds inte på sidrotnivån.

Skapa malltyper creating-template-types

Om du har skapat en mall som kan användas som bas för andra mallar kan du kopiera den här mallen som en malltyp.

  1. Skapa en mall på samma sätt som du skapar redigerbara mallar. Se Skapa sidmallar. Detta kan fungera som grund för malltypen.
  2. Kopiera med CRXDE Lite den nya mallen från noden templates till noden template-types under mallmappen.
  3. Ta bort mallen från noden templates under mallmappen.
  4. I kopian av mallen som finns under noden template-types tar du bort alla cq:template - och cq:templateType -egenskaper från alla jcr:content -noder.

Du kan också utveckla en egen malltyp med en exempelredigerbar mall som bas, som finns på GitHub.

KOD PÅ GITHUB

Koden för den här sidan finns på GitHub

Malldefinitioner template-definitions

Definitioner för redigerbara mallar lagras i användardefinierade mappar (rekommenderas) eller i global. Till exempel:

  • /conf/<my-folder>/settings/wcm/templates
  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/templates
  • /conf/global/settings/wcm/templates

Rotnoden för mallen är av typen cq:Template med en skelettstruktur på:

<template-name>
  initial
    jcr:content
      root
        <component>
        ...
        <component>
  jcr:content
    @property status
  policies
    jcr:content
      root
        @property cq:policy
        <component>
          @property cq:policy
        ...
        <component>
          @property cq:policy
  structure
    jcr:content
      root
        <component>
        ...
        <component>
      cq:responsive
        breakpoints
  thumbnail.png

Huvudelementen är:

  • <template-name>

    • [initial](#initial-content)
    • jcr:content
    • [structure](#structure)
    • [policies](#policies)
    • thumbnail.png

jcr:innehåll jcr-content

Den här noden innehåller egenskaper för mallen:

  • Namn: jcr:title

  • Namn: status

    • Typ: String

    • Värde: draft, enabled eller disabled

Struktur structure

Definierar strukturen för den resulterande sidan:

  • Sammanfogas med det ursprungliga innehållet ( /initial) när en sida skapas.

  • Ändringar som görs i strukturen återspeglas i alla sidor som skapas med mallen.

  • Noden root ( structure/jcr:content/root) definierar listan över komponenter som är tillgängliga på den resulterande sidan.

    • Komponenter som definieras i mallstrukturen kan inte flyttas eller tas bort från resultatsidor.

    • När en komponent är olåst ställs egenskapen editable in på true.

    • När en komponent som redan innehåller innehåll har låsts upp, flyttas det här innehållet till grenen initial.

  • Noden cq:responsive innehåller definitioner för den responsiva layouten.

Ursprungligt innehåll initial-content

Definierar det ursprungliga innehåll som en ny sida har när den skapas:

  • Innehåller en jcr:content-nod som kopieras till nya sidor.
  • Sammanfogas med strukturen ( /structure) när du skapar en sida.
  • Befintliga sidor uppdateras om det ursprungliga innehållet ändras efter att de har skapats.
  • Noden root innehåller en lista med komponenter för att definiera vad som är tillgängligt på den resulterande sidan.
  • Om innehåll läggs till i en komponent i strukturläge och komponenten senare är olåst (eller omvänt), används det här innehållet som ursprungligt innehåll.

Layout layout

När du redigerar en mall kan du definiera layouten, använder den här metoden responsiv standardlayout som också kan konfigureras.

Innehållsprinciper content-policies

Innehållets (eller designens) profiler definierar designegenskaperna för en komponent, till exempel komponentens tillgänglighet eller min-/maxmått. Dessa profiler gäller för mallen (och sidor som skapas med mallen). Du kan skapa och välja innehållsprinciper i mallredigeraren.

  • Egenskapen cq:policy på noden root
    /conf/<your-folder>/settings/wcm/templates/<your-template>/policies/jcr:content/root
    Ger en relativ referens till innehållsprincipen för sidans styckesystem.

  • Egenskapen cq:policy, på de komponentspecifika noderna under root, innehåller länkar till principerna för de enskilda komponenterna.

  • De faktiska principdefinitionerna lagras under:
    /conf/<your-folder>/settings/wcm/policies/wcm/foundation/components

NOTE
Sökvägarna för principdefinitioner beror på komponentens sökväg. cq:policy innehåller en relativ referens till själva konfigurationen.
NOTE
Sidor som skapas från redigerbara mallar har inte något designläge i sidredigeraren.
Trädet policies i en redigerbar mall har samma hierarki som designlägeskonfigurationen för en statisk mall under:
/etc/designs/<my-site>/jcr:content/<component-name>
Konfiguration av designläge för en statisk mall har definierats per sidkomponent.

Sidprofiler page-policies

Med sidprofiler kan du definiera innehållsprincipen för sidan (huvudparsys), antingen i mallen eller på de resulterande sidorna.

Aktivera och tillåta en mall för användning enabling-and-allowing-a-template-for-use

  1. Aktivera mallen

    Innan en mall kan användas måste den aktiveras av något av följande:

    • Aktivera mallen från konsolen Mallar.

    • Anger egenskapen status för noden jcr:content.

      • På:

        /conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content

      • Definiera egenskapen:

        • Namn: status
        • Typ: String
        • Värde: enabled

  2. Tillåtna mallar

    Med värdet:

    /conf/<your-folder>/settings/wcm/templates/.*

Gällande innehållssidor resultant-content-pages

Sidor skapade från redigerbara mallar:

  • Skapas med ett underträd som sammanfogas från structure och initial i mallen

  • Har referenser till information som finns i mallen och malltypen. Du kan uppnå den här funktionen med en jcr:content-nod med egenskaperna:

    • cq:template
      Innehåller den dynamiska referensen till den faktiska mallen; gör att malländringarna kan återspeglas på de faktiska sidorna.

    • cq:templateType
      Anger en referens till malltypen.

chlimage_1-71

Diagrammet ovan visar hur mallar, innehåll och komponenter samverkar:

  • Styrenhet - /content/<my-site>/<my-page>
    Den resulterande sidan som refererar till mallen. Innehållet styr hela processen. Enligt definitionerna får den åtkomst till rätt mall och komponenter.

  • Konfiguration - /conf/<my-folder>/settings/wcm/templates/<my-template>
    Mallen och relaterade innehållsprinciperdefinierar sidkonfigurationen.

  • Modell - OSGi-paket
    OSGI-paketen implementerar funktionen.

  • Visa - /apps/<my-site>/components
    I både författar- och publiceringsmiljöer återges innehållet av components.

När en sida återges:

  • Mallar:

    • Egenskapen cq:template för noden jcr:content refereras till för att komma åt mallen som motsvarar den sidan.

  • Komponenter:

    • Sidkomponenten sammanfogar mallens structure/jcr:content-träd med sidans jcr:content-träd.

    • Sidkomponenten tillåter bara författaren att redigera noderna i mallstrukturen som har flaggats som redigerbara (och eventuella underordnade noder).

    • När du återger en komponent på en sida hämtas komponentens relativa sökväg från noden jcr:content. Samma sökväg under noden policies/jcr:content i mallen söks sedan igenom.

      • Egenskapen cq:policy för den här noden pekar på den faktiska innehållsprincipen (d.v.s. den innehåller designkonfigurationen för den komponenten).

      • Med den här funktionen kan du ha flera mallar som återanvänder samma innehållsprincipkonfigurationer.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2