Anpassa och utöka Content Fragments customizing-and-extending-content-fragments

CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.
CAUTION
Vissa funktioner för innehållsfragment kräver att AEM 6.4 Service Pack 2 (6.4.2.0).

Ett innehållsfragment utökar en standardresurs; se:

Arkitektur architecture

Grundläggande beståndsdelar för ett innehållsfragment är:

  • A Innehållsfragment,
  • bestående av en eller flera Innehållselement s,
  • och som kan ha en eller flera Innehållsvariation s.

Beroende på fragmenttypen används även modeller eller mallar:

CAUTION
Modeller för innehållsfragment rekommenderas nu för att skapa alla dina fragment.
Modeller för innehållsfragment används för alla exempel i We.Retail.
  • Modeller för innehållsfragment:

    • Används för att definiera innehållsfragment som innehåller strukturerat innehåll.
    • Modeller för innehållsfragment definierar strukturen för ett innehållsfragment när det skapas.
    • Ett fragment refererar till modellen. så ändringar i modellen kan/kommer att påverka beroende fragment.
    • Modeller är inbyggda i datatyper.
    • Funktioner för att lägga till nya varianter, osv., måste uppdatera fragmentet därefter.
    note caution
    CAUTION
    Alla ändringar i en befintlig innehållsfragmentmodell kan påverka beroende fragment. detta kan leda till egenskaper som är överblivna i dessa fragment.
  • Mallar för innehållsfragment:

    • Används för att definiera enkla innehållsfragment.
    • Mallar definierar (grundläggande, endast text) strukturen för ett innehållsfragment när det skapas.
    • Mallen kopieras till fragmentet när den skapas. så att ytterligare ändringar av mallen inte återspeglas i befintliga fragment.
    • Funktioner för att lägga till nya varianter, osv., måste uppdatera fragmentet därefter.
    • Mallar för innehållsfragment fungerar på ett annat sätt än andra mallmekanismer inom det AEM ekosystemet (t.ex. sidmallar). De bör därför beaktas separat.
    • När MIME-typen för innehållet baseras på en mall hanteras det faktiska innehållet. det innebär att varje element och variant kan ha olika MIME-typer.

Integrering med Assets integration-with-assets

Content Fragment Management (CFM) ingår i AEM Assets som:

  • Innehållsfragment är resurser.
  • De använder befintliga Assets-funktioner.
  • De är helt integrerade med Assets (Admin Consoles, etc.).

Mappa strukturerade innehållsfragment till resurser mapping-structured-content-fragments-to-assets

fragment-till-tillgångar-strukturerad

Innehållsfragment med strukturerat innehåll (dvs. baserat på en innehållsfragmentmodell) mappas till en enda resurs:

  • Allt innehåll lagras under jcr:content/data resursens nod:

    • Elementdata lagras under den överordnad undernoden:

      jcr:content/data/master

    • Variationer lagras under en undernod som har variantens namn:

      t.ex. jcr:content/data/myvariation

    • Data för varje element lagras i respektive undernod som en egenskap med elementnamnet:

      t.ex. elementets innehåll text lagras som egenskap textjcr:content/data/master

  • Metadata och tillhörande innehåll lagras nedan jcr:content/metadata

    Förutom rubriken och beskrivningen, som inte betraktas som traditionella metadata och lagras på jcr:content

Mappa enkla innehållsfragment till resurser mapping-simple-content-fragments-to-assets

chlimage_1-253

Enkla innehållsfragment (som baseras på en mall) mappas till en sammansatt resurs som består av en huvudresurs och (valfritt) underresurser:

  • All icke-innehållsinformation i ett fragment (som titel, beskrivning, metadata, struktur) hanteras exklusivt på huvudresursen.

  • Innehållet i det första elementet i ett fragment mappas till den ursprungliga återgivningen av huvudresursen.

    • Variationerna (om det finns några) för det första elementet mappas till andra återgivningar av huvudresursen.
  • Ytterligare element (om sådana finns) mappas till deltillgångar i huvudtillgången.

    • Huvudinnehållet i dessa ytterligare element mappas till den ursprungliga återgivningen av respektive underresurs.
    • Andra variationer (om tillämpligt) av eventuella ytterligare element överensstämmer med andra återgivningar av respektive deltillgång.

