Inhoudsfragmenten aanpassen en uitbreiden customizing-and-extending-content-fragments

Inhoudsfragmenten maken en beheren en Pagina's ontwerpen met inhoudsfragmenten voor meer informatie over inhoudsfragmenten.

Elementen beheren en Elementen aanpassen en uitbreiden voor meer informatie over standaardactiva.

Modellen van inhoudsfragmenten:

• Wordt gebruikt voor het definiëren van inhoudsfragmenten die gestructureerde inhoud bevatten.
• Inhoudsfragmentmodellen definiëren de structuur van een inhoudsfragment wanneer dit wordt gemaakt.
• Een fragment verwijst naar het model. Wijzigingen in het model kunnen/zullen daarom van invloed zijn op afhankelijke fragmenten.
• Modellen zijn opgebouwd uit gegevenstypen.
• Functies om nieuwe variaties toe te voegen, enzovoort, moeten het fragment overeenkomstig bijwerken.

Sjablonen voor inhoudsfragmenten:

• Wordt gebruikt voor het definiëren van eenvoudige inhoudsfragmenten.
• Sjablonen definiëren de (basis-, alleen-tekst) structuur van een inhoudsfragment wanneer dit wordt gemaakt.
• De sjabloon wordt naar het fragment gekopieerd wanneer het wordt gemaakt. Verdere wijzigingen in de sjabloon worden dus niet weerspiegeld in bestaande fragmenten.
• Functies om nieuwe variaties toe te voegen, enzovoort, moeten het fragment overeenkomstig bijwerken.
• Sjablonen voor inhoudsfragmenten werken op een andere manier dan andere sjablonen binnen het AEM ecosysteem (bijvoorbeeld paginasjablonen, enzovoort). Daarom moeten zij afzonderlijk worden beschouwd.
• Wanneer gebaseerd op een malplaatje wordt het MIME type van de inhoud beheerd op de daadwerkelijke inhoud; dit betekent dat elk element en elke variatie een verschillend MIME type kunnen hebben.

Alle inhoud wordt opgeslagen onder de jcr:content/data knooppunt van het element:

• De elementgegevens worden opgeslagen onder het hoofdsubknooppunt:

  jcr:content/data/master

• Variaties worden opgeslagen onder een subknooppunt met de naam van de variatie: bijvoorbeeld jcr:content/data/myvariation

• De gegevens van elk element worden in het desbetreffende subknooppunt opgeslagen als een eigenschap met de elementnaam: bijvoorbeeld de inhoud van het element text is opgeslagen als eigenschap text op jcr:content/data/master

Metagegevens en bijbehorende inhoud worden hieronder opgeslagen jcr:content/metadata
Met uitzondering van de titel en de beschrijving, die niet als traditionele metagegevens worden beschouwd en op jcr:content

Alle niet-inhoudinformatie van een fragment (zoals titel, beschrijving, metagegevens, structuur) wordt uitsluitend beheerd op het hoofdelement.

De inhoud van het eerste element van een fragment wordt toegewezen aan de oorspronkelijke uitvoering van het hoofdelement.

• De variaties (indien aanwezig) van het eerste element worden toegewezen aan andere uitvoeringen van het hoofdelement.

Aanvullende elementen (indien aanwezig) worden toegewezen aan subactiva van het hoofdactief.

• De belangrijkste inhoud van deze aanvullende elementen is gekoppeld aan de oorspronkelijke uitvoering van het respectieve subactief.
• Andere variaties (indien van toepassing) van eventuele aanvullende elementen die zijn toegewezen aan andere uitvoeringen van het desbetreffende subactief.

De component gebruikt de fragmentPath eigenschap om naar het daadwerkelijke inhoudsfragment te verwijzen. De fragmentPath Deze eigenschap wordt op dezelfde manier verwerkt als soortgelijke eigenschappen van andere elementtypen, bijvoorbeeld wanneer het inhoudsfragment naar een andere locatie wordt verplaatst.

