Personalizzazione ed estensione dei frammenti di contenuto customizing-and-extending-content-fragments

Creazione e gestione di frammenti di contenuto e Authoring di pagine con frammenti di contenuto per ulteriori informazioni sui frammenti di contenuto.

Gestione di Assets e Personalizzazione ed estensione di Assets per ulteriori informazioni sulle risorse standard.

Modelli per frammenti di contenuto:

• Utilizzato per definire frammenti di contenuto che contengono contenuto strutturato.
• I modelli per frammenti di contenuto definiscono la struttura di un frammento di contenuto al momento della creazione.
• Un frammento fa riferimento al modello, pertanto le modifiche apportate al modello possono influire o influenzeranno eventuali frammenti dipendenti.
• I modelli sono costituiti da tipi di dati.
• Le funzioni per aggiungere nuove varianti e così via devono aggiornare di conseguenza il frammento.

Modelli per frammenti di contenuto:

• Utilizzato per definire frammenti di contenuto semplici.
• I modelli definiscono la struttura (di base, di solo testo) di un frammento di contenuto al momento della creazione.
• Il modello viene copiato nel frammento quando viene creato; pertanto, eventuali modifiche al modello non verranno applicate ai frammenti esistenti.
• Le funzioni per aggiungere nuove varianti e così via devono aggiornare di conseguenza il frammento.
• I modelli per frammenti di contenuto funzionano in modo diverso rispetto ad altri meccanismi di modelli all'interno dell'ecosistema AEM (ad esempio i modelli di pagina e così via). Pertanto, essi devono essere considerati separatamente.
• Se basato su un modello, il tipo MIME del contenuto viene gestito in base al contenuto effettivo; ciò significa che ogni elemento e variante può avere un tipo MIME diverso.

Tutto il contenuto è archiviato nel nodo jcr:content/data della risorsa:

• I dati dell’elemento vengono memorizzati nel sottonodo principale:

  jcr:content/data/master

• Le varianti vengono memorizzate in un sottonodo che porta il nome della variante:
  ad esempio, jcr:content/data/myvariation

• I dati di ciascun elemento vengono memorizzati nel rispettivo sottonodo come una proprietà con il nome dell’elemento:
  ad esempio, il contenuto dell'elemento text è archiviato come proprietà text in jcr:content/data/master

I metadati e il contenuto associato sono memorizzati sotto jcr:content/metadata
Ad eccezione del titolo e della descrizione, che non sono considerati metadati tradizionali e memorizzati in jcr:content

Tutte le informazioni non relative al contenuto di un frammento (come titolo, descrizione, metadati, struttura) vengono gestite esclusivamente sulla risorsa principale.

Il contenuto del primo elemento di un frammento è mappato alla rappresentazione originale della risorsa principale.

• Le varianti (se presenti) del primo elemento sono mappate ad altre rappresentazioni della risorsa principale.

Elementi aggiuntivi (se esistenti) sono mappati su risorse secondarie della risorsa principale.

• Il contenuto principale di questi elementi aggiuntivi corrisponde alla rappresentazione originale della rispettiva risorsa secondaria.
• Altre varianti (se applicabili) di eventuali elementi aggiuntivi sono associate ad altre rappresentazioni della rispettiva risorsa secondaria.

Il componente utilizza la proprietà fragmentPath per fare riferimento al frammento di contenuto effettivo. La proprietà fragmentPath viene gestita nello stesso modo di proprietà simili di altri tipi di risorse, ad esempio quando il frammento di contenuto viene spostato in un’altra posizione.

Il componente ti consente di selezionare la variante da visualizzare.

Inoltre, è possibile selezionare un intervallo di paragrafi per limitare l’output; ad esempio, può essere utilizzato per l’output a più colonne.

Il componente consente contenuto intermedio:

• In questo caso il componente consente di inserire altre risorse (immagini e così via) tra i paragrafi del frammento di riferimento.

• Per i contenuti intermedi è necessario:

  • tieni presente la possibilità di riferimenti instabili; il contenuto intermedio (aggiunto durante l’authoring di una pagina) non ha una relazione fissa con il paragrafo a cui è posizionato, inserendo un nuovo paragrafo (nell’editor frammento di contenuto) prima che la posizione del contenuto intermedio possa perdere la posizione relativa
  • considera i parametri aggiuntivi (come i filtri di variante e di paragrafo) per evitare falsi positivi nei risultati di ricerca

Tipi di risorse
È possibile fornire un elenco di sling:resourceTypes per definire i componenti utilizzati per il rendering dei frammenti di contenuto e a cui applicare l'elaborazione in background.

Proprietà riferimento
È possibile configurare un elenco di proprietà per specificare dove viene memorizzato il riferimento al frammento per il rispettivo componente.