Resursplats asset-location

Precis som med standardresurser finns ett innehållsavdrag under:

  • /content/dam

Tillgångsbehörigheter asset-permissions

Mer information finns i Innehållsfragment - Ta bort överväganden.

Funktionsintegrering feature-integration

  • Funktionen Content Fragment Management (CFM) bygger på Assets core, men bör vara så oberoende som möjligt.
  • CFM tillhandahåller egna implementeringar för objekt i vyerna kort/kolumn/lista. dessa plugin-program i befintliga resursåtergivningsimplementationer.
  • Flera Assets-komponenter har utökats för att passa innehållsfragment.

Använda innehållsfragment på sidor using-content-fragments-in-pages

CAUTION
The Kärnkomponent för innehållsfragment rekommenderas nu. Se Utveckla kärnkomponenter för mer information.

Innehållsfragment kan refereras från AEM sidor, precis som andra resurstyper. AEM tillhandahåller Innehållsfragment kärnkomponent - en som gör att du kan ta med innehållsfragment på sidorna. Du kan också utöka Innehållsfragment kärnkomponent.

  • Komponenten använder fragmentPath -egenskap som refererar till det faktiska innehållsfragmentet. The fragmentPath Egenskapen hanteras på samma sätt som liknande egenskaper för andra tillgångstyper. till exempel när innehållsfragmentet flyttas till en annan plats.

  • Med komponenten kan du välja varianten som ska visas.

  • Dessutom kan ett antal stycken väljas för att begränsa utdata. Detta kan till exempel användas för utdata med flera kolumner.

  • Komponenten tillåter mellanliggande innehåll:

    • Här kan du placera andra resurser (bilder, etc.) mellan styckena i det refererade fragmentet.

      • För det mellanliggande innehållet behöver du:

        • vara medvetna om risken för instabila referenser, mellanliggande innehåll (som läggs till när en sida redigeras) har ingen fast relation till det stycke som det placeras bredvid, och infogning av ett nytt stycke (i innehållsfragmentredigeraren) innan placeringen av det mellanliggande innehållet kan förlora den relativa positionen
          • ta hänsyn till ytterligare parametrar (som variation och styckefilter) för att undvika falska positiva resultat i sökresultaten
NOTE
Content Fragment Model:
När du använder ett innehållsfragment som har baserats på en innehållsfragmentmodell på en sida, refereras modellen. Det innebär att om modellen inte har publicerats när du publicerar sidan, kommer den att flaggas och läggas till i resurserna som ska publiceras med sidan.
Innehållsfragmentmall:
När du använder ett innehållsfragment som har baserats på en mall för innehållsfragment på en sida, finns det ingen referens när mallen kopierades när fragmentet skapades.

Konfiguration med OSGi-konsol configuration-using-osgi-console

Serverdelsimplementeringen av innehållsfragment ansvarar till exempel för att göra instanser av ett fragment som används på en sida sökbara eller för hantering av blandat medieinnehåll. Den här implementeringen behöver veta vilka komponenter som används för att återge fragment och hur återgivningen är parametriserad.

Parametrarna för detta kan konfigureras i Webbkonsol, för OSGi-paketet Konfiguration av DAM-innehållsfragment.

  • Resurstyper

    En lista med sling:resourceTypes kan anges för att definiera komponenter som används för att återge innehållsfragment och var bakgrundsbearbetningen ska användas.

  • Referensegenskaper

    En lista med egenskaper kan konfigureras för att ange var referensen till fragmentet lagras för respektive komponent.

NOTE
Det finns ingen direkt mappning mellan egenskap- och komponenttyp.
AEM tar bara den första egenskapen som finns i ett stycke. Du bör därför välja egenskaperna noggrant.

osgi-config