Met de component kunt u de variatie selecteren die moet worden weergegeven.

Bovendien kunt u een reeks alinea's selecteren om de uitvoer te beperken. Deze alinea kan bijvoorbeeld worden gebruikt voor uitvoer met meerdere kolommen.

De component staat tussenliggende inhoud:

• Hier kunt u met de component andere elementen (afbeeldingen, enzovoort) tussen de alinea's van het fragment waarnaar wordt verwezen plaatsen.

• Voor tussenliggende inhoud moet u:

  • Houd rekening met de mogelijkheid van instabiele verwijzingen. Tussen de inhoud (die bij het ontwerpen van een pagina wordt toegevoegd) bestaat geen vaste relatie met de alinea die naast de inhoud wordt geplaatst. Er wordt een nieuwe alinea (in de fragmenteditor van de inhoud) ingevoegd voordat de positie van de inliggende inhoud de relatieve positie kan verliezen
  • extra parameters (zoals variatie- en alineasofilters) in overweging nemen om verkeerde positieven in zoekresultaten te voorkomen

Brontypen
Een lijst van sling:resourceTypes kan worden opgegeven om componenten te definiëren die worden gebruikt voor het renderen van inhoudsfragmenten en waar de achtergrondverwerking moet worden toegepast.

Referentie-eigenschappen
Een lijst met eigenschappen kan worden geconfigureerd om op te geven waar de verwijzing naar het fragment wordt opgeslagen voor de desbetreffende component.

De naam van de eigenschap waar het element of de elementen die moeten worden gerenderd, moet worden gedefinieerd element of elementNames.

De naam van de eigenschap waarin de uit te voeren wijziging is gedefinieerd, moet ofwel variation of variationName.

Als de uitvoer van meerdere elementen wordt ondersteund (door elementNames om meerdere elementen op te geven), wordt de werkelijke weergavemodus gedefinieerd door de eigenschap displayMode:

• Als de waarde singleText (en er is slechts één gevormd element) dan wordt het element teruggegeven als tekst met inhoud tussen, lay-outsteun, etc. Dit is de standaardinstelling voor fragmenten waarbij slechts één element wordt gerenderd.
• Anders wordt een veel eenvoudigere aanpak gebruikt (deze kan 'formulierweergave' worden genoemd), waarbij geen tussenliggende inhoud wordt ondersteund en de fragmentinhoud 'zoals deze is' wordt weergegeven.

Als het fragment voor displayMode == singleText (impliciet of expliciet) worden de volgende aanvullende eigenschappen toegepast:

• paragraphScope definieert of alle alinea's, of alleen een reeks alinea's, moeten worden gerenderd (waarden: all vs range)

• indien paragraphScope == range dan de eigenschap paragraphRange definieert het bereik van alinea's dat moet worden gerenderd

Vertalingen

Inhoudsfragmenten zijn volledig geïntegreerd met de AEM vertaalworkflow. Op architectonisch niveau betekent dit:

• De afzonderlijke vertalingen van een inhoudsfragment zijn eigenlijk afzonderlijke fragmenten, bijvoorbeeld:

  • zij bevinden zich in verschillende taalgebieden :

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

    vs

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

  • maar ze delen exact hetzelfde relatieve pad onder de hoofdmap van de taal :

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

    vs

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

• Naast op regel-gebaseerde wegen, is er geen verdere verbinding tussen de verschillende taalversies van een inhoudsfragment; zij worden behandeld als twee afzonderlijke fragmenten, hoewel UI de middelen verstrekt om tussen de taalvarianten te navigeren.

Metagegevensschema's

• Inhoudsfragmenten (opnieuw) gebruiken de metagegevensschema's, die met standaardelementen kunnen worden gedefinieerd.

• CFM biedt een eigen, specifiek schema:

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

  dit kan zo nodig worden verlengd .

• Het respectievelijke schema-formulier is geïntegreerd met de fragmenteditor.

Fragmentsjabloon (FragmentTemplate)