Il nome della proprietà in cui sono definiti gli elementi da sottoporre a rendering deve essere element o elementNames.

Il nome della proprietà in cui è definita la variante da sottoporre a rendering deve essere variation o variationName.

Se l'output di più elementi è supportato (utilizzando elementNames per specificare più elementi), la modalità di visualizzazione effettiva è definita dalla proprietà displayMode:

• Se il valore è singleText (ed è configurato un solo elemento), l'elemento viene riprodotto come testo con contenuto intermedio, supporto del layout e così via. Questa è l’impostazione predefinita per i frammenti in cui viene eseguito il rendering di un solo elemento.
• In caso contrario, viene utilizzato un approccio molto più semplice (che potrebbe essere denominato "visualizzazione modulo"), in cui non è supportato alcun contenuto intermedio e il contenuto del frammento viene renderizzato "così com’è".

Se il rendering del frammento viene eseguito per displayMode == singleText (in modo implicito o esplicito), entrano in gioco le seguenti proprietà aggiuntive:

• paragraphScope definisce se è necessario eseguire il rendering di tutti i paragrafi o solo di un intervallo di paragrafi (valori: all rispetto a range)

• se paragraphScope == range, la proprietà paragraphRange definisce l'intervallo di paragrafi di cui eseguire il rendering

Traduzioni

I frammenti di contenuto sono completamente integrati con il flusso di lavoro di traduzione AEM. A livello architettonico, ciò significa:

• Le singole traduzioni di un frammento di contenuto sono in realtà frammenti separati; ad esempio:

  • si trovano in diverse radici linguistiche:

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

    rispetto a

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

  • ma condividono esattamente lo stesso percorso relativo sotto la directory principale della lingua:

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

    rispetto a

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

• Oltre ai percorsi basati su regole, non esiste un’ulteriore connessione tra le diverse versioni linguistiche di un frammento di contenuto; vengono gestiti come due frammenti separati, anche se l’interfaccia utente fornisce i mezzi per navigare tra le varianti di lingua.

Schemi metadati

• I frammenti di contenuto (ri)utilizzano gli schemi di metadati, che possono essere definiti con risorse standard.

• CFM fornisce uno schema specifico:

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

  se necessario, è possibile estenderla.

• Il rispettivo modulo schema è integrato con l’editor di frammenti.

Modello frammento (Modello frammento)

Utilizza FragmentTemplate.createFragment() per creare un frammento.

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

Questa interfaccia rappresenta:

• un modello per frammenti di contenuto o un modello per frammenti di contenuto dal quale creare un frammento di contenuto,
• e (dopo la creazione) le informazioni strutturali di quel frammento

Queste informazioni possono includere:

• Accedere ai dati di base (titolo, descrizione)

• Accedi a modelli/modelli per gli elementi del frammento:

  • Elencare modelli di elementi
  • Ottenere informazioni strutturali per un determinato elemento
  • Accedere al modello di elemento (vedere ElementTemplate)

• Accedi ai modelli per le varianti del frammento:

  • Elencare modelli di varianti
  • Ottenere informazioni strutturali per una determinata variante
  • Accedere al modello di variante (vedere VariationTemplate)

• Ottieni contenuto associato iniziale

Interfacce che rappresentano informazioni importanti:

• ElementTemplate

  • Ottieni dati di base (nome, titolo)
  • Ottieni contenuto elemento iniziale

• VariationTemplate

  • Ottenere dati di base (nome, titolo, descrizione)

Frammento di contenuto (Frammento di contenuto)

Questa interfaccia consente di lavorare con un frammento di contenuto in modo astratto.

L’interfaccia consente di:

• Gestisci dati di base (ad esempio, nome, titolo/descrizione get/set)

• Accedere ai metadati

• Elementi di accesso:

  • Elementi elenco

  • Ottieni elementi per nome

  • Crea nuovi elementi (vedi Avvertenze)

  • Accedere ai dati degli elementi (vedere ContentElement)

• Elenca le varianti definite per il frammento

• Creare nuove varianti a livello globale

• Gestisci contenuto associato:

  • Elencare raccolte
  • Aggiungere raccolte
  • Rimuovi raccolte

• Accedere al modello o al modello del frammento

Le interfacce che rappresentano gli elementi principali di un frammento sono:

• Elemento contenuto (Elemento contenuto)

  • Ottenere dati di base (nome, titolo, descrizione)

  • Ottieni/Imposta contenuto

  • Accedere alle varianti di un elemento:

    • Varianti elenco
    • Ottieni varianti per nome
    • Crea nuove varianti (vedi Avvertenze)
    • Rimuovi varianti (vedi Avvertenze)
    • Accedere ai dati della variante (vedere ContentVariation)

  • Scelta rapida per la risoluzione delle varianti (applicazione di alcune logiche di fallback aggiuntive specifiche per l’implementazione se la variante specificata non è disponibile per un elemento)