Det finns fortfarande några riktlinjer som du måste följa för att se till att komponenten är kompatibel med bakgrundsbearbetningen av innehållsfragment:

  • Namnet på egenskapen där elementen som ska återges är antingen element eller elementNames.

  • Namnet på egenskapen där variationen som ska återges är antingen variation eller variationName.

  • Om utdata från flera element stöds (med elementNames om du vill ange flera element), definieras det faktiska visningsläget av egenskapen displayMode:

    • Om värdet är singleText (och bara ett element är konfigurerat) återges elementet som en text med mellanliggande innehåll, layoutstöd osv. Det här är standard för fragment där bara ett element återges.
    • I annat fall används en mycket enklare metod (kan kallas"formulärvy"), där inget mellanliggande innehåll stöds och fragmentinnehållet återges som det är.
  • Om fragmentet återges för displayMode == singleText (implicit eller explicit) spelas följande ytterligare egenskaper upp:

    • paragraphScope definierar om alla stycken, eller bara ett styckeintervall, ska återges (värden: all jämfört med range)
    • if paragraphScope == range sedan egenskapen paragraphRange definierar det styckeintervall som ska återges

Integrering med andra ramar integration-with-other-frameworks

Innehållsfragment kan integreras med:

  • Översättningar

    Innehållsfragment är helt integrerade med Arbetsflöde för AEM. Arkitekturnivå innebär följande:

    • De enskilda översättningarna av ett innehållsfragment är i själva verket separata fragment. till exempel:

      • De finns under olika språkrötter:

        /content/dam/<path>/en/<to>/<fragment>

        jämfört med

        /content/dam/<path>/de/<to>/<fragment>

      • men de delar exakt samma relativa sökväg under språkroten:

        /content/dam/<path>/en/<to>/<fragment>

        jämfört med

        /content/dam/<path>/de/<to>/<fragment>

    • Förutom de regelbaserade sökvägarna finns det ingen ytterligare koppling mellan de olika språkversionerna av ett innehållsfragment. De hanteras som två separata fragment, även om användargränssnittet ger möjlighet att navigera mellan språkvarianterna.

    note note
    NOTE
    Det AEM arbetsflödet för översättning fungerar med /content:
    • När innehållsfragmentsmodellerna finns i /conf, ingår de inte i sådana översättningar. Du kan Internationalisera gränssnittssträngar.
    • Mallar kopieras för att skapa fragmentet så detta är implicit.
  • Metadata-scheman

    • Innehållsfragment (återanvänd) metadatamodeller, som kan definieras med standardresurser.
  • CFM har ett eget specifikt schema:

    /libs/dam/content/schemaeditors/forms/contentfragment

    detta kan vid behov förlängas.

  • respektive schemaformulär är integrerat med fragmentredigeraren.

API för hantering av innehållsfragment - serversidan the-content-fragment-management-api-server-side

Du kan använda serversidans API för att komma åt dina innehållsfragment; se:

com.adobe.cq.dam.cfm
CAUTION
Vi rekommenderar att du använder serversidans API i stället för att komma åt innehållsstrukturen direkt.

Nyckelgränssnitt key-interfaces