Gebruiken FragmentTemplate.createFragment() voor het maken van een fragment.

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

Deze interface vertegenwoordigt:

• een inhoudsfragmentmodel of een fragmentsjabloon voor inhoud op basis waarvan een inhoudsfragment moet worden gemaakt,
• en (na het maken) de structuurgegevens van dat fragment

Deze informatie kan omvatten:

• Toegang tot basisgegevens (titel, beschrijving)

• Sjablonen/modellen openen voor de elementen van het fragment:

  • Elementsjablonen weergeven
  • Structuurgegevens voor een bepaald element ophalen
  • Toegang tot de elementsjabloon (zie ElementTemplate)

• Sjablonen openen voor de variaties van het fragment:

  • Wijzigingssjablonen weergeven
  • Structuurgegevens voor een bepaalde wijziging ophalen
  • Toegang tot de variatiesjabloon (zie VariationTemplate)

• Aanvankelijke gekoppelde inhoud ophalen

Interfaces die belangrijke informatie vertegenwoordigen:

• ElementTemplate

  • Basisgegevens ophalen (naam, titel)
  • Eerste elementinhoud ophalen

• VariationTemplate

  • Basisgegevens ophalen (naam, titel, beschrijving)

Inhoudsfragment (ContentFragment)

Met deze interface kunt u op abstracte wijze met een inhoudsfragment werken.

De interface voorziet u van de middelen:

• Standaardgegevens beheren (bijvoorbeeld naam ophalen; titel/beschrijving ophalen/instellen)

• Toegang tot metagegevens

• Toegangselementen:

  • Lijstelementen

  • Elementen op naam ophalen

  • Nieuwe elementen maken (zie Caveats)

  • Gegevens over toegangselementen (zie ContentElement)

• Variaties weergeven die zijn gedefinieerd voor het fragment

• Nieuwe variaties wereldwijd maken

• Gekoppelde inhoud beheren:

  • Lijstverzamelingen
  • Verzamelingen toevoegen
  • Verzamelingen verwijderen

• Open het model of de sjabloon van het fragment

De interfaces die de belangrijkste elementen van een fragment vertegenwoordigen zijn:

• Inhoud-element (ContentElement)

  • Basisgegevens ophalen (naam, titel, beschrijving)

  • Inhoud ophalen/instellen

  • Toegang tot variaties van een element:

    • Variaties weergeven
    • Variaties ophalen op naam
    • Nieuwe variaties maken (zie Caveats)
    • Variaties verwijderen (zie Caveats)
    • Gegevens betreffende variatie van de toegang (zie ContentVariation)

  • Sneltoets voor het oplossen van variaties (door een aanvullende, implementatiespecifieke fallback-logica toe te passen als de opgegeven variatie niet beschikbaar is voor een element)

• Inhoudsvariatie (ContentVariation)

  • Basisgegevens ophalen (naam, titel, beschrijving)
  • Inhoud ophalen/instellen
  • Eenvoudige synchronisatie, gebaseerd op laatst gewijzigde informatie

Alle drie de interfaces ( ContentFragment, ContentElement, ContentVariation) de Versionable interface, die versiemogelijkheden toevoegt, vereist voor inhoudsfragmenten:

• Nieuwe versie van het element maken
• Versies van het element weergeven
• Hiermee wordt de inhoud opgehaald van een specifieke versie van het element met versiebeheer

ContentFragment kan worden aangepast aan:

• Resource - de onderliggende Sling resource; merk op dat het bijwerken van de onderliggende Resource rechtstreeks, moet u de ContentFragment object.

• Asset - de DAM Asset abstractie die het inhoudsfragment vertegenwoordigt; merk op dat het bijwerken van Asset rechtstreeks, moet u de ContentFragment object.

ContentElement kan worden aangepast aan:

• ElementTemplate - voor toegang tot de structurele informatie van het element.

FragmentTemplate kan worden aangepast aan:

