Configurare le impostazioni di generazione dell’output id181AI0B0E30
AEM Guides offre numerose opzioni di configurazione per personalizzare il processo di generazione dell’output. Questo argomento descrive tutte le configurazioni e le personalizzazioni utili per configurare il processo di generazione dell’output.
Configurare la scheda Baseline nel dashboard delle mappe DITA id223MD0D0YRM
Per nascondere la scheda Linea di base nel quadro comandi Mappa DITA, effettuare le seguenti operazioni:
- Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione.
- Nel file di configurazione, fornisci i seguenti dettagli (property) per configurare la scheda baseline nel dashboard delle mappe.
com.adobe.fmdita.config.ConfigManager
hide.tabs.baseline
true/false
).Valore predefinito: true
Configurare la pubblicazione mista in un sito AEM esistente id1691I0V0MGR
Se si dispone di un sito AEM che contiene contenuto DITA, è possibile configurare l'output del sito AEM per pubblicare contenuto DITA in una posizione predefinita all'interno del sito. Ad esempio, nella schermata seguente di una pagina del sito AEM, il nodo ditacontent
è riservato per l'archiviazione del contenuto DITA:
I nodi rimanenti nella pagina vengono creati direttamente dall’editor del sito AEM. La configurazione dell'impostazione di pubblicazione per la pubblicazione del contenuto DITA in una posizione predefinita garantisce che nessuno dei contenuti non DITA esistenti venga modificato dal processo di pubblicazione di AEM Guides.
Per consentire la pubblicazione di contenuto DITA in un nodo predefinito, è necessario eseguire le seguenti configurazioni sul sito esistente:
-
Configurare le proprietà del modello del sito
-
Aggiungere nodi al sito per pubblicare contenuti DITA
Per configurare le proprietà del modello del sito esistente, effettua le seguenti operazioni:
-
Utilizza Gestione pacchetti per scaricare il file /libs/fmdita/config/templates/default.
note note NOTE Non effettuare personalizzazioni nei file di configurazione predefiniti disponibili nel nodo libs
. È necessario creare una sovrapposizione del nodolibs
nel nodoapps
e aggiornare i file richiesti solo nel nodoapps
. -
Aggiungi le seguenti proprietà:
table 0-row-3 1-row-3 2-row-3 Nome proprietà Tipo Valore topicContentNode
Stringa Specificare il nome del nodo in cui pubblicare il contenuto DITA. Ad esempio, il nodo predefinito in cui AEM Guides pubblica il contenuto DITA è: jcr:content/contentnode
topicHeadNode
Stringa Specificare il nome del nodo in cui memorizzare le informazioni sui metadati del contenuto DITA. Ad esempio, il nodo predefinito in cui AEM Guides memorizza le informazioni sui metadati è: jcr:content/headnode
La prossima volta che pubblichi un contenuto DITA utilizzando le configurazioni dei modelli del sito, il contenuto viene pubblicato nei nodi specificati nelle proprietà topicContentNode
e topicHeadNode
.
Personalizzare l’output del sito AEM id166TG0B30WR
AEM Guides supporta la creazione di output nei seguenti formati:
- Sito AEM
- HTML5
- EPUB
- Output personalizzato tramite DITA-OT
Per l'output Sito AEM, è possibile assegnare diversi modelli struttura con diverse attività di output. Questi modelli di progettazione possono eseguire il rendering del contenuto DITA in layout diversi. Ad esempio, puoi specificare diversi modelli di progettazione per il pubblico interno ed esterno.
È inoltre possibile utilizzare plug-in personalizzati DITA Open Toolkit (DITA-OT) con AEM Guides. È possibile caricare questi plug-in DITA-OT personalizzati per generare l'output di PDF in un modo specifico.
Personalizza modello struttura per generare output customize_xml-add-on
AEM Guides utilizza un set di modelli di progettazione predefiniti per generare l’output del sito AEM. Puoi personalizzare i modelli di progettazione di AEM Guides per generare l’output conforme al tuo branding aziendale. Un modello di progettazione è una raccolta di vari stili (CSS), script (lato server e lato client), risorse (immagini, loghi e altre risorse) e nodi JCR che collegano tutte queste risorse. Un modello di progettazione può essere semplice come un singolo script lato server con solo un paio di nodi JCR o una combinazione complessa di stili, risorse e nodi JCR. I modelli di progettazione vengono utilizzati dal sottosistema di pubblicazione di AEM Guides durante la generazione dell’output del sito AEM e controllano la struttura, l’aspetto dell’output generato.
Non esiste alcuna restrizione relativa alla posizione delle risorse del modello di progettazione nel server, ma in genere sono organizzate in modo logico in base alla loro funzione. Ad esempio, tutti i file JavaScript e CSS del modello predefinito sono memorizzati nella cartella /etc/designs/fmdita/clientlibs/siteoutput/default
. Ovunque si trovino questi file, sono collegati tra loro da una raccolta di nodi JCR. Insieme, questi nodi JCR e i file costituiscono l’intero modello di progettazione.
Il modello struttura predefinito fornito con AEM Guides consente di personalizzare i componenti della pagina di destinazione, dell’argomento e della ricerca. Potete creare una copia del progetto di default e delle maschere di riferimento corrispondenti e specificare componenti diversi per generare l'output desiderato.
Per specificare il modello di progettazione da utilizzare per la generazione di output del sito AEM, effettua le seguenti operazioni:
-
Utilizzare Gestione pacchetti per scaricare il modello di progettazione predefinito dal percorso seguente:
/libs/fmdita/config/templates
-
Crea una copia dei file scaricati nella seguente posizione nell’archivio Git del Cloud Manager:
/apps/fmdita/config/templates
-
È inoltre necessario scaricare e copiare i modelli a cui si fa riferimento dal nodo del modello predefinito. I modelli a cui si fa riferimento si trovano in:
/libs/fmdita/templates/default/cqtemplates
Nella tabella seguente sono descritte le proprietà del modello di progettazione AEM Guides.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 Proprietà Descrizione landingPageTemplate
,searchPageTemplate
,topicPageTemplate
,shadowPageTemplate
Specifica il nodo cq:Template
per le pagine corrispondenti (destinazione, ricerca e argomento). Per impostazione predefinita, il nodocq:Template
per queste pagine si trova nel nodo/libs/fmdita/templates/default/cqtemplates
. Questo nodo definisce la struttura e le proprietà delle pagine di destinazione, ricerca e argomento.shadowPageTemplate
viene utilizzato per ottimizzare il contenuto a blocchi. Impostare il valore di questa proprietà su:fmdita/templates/default/cqtemplates/shadowpage
Nota: è necessario specificare un valore pertopicPageTemplate
.landingPageTemplate
esearchPageTemplate
sono proprietà facoltative. Se non desideri che le pagine di ricerca e di destinazione vengano generate, non specificare queste proprietà.title
Nome descrittivo del modello di progettazione. topicContentNode
Posizione del nodo che conterrà il contenuto DITA in una pagina dell'argomento. Il percorso è relativo alla pagina dell'argomento. topicHeadNode
Posizione del nodo che conterrà i valori head (o metadati) derivati dal contenuto DITA. Il percorso è relativo alla pagina dell'argomento. tocNode
Posizione del nodo che conterrà il sommario. Percorso relativo alla pagina di destinazione o al percorso di destinazione. basePathProp
Nome della proprietà per la memorizzazione del percorso della directory principale del sito pubblicato. indexPathProp
Nome della proprietà per la memorizzazione del percorso della pagina di destinazione/indice del sito pubblicato. pdfPathProp
Nome della proprietà per l'archiviazione del percorso del PDF dell'argomento, se è abilitata la generazione del PDF dell'argomento. pdfTypeProp
Il nome della proprietà per memorizzare il tipo della generazione di PDF. Attualmente questa proprietà contiene sempre "Argomento". searchPathProp
Il nome della proprietà per memorizzare il percorso della pagina di ricerca, se il modello include una pagina di ricerca. siteTitleProp
Nome della proprietà per memorizzare il titolo del sito da pubblicare. Questo titolo è in genere lo stesso del titolo della mappa pubblicata. sourcePathProp
Nome della proprietà per la memorizzazione del percorso dell'argomento DITA di origine per la pagina corrente. tocPathProp
Nome della proprietà per la memorizzazione del percorso della directory principale del sommario per il sito pubblicato.
Per ulteriori informazioni, vedere Creazione del primo sito Web Adobe Experience Manager e Nozioni di base sullo sviluppo di un sito Web personalizzato sull'AEM.
Usa il titolo del documento per generare l'output del sito AEM
Quando si genera l’output del sito AEM, il modo in cui gli URL vengono generati svolge un ruolo importante nella reperibilità dei contenuti. Se utilizzi nomi di file basati su UUID, la generazione di URL basati su UUID dei file non sarà semplice da cercare. In qualità di amministratore o di editore, hai il controllo su come generare gli URL per l’output del sito AEM. AEM Guides offre una configurazione attraverso la quale puoi scegliere di generare gli URL dell’output del sito AEM utilizzando il titolo del file invece dei nomi di file basati su UUID. Per impostazione predefinita, per i file system basati su UUID questa opzione è attivata. Ciò implicava che quando si genera l'output del sito AEM per file system basati su UUID, i titoli del file vengono utilizzati per generare gli URL e non gli UUID dei file.
Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione. Nel file di configurazione, fornisci i seguenti dettagli (property) per configurare la generazione di URL nell’output del sito AEM:
com.adobe.fmdita.config.ConfigManager
aemsite.pagetitle
Valore predefinito: false
Configura l’URL dell’output del sito AEM per utilizzare il titolo del documento
Puoi utilizzare i titoli dei documenti nell’URL dell’output del sito AEM. Se il nome del file non esiste o contiene tutti i caratteri speciali, puoi configurare il sistema per sostituire i caratteri speciali con un separatore nell’URL dell’output del sito AEM. Puoi anche configurarlo per sostituirli con il nome del primo argomento secondario.
Per configurare i nomi delle pagine, effettuare le seguenti operazioni:
- Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione.
- Nel file di configurazione, fornisci i seguenti dettagli (proprietà) per configurare i nomi delle pagine per gli argomenti.
com.adobe.fmdita.common.SanitizeNodeName
nodename.systemDefinedPageName
true/false
). Valore predefinito: false
Se ad esempio il @navtitle in <topichead>
contiene tutti i caratteri speciali e si imposta la proprietà aemsite.pagetitle
su true, per impostazione predefinita viene utilizzato un separatore. Se si imposta la proprietà nodename.systemDefinedPageName
su true, verrà visualizzato il nome del primo argomento figlio.
Configurare le regole di bonifica del nome file per la creazione di argomenti e la pubblicazione dell'output del sito AEM id2164D0KD0XA
In qualità di amministratore, puoi definire un elenco di caratteri speciali validi consentiti nei nomi dei file, che alla fine formeranno l’URL di un output di sito AEM. Nelle versioni precedenti, gli utenti potevano definire nomi di file contenenti caratteri speciali come @
, $
, >
e altri. Questi caratteri speciali hanno prodotto un URL codificato nella generazione di pagine del sito AEM.
A partire dalla versione 3.8, sono state aggiunte configurazioni per definire un elenco di caratteri speciali consentiti nei nomi dei file. Per impostazione predefinita, la configurazione del nome file valida contiene "a-z A-Z 0-9 - _
". Ciò implica che durante la creazione di un file, è possibile inserire qualsiasi carattere speciale nel titolo del file, ma internamente verrà sostituito con un trattino (-
) nel nome del file. Ad esempio, puoi assegnare al file il titolo Introduzione 1 o Introduction@1; il nome file corrispondente generato in entrambi i casi sarà Introduzione-1.
Quando definisci un elenco di caratteri validi, ricorda che questi caratteri "*/:[\]|#%{}?&<>"/+
" e a space
verranno sempre sostituiti da un trattino (-
).
Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione. Nel file di configurazione, fornisci i seguenti dettagli (property) per configurare i caratteri speciali validi nei nomi dei file e nell’output del sito AEM:
com.adobe.fmdita.common.SanitizeNodeNameImpl
aemsite.DisallowedFileNameChars
'<>`@$
. Puoi aggiungere altri caratteri speciali a questo elenco.Puoi anche configurare le altre proprietà, ad esempio l’utilizzo di lettere minuscole nei nomi dei file, di un separatore per la gestione dei caratteri non validi e del numero massimo di caratteri consentiti nei nomi dei file. Per configurare queste proprietà, aggiungi le seguenti coppie di valori chiave nel file di configurazione:
nodename.uselower
Valore predefinito: true
nodename.separator
Valore predefinito: _ (trattino basso)
nodename.maxlength
Valore predefinito: 50
Configurare l’appiattimento della struttura dei nodi del sito AEM
Quando si genera l'output Sito AEM, viene creato internamente un nodo per ogni elemento degli argomenti. Per una mappa DITA con migliaia di argomenti, questa struttura di nodi può diventare troppo profonda. Questo tipo di struttura di nodi profondamente nidificata può presentare problemi di prestazioni per siti più grandi. L’istantanea seguente mostra la struttura dei nodi profondamente nidificati per un output di un sito AEM:
Nell'istantanea precedente, si noti che viene creato un nodo per ogni elemento p
e i relativi sottoelementi successivi e che viene creata una struttura simile per ogni altro elemento utilizzato nell'argomento.
AEM Guides consente di configurare la modalità di creazione interna della struttura dei nodi dell’output del sito AEM. È possibile appiattire la struttura del nodo in corrispondenza di elementi specifici, il che significa che è possibile definire un elemento che verrà considerato come elemento principale e tutti i sottoelementi al suo interno verranno uniti all’elemento principale. Se ad esempio si decide di appiattire l'elemento p
, qualsiasi elemento visualizzato all'interno dell'elemento p
verrà unito all'elemento p
principale. Non verrà creata una nota separata per alcun sottoelemento all'interno dell'elemento p
. Lo snapshot seguente visualizza la struttura del nodo appiattita in corrispondenza dell'elemento p
:
Per appiattire la struttura dei nodi del sito AEM, effettuare le seguenti operazioni:
-
Identifica l’elemento in corrispondenza del quale desideri appiattire la struttura del nodo:
-
Sovrapposizione del nodo
libs
nel nodoapps
e apertura del file elementmapping.xml. -
Aggiungere la proprietà
<flatten>true</flatten>
nella definizione dell'elemento in corrispondenza del quale si desidera appiattire la struttura del nodo. Ad esempio, se si desidera appiattire la struttura del nodo in corrispondenza dell'elementop
, aggiungere l'attributo appiattire nella definizione dell'elementop
come illustrato di seguito:code language-xml <ditaelement> <name>p</name> <class>- topic/p</class> <componentpath>fmdita/components/dita/wrapper</componentpath> <type>COMPOSITE</type> <target>para</target> <flatten>true</flatten> <wrapelement>div</wrapelement> </ditaelement>
note note NOTE Per impostazione predefinita, la proprietà del nodo appiattito è stata configurata nell'elemento p
. -
Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione.
-
Nel file di configurazione, fornisci i seguenti dettagli di (property):
table 0-row-3 1-row-3 PID Chiave proprietà Valore proprietà com.adobe.dxml.flattening.FlatteningConfigurationService
flattening.enabled
Booleano (true/false).
Valore predefinito:false
Ora, quando si genera l'output del sito AEM, i nodi all'interno dell'elemento p
vengono appiattiti e memorizzati all'interno dell'elemento p
stesso. Le nuove proprietà di conversione per l'elemento p
sono disponibili in CRXDE.
Cerca una stringa all'interno del contenuto nell'output del sito AEM
Per impostazione predefinita, è possibile cercare una stringa nei titoli solo all’interno dell’output del sito AEM. Puoi configurare il sistema in modo da cercare una stringa sia nei titoli che nel contenuto o nel corpo dell’output del sito AEM.
Per abilitare la ricerca, devi configurare l’appiattimento della struttura dei nodi del sito AEM.
ATTENZIONE:
È possibile cercare fino a 1 MB di contenuto appiattito. Ad esempio, nella schermata precedente, puoi cercare se il contenuto sotto il tag <p> è <= 1Mb.
<flatten>
è impostato su true. Per impostazione predefinita, in AEM Guides l'attributo <flatten>
è impostato su true per gli elementi di testo comunemente utilizzati, ad esempio <p> <ul> <lI>. Tuttavia, se sono stati creati alcuni elementi personalizzati, è necessario impostare l'attributo <flatten>
su true nel file elementmapping.xml.Impedisci appiattimento della struttura del nodo del sito AEM
Simile a specificare il nodo da appiattire nell'output del sito AEM, puoi anche specificare un elemento che desideri escludere da questa configurazione. Ad esempio, se si desidera appiattire i nodi in corrispondenza dell'elemento body
, ma non si desidera appiattire alcun elemento table
in body
, è possibile aggiungere la proprietà exclude all'interno della definizione dell'elemento table
.
Per escludere l'elemento table
dall'appiattimento, aggiungere la seguente proprietà alla definizione dell'elemento table
:
<preventancestorflattening>true|false</preventancestorflattening>
Configurare il controllo delle versioni per le pagine eliminate nell’output del sito AEM
Quando si genera l'output del sito AEM con l'opzione Elimina e Crea selezionata per l'impostazione Pagine di output esistenti, viene creata una versione per le pagine\ da eliminare. Puoi configurare il sistema in modo da interrompere la creazione di una versione prima dell’eliminazione.
Per interrompere la creazione di una versione per le pagine da eliminare, effettua le seguenti operazioni:
-
Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione.
-
Nel file di configurazione, fornisci i seguenti dettagli di (property) per configurare l'opzione Do Not Create Version for Deleted Pages:
table 0-row-3 1-row-3 PID Chiave proprietà Valore proprietà com.adobe.fmdita.confi g.ConfigManager
no.version.creation.on.deletion
Booleano (true/false).
Valore predefinito:true
note note NOTE Selezionando questa opzione, gli utenti potranno eliminare direttamente le pagine senza creare alcuna versione. Se l'opzione non è selezionata, viene creata una versione prima che le pagine(s) vengano eliminate.
Configurare il rewriter personalizzato con Experience Manager Guides custom-rewriter
Experience Manager Guides dispone di un modulo rewriter Sling personalizzato per la gestione dei collegamenti generati in caso di mappe incrociate (collegamenti tra gli argomenti di due mappe diverse). La configurazione del rewriter è installata nel percorso seguente:/apps/fmdita/config/rewriter/fmdita-crossmap-link-patcher
.
Se nel codebase è presente un altro rewriter sling personalizzato, utilizza un valore 'order'
maggiore di 50, in quanto il rewriter sling di Experience Manager Guides utilizza 'order'
50. Per evitare questo problema, è necessario un valore >50. Per ulteriori dettagli, visualizza Pipeline di riscrittura output.
Utilizzare i metadati nell'output di pubblicazione tramite DITA-OT id191LF0U0TY4
AEM Guides consente di trasmettere metadati personalizzati durante la pubblicazione dell'output tramite DITA-OT. In qualità di amministratore e di editore, è necessario eseguire le seguenti attività per configurare e utilizzare metadati personalizzati nell’output pubblicato:
-
In qualità di amministratore, aggiungere i metadati richiesti nel sistema in modo che siano disponibili nella pagina Proprietà della mappa DITA.
-
In qualità di amministratore, aggiungi i metadati personalizzati nell'elenco dei metadati in modo che vengano visualizzati nella console delle mappe DITA.
-
In qualità di editore, configura e aggiungi i metadati personalizzati con la mappa DITA e genera l’output richiesto.
Per aggiungere i metadati richiesti nel sistema, effettuare le seguenti operazioni:
-
Accedi a Adobe Experience Manager come amministratore.
-
Fai clic sul collegamento Adobe Experience Manager in alto e scegli Strumenti.
-
Seleziona Assets dall'elenco degli strumenti.
-
Fai clic sul riquadro Schemi metadati.
Viene visualizzata la pagina Forms schema metadati.
-
Selezionare il modulo default dall'elenco.
note note NOTE Le proprietà visualizzate nella pagina Proprietà di una mappa DITA vengono ricavate da questo modulo. -
Fai clic su Modifica.
-
Aggiungi i metadati personalizzati che desideri utilizzare negli output pubblicati. Ad esempio, aggiungeremo i metadati del pubblico come segue:
-
Dall'elenco dei componenti Genera modulo, trascinare il componente Testo a riga singola nel modulo.
-
Seleziona il nuovo campo per aprire Impostazioni del campo.
-
In Etichetta campo, immettere il nome metadati: Pubblico.
-
Nell'impostazione Mappa su proprietà, specificare ./jcr:content/metadata/<nome dei metadati>. Per il nostro esempio, lo imposteremo su ./jcr:content/metadata/audience.
Utilizzando questi passaggi, aggiungi tutti i parametri di metadati richiesti.
-
-
Fai clic su Salva.
Il nuovo parametro ora viene visualizzato nella pagina Proprietà per tutte le mappe DITA.
Successivamente, è necessario rendere disponibili i metadati personalizzati nella console delle mappe DITA. Per rendere disponibili i metadati personalizzati sulla dashboard delle mappe DITA, effettuare le seguenti operazioni:
-
Utilizza Gestione pacchetti per accedere al file metadataList disponibile nella seguente posizione nell’archivio Git di Cloud Manager:
/libs/fmdita/config/metadataList
note note NOTE Il file metadataList contiene un elenco di proprietà visualizzate nell'elenco a discesa Proprietà di una mappa DITA nel dashboard delle mappe. Per impostazione predefinita, in questo file sono elencate quattro proprietà: docstate, dc:language, dc:description e dc:title. -
Aggiungi i metadati personalizzati aggiunti nella pagina Forms dello schema metadati. Nel nostro esempio, aggiungi il parametro audience alla fine dell’elenco predefinito.
Ora i metadati personalizzati verranno visualizzati nell'elenco a discesa Proprietà della console delle mappe DITA.
Infine, in qualità di editore, è necessario includere i metadati personalizzati nell’output pubblicato. Per elaborare i metadati personalizzati durante la generazione dell’output, effettua le seguenti operazioni:
-
Nell'interfaccia utente di Assets, passare alla mappa DITA che si desidera pubblicare.
-
Selezionare il file mappa DITA e aprirne la pagina delle proprietà.
-
Nella pagina Proprietà, specifica il valore per i metadati personalizzati. Per il nostro esempio, abbiamo specificato il valore External per il parametro audience.
-
Fai clic su Salva e chiudi.
-
Fare clic sul file mappa DITA per aprire la console Mappa DITA.
-
Nella scheda Predefiniti di output selezionare il predefinito di output che si desidera utilizzare per generare l'output.
-
Fai clic su Modifica.
-
Dall'elenco a discesa Proprietà, selezionare le proprietà che si desidera trasferire al processo di pubblicazione.
Le proprietà/metadati selezionati vengono trasmessi al processo di pubblicazione e sono resi disponibili nell’output finale.
Convalida metadati passati a DITA-OT per l'elaborazione
Per convalidare i valori dei metadati passati al DITA-OT, è possibile utilizzare un ambiente locale che utilizza un file jar pronto per il cloud. Poiché non è possibile accedere al file system locale sul cloud, l’unico modo per convalidare il file dei metadati è tramite cloud ready jar.
-
Nome file: metadata.xml
-
Posizione file: crx-quickstart/profiles/ditamaps/<ditamap-1234>
Per accedere a metadata.xml:
- Accedi al percorso del server in cui è in esecuzione l’istanza AEM.
- Esegui la migrazione a crx-quickstart/profiles/ditamaps/<nome-directory-appena creato>/metadata.xml.
-
Formato file di esempio:
metadati.xml
code language-xml <?xml version="1.0" encoding="UTF-8" standalone="no"?> <root> <Path id="/absolutePath/sampleMap.ditamap"> <metadata> <meta isArray="false" key="dc:description">This is a file</meta> <meta isArray="false" key="dc:title">Myfile</meta> <meta isArray="true" key="multivalueText">One;Two;Three</meta> </metadata> </Path> <Path id="/absolutePath/sampleTopic.dita"> <metadata> <meta isArray="false" key="dc:description">description for the accountability</meta> <meta isArray="false" key="dc:title">accountability title</meta> <meta isArray="true" key="multivalueText">value1</meta> </metadata> </Path> </root>
-
isArray: attributo booleano che definisce se i metadati sono un valore multiplo (Array) o meno. I valori sono delimitati da un punto e virgola.
-
ID percorso: percorso assoluto del file memorizzato nella directory temp.
Personalizzare la mappatura degli elementi DITA con i componenti AEM id1679J600HEL
Gli elementi DITA in AEM Guides sono mappati ai relativi componenti AEM corrispondenti. AEM Guides utilizza questa mappatura nei flussi di lavoro, ad esempio pubblicazione e revisione, per convertire l’elemento DITA in un componente AEM corrispondente. Il mapping è definito nel file elementmapping.xml
, a cui è possibile accedere tramite Gestione pacchetti.
libs
. È necessario creare una sovrapposizione del nodo libs
nel nodo apps
e aggiornare i file richiesti solo nel nodo apps
.È possibile utilizzare le mappature di elementi DITA predefinite oppure mappare gli elementi DITA ai componenti AEM personalizzati. Per utilizzare i componenti AEM personalizzati, è necessario comprendere la struttura del file elementmapping.xml
.
struttura elementmapping.xml
Di seguito viene illustrata una panoramica di alto livello della struttura elementmapping.xml
:
-
Per ogni elemento DITA viene innanzitutto eseguita la ricerca di una mappatura di componente corrispondente in base al nome dell'elemento. Ad esempio:
code language-xml <ditaelement> <name>**substeps**</name> <class>- topic/ol task/substeps</class> <componentpath>dita/components/ditaolist</componentpath> <type>COMPOSITE</type> <target>para</target> </ditaelement>
Nell'esempio precedente, tutti gli elementi DITA
substeps
vengono sottoposti a rendering utilizzando il componentedita/components/ditaolist
. -
Se un elemento DITA non trova una corrispondenza basata sul nome, viene eseguita una corrispondenza sulla base di
class
. Ad esempio:code language-xml <ditaelement> <name>topic</name> <class>**- topic/topic**</class> <componentpath>fmdita/components/dita/topic</componentpath> <type>COMPOSITE</type> <target>para</target> <attributemap> <attribute from="id" to="id" /> </attributemap> </ditaelement>
Nell'esempio precedente, se non è stata definita alcuna mappatura per l'elemento
task
, l'elementotask
viene mappato al componente precedente perchétask
è ereditato dal componentetopic
. -
Quando a un elemento corrisponde un mapping di componenti, l'ulteriore elaborazione degli elementi figlio è determinata da
type
. Ad esempio:code language-xml <ditaelement> <name>title</name> <class>- topic/title</class> <componentpath>foundation/components/title</componentpath> <type>**STANDALONE**</type> <target>para</target> <textprop>jcr:title</textprop> </ditaelement>
type
accetta i seguenti valori:-
COMPOSITE: la mappatura da elemento a componente continua anche per gli elementi figlio.
-
STANDALONE: gli elementi secondari dell'elemento corrente sono non mappati ulteriormente.
Nell'esempio precedente, se l'elemento
<title>
include elementi figlio, questi non verranno mappati ad alcun altro componente. Il componente per l'elemento<title>
è responsabile del rendering di tutti gli elementi figlio all'interno dell'elemento<title>
. -
-
Se sono presenti più componenti mappati a un singolo elemento DITA, viene selezionata la corrispondenza migliore per l’elemento. Per selezionare il componente di corrispondenza migliore, viene considerata la specializzazione del dominio e della struttura degli elementi DITA.
Se sono presenti elementi DITA con specializzazione di dominio e un componente è mappato per la specializzazione di dominio, a tale componente viene assegnata la priorità alta.
Analogamente, se esistono elementi DITA con specializzazione strutturale e un componente è mappato per la specializzazione strutturale, a tale componente viene assegnata la priorità alta.
-
È possibile utilizzare
<attributemap>
nella mappatura degli elementi per mappare i valori degli attributi alle proprietà corrispondenti del nodo. -
textprop
può essere utilizzato per serializzare il contenuto di testo di un elemento DITA in una proprietà nodo. Inoltre, può essere utilizzato più volte in un tag elemento per serializzare il contenuto di testo in più posizioni nella gerarchia pubblicata. Puoi anche personalizzare la posizione e il nome della proprietà target. Ad esempio:code language-xml <ditaelement> <name>title</name> <componentpath>foundation/components/title</componentpath> <type>STANDALONE</type> <target>para</target> <textprop>**jcr:title**</textprop> </ditaelement>
La mappatura dell'elemento precedente specifica che il contenuto di testo dell'elemento
<title>
verrà salvato come valore di una proprietà denominatajcr:title
nel nodo di output. -
xmlprop
può essere utilizzato per serializzare l'intero XML di un dato elemento a una proprietà del nodo. Il componente può quindi leggere questa proprietà del nodo ed eseguire il rendering personalizzato. Ad esempio:code language-xml <ditaelement> <name>svg-container</name> <class>+ topic/foreign svg-d/svg-container</class> <componentpath>fmdita/components/dita/svg</componentpath> <type>STANDALONE</type> <target>para</target> <xmlprop>**data**</xmlprop> </ditaelement>
Il mapping di elementi sopra riportato specifica che l'intero markup XML per l'elemento
<svg-container>
verrà salvato come valore di una proprietà denominatadata
nel nodo di output. -
Esiste uno speciale mapping di attributi per gestire la risoluzione del percorso nel processo di generazione dell'output. Ad esempio:
code language-xml <attributemap> <attribute from="href" to="fileReference" ispath="true" rel="source" /> <attribute from="height" to="height" /> <attribute from="width" to="width" /> </attributemap>
Per
attributemap
, l'attributohref
nell'elemento DITA verrà mappato a una proprietà nodo denominatafileReference
. Poichéispath
è impostato sutrue
, il processo di generazione dell'output risolve questo percorso e lo imposta nella proprietà del nodofileReference
.La modalità di risoluzione viene determinata in base al valore dell'attributo
rel
nella mappatura degli attributi.-
Se
rel=source
, il valore dihref
viene risolto rispetto al file di origine DITA in fase di elaborazione. Il valore dihref
è risolto e posizionato nel valore della proprietàfileReference
. -
Se
rel=target
, il valore dihref
viene risolto rispetto al percorso di pubblicazione principale. Il valore dihref
è risolto e posizionato nel valore della proprietàfileReference
.
Se non desideri che si verifichi alcuna pre-elaborazione o risoluzione sugli attributi del percorso, non è necessario specificare l'attributo
ispath
. Il valore viene copiato così come è e il componente può eseguire la risoluzione richiesta. -
Schema elemento DITA
Di seguito è riportato un esempio dello schema dell'elemento DITA nel file elementmapping.xml
:
<ditaelement>
<name>element_name</name>
<class>element_class</class>
<componentpath>fmdita/components/dita/component_name</componentpath>
<type>COMPOSITE|STANDALONE</type>
<attributeprop>propname_a</attributeprop>
<textprop>propname_t</textprop>
<xmlprop>propname_x</xmlprop>
<xpath>xpath expression string</xpath>
<target>head|para</target>
<wrapelement>div</wrapelement>
<wrapclass>class_name</wrapclass>
<attributemap>
<attribute from="attrname" to="propname" ispath="true|false" rel="source|target" />
</attributemap>
<skip>true|false</skip>
</ditaelement>
Nella tabella seguente vengono descritti gli elementi dello schema di elementi DITA:
<ditaelement>
<class>
Ad esempio, l'attributo di classe per l'argomento DITA è:
- topic/topic
<componentpath>
<type>
- COMPOSITO: Elabora anche elementi figlio
- STANDALONE: ignora l'elaborazione degli elementi figlio
<attributeprop>
<note type="Caution">
e il componente mappato per questo elemento ha <attributeprop>attr_t</ attributeprop>
, l'attributo e il valore del nodo vengono serializzati nella proprietà attr_t
del nodo AEM corrispondente ( attr_t->type="caution"
).<textprop>propname_t</textprop>
getTextContent()
nella proprietà definita da propname_t.
Nota: questa è una proprietà ottimizzata.
<xmlprop>propname_x </xmlprop>
propname_x.<br>
Nota: Si tratta di una proprietà ottimizzata.<xpath>
<target>
Valori possibili:
- head: Sotto il nodo head
- text: Sotto il nodo paragrafo
<wrapelement>
<wrapclass>
wrapclass.
<attributemap>
<attribute>
.Note aggiuntive
-
Se si prevede di ignorare la mappatura degli elementi predefinita, è consigliabile non apportare le modifiche nel file
elementmapping.xml
predefinito. Devi creare un nuovo file XML di mappatura e posizionarlo in un’altra posizione, preferibilmente all’interno della cartella delle app personalizzate che crei. -
Nel file
elementmapping.xml
sono presenti molte voci di mapping che fanno riferimento al componente fmdita/components/dita/wrapper. Wrapper è un componente generico che esegue il rendering di costrutti DITA relativamente semplici utilizzando le proprietà sul nodo del sito per generare HTML rilevanti. Utilizza la proprietàwrapelement
per generare tag di inclusione e delega il rendering secondario ai componenti corrispondenti. Ciò è utile nei casi in cui desideri solo un componente contenitore. Invece di creare un nuovo componente che esegue il rendering di un tag contenitore specifico comediv
op
, è possibile utilizzare il componente Wrapper con le proprietàwrapelement
ewrapclass
per ottenere lo stesso effetto. -
Si sconsiglia di salvare grandi quantità di testo nelle proprietà String JCR. Il calcolo del tipo di proprietà ottimizzato nella generazione dell’output assicura che il contenuto di testo di grandi dimensioni non venga salvato come tipo di stringa. Quando invece è necessario salvare un contenuto superiore a una determinata soglia, il tipo della proprietà viene modificato in binario. Per impostazione predefinita, questa soglia è configurata a 512 byte, ma può essere modificata in Configuration Manager (com.adobe.fmdita.config.ConfigManager) modificando l'impostazione Salva come soglia binaria.
-
Se si prevede di ignorare alcuni (e non tutti) dei mapping degli elementi, non è necessario replicare l'intero file
elementmapping.xml
. È necessario creare un nuovo file di mapping XML e definire solo gli elementi sovrascritti. -
Dopo aver creato il file XML nel percorso personalizzato, aggiornare l'impostazione
Override Element Mapping
nel bundlecom.adobe.fmdita.config.ConfigManager
.
Personalizza console mappe DITA id188HC08M0CZ
AEM Guides offre la flessibilità di estendere le funzionalità della console delle mappe DITA. Ad esempio, se disponi di un set di rapporti diversi da quelli disponibili in AEM Guides, puoi aggiungerli alla console delle mappe. Per personalizzare la console delle mappe, devi creare una libreria client AEM (o ClientLib) che conterrà il codice necessario per eseguire la funzionalità necessaria.
AEM Guides fornisce la categoria apps.fmdita.dashboard-extn
per personalizzare la console delle mappe. Ogni volta che la console delle mappe viene caricata, la funzionalità creata nella categoria apps.fmdita.dashboard-extn
viene eseguita e caricata.
Gestione della rappresentazione delle immagini durante la generazione dell'output id177BF0G0VY4
L’AEM viene fornito con una serie di flussi di lavoro e di handle di file multimediali predefiniti per l’elaborazione delle risorse. In AEM, esistono flussi di lavoro predefiniti per gestire l’elaborazione delle risorse per i tipi MIME più comuni. In genere, per ogni immagine caricata, AEM crea più rappresentazioni dello stesso in formato binario. Queste rappresentazioni possono avere dimensioni diverse, una risoluzione diversa, una filigrana aggiunta o altre caratteristiche modificate. Per ulteriori informazioni sulla gestione delle risorse da parte dell'AEM, consulta Elaborazione di Assets tramite gestori di supporti e flussi di lavoro nella documentazione AEM.
AEM Guides consente di configurare la rappresentazione dell’immagine da utilizzare al momento della generazione dell’output per i documenti. Ad esempio, puoi scegliere una delle rappresentazioni immagine predefinite oppure crearne una e utilizzare la stessa opzione per pubblicare i documenti. Il mapping della rappresentazione dell'immagine per la pubblicazione dei documenti è memorizzato nel file /libs/fmdita/config/ **renditionmap.xml**
. Uno snippet di file renditionmap.xml
è il seguente:
renditionmap.xml
nella cartella apps
per tutte le personalizzazioni.<renditionmap>
<mapelement>
<mimetype>image/png</mimetype>
<rendition output="AEMSITE">cq5dam.web.1280.1280.jpeg</rendition>
<rendition output="PDF">original</rendition>
<rendition output="HTML5">cq5dam.web.1280.1280.jpeg</rendition>
<rendition output="EPUB">cq5dam.web.1280.1280.jpeg</rendition>
<rendition output="CUSTOM">cq5dam.web.1280.1280.jpeg</rendition>
</mapelement>
...
</renditionmap>
L'elemento mimetype
specifica il tipo MIME del formato di file. L'elemento rendition output
specifica il tipo di formato di output e il nome della rappresentazione (ad esempio, cq5dam.web.1280.1280.jpeg
) da utilizzare per la pubblicazione dell'output specificato. Puoi specificare le rappresentazioni di immagini da utilizzare per tutti i formati di output supportati: AEMSITE, PDF, HTML5, EPUB e CUSTOM.
Se la rappresentazione specificata non è presente, il processo di pubblicazione di AEM Guides cerca innanzitutto la rappresentazione web dell’immagine specificata. Se non viene trovata nemmeno la rappresentazione web, viene utilizzata la rappresentazione originale dell’immagine.
Configurare il periodo di rimozione automatica per la cronologia di output id19AAI070V8Q
Quando generi un output, questo viene creato insieme ai registri di output. Per le mappe DITA di grandi dimensioni, questi registri possono occupare una grande quantità di spazio nell’archivio. Per impostazione predefinita, i registri vengono memorizzati nella seguente posizione nell’archivio:
/var/dxml/metadata/outputHistory
In un certo periodo di tempo, le dimensioni collettive di tutti i file di registro potevano raggiungere i GB. AEM Guides consente di configurare un periodo di tempo per mantenere questi file di registro nell’archivio. Dopo il periodo di tempo specificato, i registri e la cronologia di generazione dell’output vengono eliminati dall’archivio.
La configurazione della funzione di rimozione della cronologia influisce sulla generazione dell'output per tutte le mappe DITA nel repository. Nella scheda Output di una mappa DITA, la cronologia viene eliminata dopo il numero di giorni e all'ora specificati nell'impostazione.
Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione. Nel file di configurazione, fornisci i seguenti dettagli (property) per impostare un giorno e un’ora per eliminare la cronologia e i registri di output:
com.adobe.fmdita.config.ConfigManager
output.history.purgeperiod
Valore predefinito: 5
output.history.purgetime
Valore predefinito: 0:00 (o 12:00 mezzanotte)
Modifica il limite dell’elenco di output generato di recente id1679JH0H0O2
È possibile modificare il numero massimo di output generati visualizzati nella scheda Output per una mappa DITA.
Utilizza le istruzioni fornite in Sostituzioni configurazione per creare il file di configurazione. Nel file di configurazione, fornisci i seguenti dettagli (property) per modificare il numero di output da visualizzare nell’elenco:
com.adobe.fmdita.config.ConfigManager
output.historylimit
Valore predefinito: 25