Följande tre gränssnitt kan fungera som startpunkter:

  • Fragmentmall

    FragmentTemplate
    

    Använd FragmentTemplate.createFragment() för att skapa ett nytt fragment.

    code language-none
    Resource templateOrModelRsc = resourceResolver.getResource("...");
    FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
    ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
    

    Detta gränssnitt representerar:

    • antingen en modell för innehållsfragment eller en mall för innehållsfragment från vilken ett innehållsfragment ska skapas,
    • och (efter det att fragmentet har skapats) strukturinformationen

    Denna information kan omfatta:

    • Få tillgång till grundläggande data (titel, beskrivning)

    • Få åtkomst till mallar/modeller för elementen i fragmentet:

      • Mallar för listelement
      • Hämta strukturinformation för ett givet element
      • Åtkomst till elementmallen (se ElementTemplate)
    • Åtkomstmallar för variationerna av fragmentet:

      • Lista variantmallar
      • Hämta strukturinformation för en viss variation
      • Åtkomst till variantmallen (se VariationTemplate)
    • Hämta initialt associerat innehåll

    Gränssnitt som representerar viktig information:

    • ElementTemplate

      • Hämta grundläggande data (namn, titel)
      • Hämta ursprungligt elementinnehåll
    • VariationTemplate

      • Hämta grundläggande data (namn, titel, beskrivning)
  • Innehållsfragment

    ContentFragment
    

    Med det här gränssnittet kan du arbeta med ett innehållsfragment på ett abstrakt sätt.

    note caution
    CAUTION
    Vi rekommenderar starkt att du använder ett fragment via det här gränssnittet. Man bör undvika att ändra innehållsstrukturen direkt.

    Gränssnittet ger dig möjlighet att

    • Hantera grundläggande data (t.ex. get name;) get/set title/description)

    • Åtkomst till metadata

    • Åtkomstelement:

      • Listelement
      • Hämta element efter namn
      • Skapa nya element (se Caveats)
      • Åtkomst till elementdata (se ContentElement)
    • Listvarianter definierade för fragmentet

    • Skapa nya varianter globalt

    • Hantera associerat innehåll:

      • Listsamlingar
      • Lägg till samlingar
      • Ta bort samlingar
    • Åtkomst till fragmentets modell eller mall

    Gränssnitt som representerar de primära elementen i ett fragment är:

    • Innehållselement

      ContentElement
      
      • Hämta grundläggande data (namn, titel, beskrivning)

      • Hämta/ange innehåll

      • Få åtkomst till varianter av ett element:

        • Listvarianter
        • Hämta varianter efter namn
        • Skapa nya varianter (se Caveats)
        • Ta bort variationer (se Caveats)
        • Åtkomst till variantdata (se ContentVariation)
      • Kortkommando för att matcha variationer (tillämpa ytterligare, implementeringsspecifik reservlogik om den angivna varianten inte är tillgänglig för ett element)

    • Innehållsvariation

      ContentVariation
      
      • Hämta grundläggande data (namn, titel, beskrivning)
      • Hämta/ange innehåll
      • Enkel synkronisering, baserat på den senast ändrade informationen

    Alla tre gränssnitten ( ContentFragment, ContentElement, ContentVariation) utöka Versionable gränssnitt, som lägger till versionsfunktioner, som krävs för innehållsfragment:

    • Skapa en ny version av elementet
    • Lista versioner av elementet
    • Hämta innehållet i en specifik version av det versionshanterade elementet

Adapting - Using customito() adapting-using-adaptto

Följande kan anpassas:

  • ContentFragment kan anpassas till

    • Resource - den underliggande Sling-resursen, Observera att uppdateringen av underliggande Resource direkt, kräver att ContentFragment -objekt.
    • Asset - DAM Asset abstraktion som representerar innehållsfragmentet, Observera att uppdaterar Asset direkt, kräver att ContentFragment -objekt.
  • ContentElement kan anpassas till

    • ElementTemplate - för åtkomst till elementets strukturinformation.
  • FragmentTemplate kan anpassas till

    • Resource - Resource fastställa den refererade modellen eller originalmallen som kopierades,

      • ändringar som gjorts genom Resource återspeglas inte automatiskt i FragmentTemplate.
  • Resource kan anpassas till

    • ContentFragment
    • FragmentTemplate

Caveats caveats

Det bör noteras att

  • API:t implementeras för att tillhandahålla funktioner som stöds av användargränssnittet.

  • Hela API:t är utformat för not Bevara ändringarna automatiskt (om inget annat anges i API JavaDoc). Därför måste du alltid implementera resurslösaren för respektive begäran (eller den lösare som du använder).

  • Uppgifter som kan kräva ytterligare arbete:

    • När du skapar/tar bort nya element uppdateras inte datastrukturen för enkla fragment (baserat på en fragmentmall).
    • Skapa nya varianter från ContentElement uppdaterar inte datastrukturen (men skapar dem globalt från) ContentFragment will).
    • Om du tar bort befintliga varianter uppdateras inte datastrukturen.

API:t för hantering av innehållsfragment - klientsidan the-content-fragment-management-api-client-side

CAUTION
För AEM 6.4 är klientsidans API internt.

Ytterligare information additional-information

Se följande:

  • filter.xml

    The filter.xml för hantering av innehållsfragment konfigureras så att den inte överlappar det centrala resurspaketet.

Redigera sessioner edit-sessions

En redigeringssession startas när användaren öppnar ett innehållsfragment på någon av redigeringssidorna. Redigeringssessionen är slut när användaren lämnar redigeraren genom att välja antingen Spara eller Avbryt.

Krav requirements