• Resource - de Resource het bepalen van het model waarnaar wordt verwezen of de oorspronkelijke sjabloon die is gekopieerd;

  • wijzigingen aangebracht via de Resource worden niet automatisch weerspiegeld in de FragmentTemplate.

Resource kan worden aangepast aan:

• ContentFragment
• FragmentTemplate

De API is geïmplementeerd om functionaliteit te bieden die door de UI wordt ondersteund.

De gehele API is ontworpen voor niet Wijzigingen automatisch aanhouden (tenzij anders vermeld in de API JavaDoc). Zo zult u altijd de middeloplosser van het respectieve verzoek (of resolver moeten begaan u eigenlijk gebruikt).

Taken die extra inspanning zouden kunnen vereisen:

• Door nieuwe elementen te maken/verwijderen wordt de gegevensstructuur van eenvoudige fragmenten (op basis van een fragmentsjabloon) niet bijgewerkt.

• Nieuwe variaties maken van ContentElement werkt de gegevensstructuur niet bij (maar maakt deze globaal op ContentFragment zal).

• Als u bestaande variaties verwijdert, wordt de gegevensstructuur niet bijgewerkt.

filter.xml

De filter.xml voor inhoudsfragmentbeheer is zo geconfigureerd dat dit niet overlapt met het elementeninhoudspakket.

Een sessie starten

• Er wordt een nieuwe versie van het inhoudsfragment gemaakt.
• Automatisch opslaan is gestart.
• Cookies worden ingesteld; deze definiëren het momenteel bewerkte fragment en er is een bewerkingssessie geopend.

Een sessie voltooien

• Automatisch opslaan wordt gestopt.

• Bij toewijzen:

  • De laatste gewijzigde informatie wordt bijgewerkt.
  • Cookies worden verwijderd.

• Bij terugdraaien:

  • De versie van het inhoudsfragment dat is gemaakt toen de bewerkingssessie werd gestart, wordt hersteld.
  • Cookies worden verwijderd.

Bewerken

• Alle wijzigingen (automatisch opslaan inbegrepen) worden uitgevoerd op het actieve inhoudsfragment - niet in een gescheiden, beveiligd gebied.
• Deze wijzigingen worden daarom direct doorgevoerd op AEM pagina's die naar het desbetreffende inhoudsfragment verwijzen

Pagina's invoeren

• Controleer of er al een bewerksessie aanwezig is; door het betreffende cookie te controleren.

  • Als er een bestaat, controleert u of de bewerkingssessie is gestart voor het inhoudsfragment dat momenteel wordt bewerkt

    • Als het huidige fragment, herstelt u de sessie.
    • Als dat niet het geval is, probeert u het bewerken voor het eerder bewerkte inhoudsfragment te annuleren en cookies te verwijderen (er is geen bewerkingssessie daarna aanwezig).

  • Als er geen bewerkingssessie bestaat, wacht u op de eerste wijziging die de gebruiker heeft aangebracht (zie hieronder).

• Controleer of er al naar het inhoudsfragment wordt verwezen op een pagina en geef zo ja de juiste informatie weer.

Inhoud wijzigen

• Wanneer de gebruiker inhoud wijzigt en er geen bewerksessie aanwezig is, wordt een nieuwe bewerksessie gemaakt (zie Een sessie starten).

Pagina's verlaten

• Als een bewerkingssessie aanwezig is en de wijzigingen niet zijn doorgevoerd, wordt een modaal bevestigingsdialoogvenster weergegeven waarin de gebruiker op de hoogte wordt gebracht van mogelijk verloren inhoud en waarin hij of zij op de pagina kan blijven.

Knooppunt: <*conf-root*>/settings/dam/cfm/jcr:content

Naam eigenschap: autoSaveInterval

Type: Long

Standaard: 600 (10 minuten); dit wordt gedefinieerd op /libs/settings/dam/cfm/jcr:content

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

Naam eigenschap: autoSaveInterval

Type: Long

Waarde: 300 (5 minuten komt overeen met 300 seconden)