• Variante contenuto (Variante contenuto)

  • Ottenere dati di base (nome, titolo, descrizione)
  • Ottieni/Imposta contenuto
  • Sincronizzazione semplice, basata sulle informazioni modificate più di recente

Tutte e tre le interfacce ( ContentFragment, ContentElement, ContentVariation) estendono l'interfaccia Versionable, che aggiunge funzionalità di controllo delle versioni, necessarie per i frammenti di contenuto:

• Crea una nuova versione dell’elemento
• Elencare le versioni dell’elemento
• Ottenere il contenuto di una versione specifica dell'elemento con versione

ContentFragment può essere adattato a:

• Resource: la risorsa Sling sottostante. Si noti che l'aggiornamento diretto di Resource sottostante richiede la ricompilazione dell'oggetto ContentFragment.

• Asset: l'astrazione DAM Asset che rappresenta il frammento di contenuto. Si noti che l'aggiornamento diretto di Asset richiede la ricompilazione dell'oggetto ContentFragment.

ContentElement può essere adattato a:

• ElementTemplate - per accedere alle informazioni strutturali dell'elemento.

FragmentTemplate può essere adattato a:

• Resource - Resource che determina il modello di riferimento o il modello originale copiato;

  • le modifiche apportate tramite Resource non vengono applicate automaticamente in FragmentTemplate.

Resource può essere adattato a:

• ContentFragment
• FragmentTemplate

L’API è implementata per fornire funzionalità supportate dall’interfaccia utente.

L'intera API è progettata per non mantenere le modifiche automaticamente (a meno che non sia indicato diversamente in API JavaDoc). Pertanto, dovrai sempre eseguire il commit del risolutore risorse della rispettiva richiesta (o del risolutore che stai utilizzando).

Attività che potrebbero richiedere un ulteriore impegno:

• La creazione o la rimozione di nuovi elementi non aggiorna la struttura dati dei frammenti semplici (in base a un modello di frammento).

• La creazione di nuove varianti da ContentElement non aggiornerà la struttura dei dati, ma la creazione a livello globale da ContentFragment consentirà.

• La rimozione delle varianti esistenti non aggiorna la struttura dati.

filter.xml

filter.xml per la gestione dei frammenti di contenuto è configurato in modo da non sovrapporsi al pacchetto di contenuti di base di Assets.

Avvio di una sessione

• Viene creata una nuova versione del frammento di contenuto.
• Salvataggio automatico avviato.
• I cookie sono impostati, definiscono il frammento attualmente modificato e indica che è aperta una sessione di modifica.

Completamento di una sessione

• Salvataggio automatico interrotto.

• Al commit:

  • Le informazioni dell’ultima modifica vengono aggiornate.
  • I cookie vengono rimossi.

• Al momento del rollback:

  • Viene ripristinata la versione del frammento di contenuto creato all’avvio della sessione di modifica.
  • I cookie vengono rimossi.

Modifica

• Tutte le modifiche (salvataggio automatico incluso) vengono eseguite sul frammento di contenuto attivo, non in un’area separata e protetta.
• Pertanto, tali modifiche vengono immediatamente applicate alle pagine AEM che fanno riferimento al rispettivo frammento di contenuto

Inserimento di una pagina

• Verifica se è già presente una sessione di modifica controllando il rispettivo cookie.

  • Se ne esiste una, verifica che la sessione di modifica sia stata avviata per il frammento di contenuto attualmente in fase di modifica

    • Se il frammento corrente, ristabilisci la sessione.
    • In caso contrario, prova ad annullare la modifica per il frammento di contenuto modificato in precedenza e a rimuovere i cookie (nessuna sessione di modifica successiva).

  • Se non esiste alcuna sessione di modifica, attendi la prima modifica apportata dall’utente (vedi sotto).

• Verifica se in una pagina è già presente un riferimento al frammento di contenuto e, in tal caso, visualizza le informazioni appropriate.

Modifica del contenuto

• Ogni volta che l'utente modifica il contenuto e non è presente alcuna sessione di modifica, viene creata una nuova sessione di modifica (vedere Avvio di una sessione).

Uscita da una pagina

• Se è presente una sessione di modifica e le modifiche non sono state rese permanenti, viene visualizzata una finestra di dialogo di conferma modale per notificare all’utente i contenuti potenzialmente persi e consentirne la permanenza nella pagina.

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

Nome proprietà: autoSaveInterval

Tipo: Long

Predefinito: 600 (10 minuti); definito il /libs/settings/dam/cfm/jcr:content

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

Nome proprietà: autoSaveInterval

Tipo: Long

Valore: 300 (5 minuti equivalgono a 300 secondi)