Anpassa och utöka innehållsfragment customizing-and-extending-content-fragments

Skapa och hantera innehållsfragment och Sidredigering med innehållsfragment för mer information om innehållsfragment.

Hantera resurser och Anpassa och utöka resurser för mer information om standardtillgångar.

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 påverka alla beroende fragment.
• Modeller är inbyggda i datatyper.
• Funktioner för att lägga till nya varianter, och så vidare, måste uppdatera fragmentet därefter.

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å fler ändringar av mallen återspeglas inte i befintliga fragment.
• Funktioner för att lägga till nya varianter, och så vidare, måste uppdatera fragmentet därefter.
• Mallar för innehållsfragment fungerar på ett annat sätt än andra mallfunktioner i det AEM ekosystemet (till exempel sidmallar och så vidare). 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.

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

• Elementdata lagras under huvudundernoden:

  jcr:content/data/master

• Variationer lagras under en undernod som innehåller variantens namn, till exempel: jcr:content/data/myvariation

• Data för varje element lagras i respektive undernod som en egenskap med elementnamnet: till exempel elementets innehåll text lagras som egenskap text på jcr: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

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 huvudresursens ursprungliga återgivning.

• 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.

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 resurstyper, till exempel när innehållsfragmentet flyttas till en annan plats.

Med komponenten kan du välja den variant som ska visas.

Dessutom kan ett styckeintervall markeras för att begränsa utdata. Det 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 och så vidare) mellan styckena i det refererade fragmentet.

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

  • vara medveten 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, 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

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.

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 standardinställningen för fragment där endast 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

Ö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 egentligen 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 gränssnittet ger möjlighet att navigera mellan språkvarianterna.

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.

Fragmentmall (FragmentTemplate)

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

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

Gränssnittet 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.

Gränssnittet ger dig möjlighet att

• Hantera grundläggande data (till exempel 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

ContentFragment kan anpassas till

• Resource - den underliggande Sling-resursen, observera att uppdateringen av den 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

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.

filter.xml

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

Starta en session

• En ny version av innehållsfragmentet skapas.
• Spara automatiskt startas.
• Cookies är instä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

Ange en sida

• Kontrollera om det redan finns en redigeringssession genom att markera 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.

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

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

Egenskapsnamn: autoSaveInterval

Typ: Long

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