Krav för att styra en redigeringssession är:

  • Att redigera ett innehållsfragment, som kan sträcka sig över flera vyer (= HTML-sidor), bör vara atomiskt.
  • Redigeringen bör också vara transaktionsbaserad; i slutet av redigeringssessionen måste ändringarna antingen verkställas (sparas) eller återställas (avbrytas).
  • Kantlådor ska hanteras på rätt sätt. Detta kan exempelvis gälla när användaren lämnar sidan genom att ange en URL manuellt eller med global navigering.
  • Det bör finnas en periodisk autosparfunktion (var x:e minut) för att förhindra dataförlust.
  • Om ett innehållsfragment redigeras av två användare samtidigt bör de inte skriva över varandras ändringar.

Processer processes

Processerna är följande:

  • Starta en session

    • En ny version av innehållsfragmentet skapas.
    • Spara automatiskt startas.
    • Cookies är fastställda; dessa definierar det redigerade fragmentet och att en redigeringssession är öppen.
  • Avsluta en session

    • Autosparande stoppas.

    • Vid implementering:

      • Den senast ändrade informationen uppdateras.
      • Cookies tas bort.
    • Vid återställning:

      • Den version av innehållsfragmentet som skapades när redigeringssessionen startades återställs.
      • Cookies tas bort.
  • Redigering

    • Alla ändringar (autosparande ingår) görs på det aktiva innehållsfragmentet - inte i ett avgränsat, skyddat område.
    • Därför återspeglas dessa ändringar direkt på AEM sidor som refererar till respektive innehållsfragment

Åtgärder actions

Möjliga åtgärder är:

  • Skriva in en sida

    • Kontrollera om det redan finns en redigeringssession; genom att kontrollera respektive cookie.

      • Om det finns någon kontrollerar du att redigeringssessionen startades för det innehållsfragment som redigeras just nu

        • Om det aktuella fragmentet används återupprättar du sessionen.
        • Om inte, försök att avbryta redigeringen för det tidigare redigerade innehållsfragmentet och ta bort cookies (ingen redigeringssession finns efteråt).
      • Om det inte finns någon redigeringssession väntar du på den första ändringen som gjorts av användaren (se nedan).

    • Kontrollera om det redan finns referenser till innehållsfragmentet på en sida och visa lämplig information om så är fallet.

  • Innehållsändring

    • När användaren ändrar innehåll och det inte finns någon redigeringssession skapas en ny redigeringssession (se Starta en session).
  • Lämna en sida

    • Om det finns en redigeringssession och ändringarna inte har sparats, visas en modal bekräftelsedialogruta som meddelar användaren om potentiellt förlorat innehåll och låter dem stanna kvar på sidan.

Exempel examples

Exempel: Åtkomst till ett befintligt innehållsfragment example-accessing-an-existing-content-fragment

För att uppnå detta kan du anpassa resursen som representerar API:t till:

com.adobe.cq.dam.cfm.ContentFragment

Till exempel:

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
}

Exempel: Skapa ett nytt innehållsfragment example-creating-a-new-content-fragment

Om du vill skapa ett nytt innehållsfragment programmatiskt måste du använda:

com.adobe.cq.dam.cfm.ContentFragmentManager#create

Till exempel:

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

Exempel: Ange intervall för autosparande example-specifying-the-auto-save-interval

Intervallet för att spara automatiskt (anges i sekunder) kan definieras med konfigurationshanteraren (ConfMgr):

  • Nod: <conf-root>/settings/dam/cfm/jcr:content

  • Egenskapsnamn: autoSaveInterval

  • Typ: Long

  • Standard: 600 (10 minuter); detta definieras på /libs/settings/dam/cfm/jcr:content

Om du vill ange ett intervall för automatiskt sparande på 5 minuter måste du definiera egenskapen på din nod; till exempel:

  • Nod: /conf/global/settings/dam/cfm/jcr:content

  • Egenskapsnamn: autoSaveInterval

  • Typ: Long

  • Värde: 300 (5 minuter motsvarar 300 sekunder)

Mallar för innehållsfragment content-fragment-templates

Se Mallar för innehållsfragment för fullständig information.

Komponenter för sidredigering components-for-page-authoring

Mer information finns i

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e