xdamsItem

[xdamsItem type=’archive ID’ ] xdams item id [/xdamsItem]

questo shortcode pubblica una scheda specifica in base ai campi definiti nel “setting”. La pubblicazione di default utilizza il template standard ma come detto possono essere definiti template personalizzati.

Nel caso di schede che prevedano la presenza di immagini di preview questa viene pubblicata. Se la scheda include anche file da visualizzare (es .pdf) la lista dei download è presente in basso.

Analogamente nel caso di scheda audiovideo se presente un link a versione su YouTube è in grado di incorporare automaticamente il player

WPxdamsBridge_getCurrentArchiveDesc()

La funzione WPxdamsBridge_getCurrentArchiveDesc() restituisce la stringa di descrizione dell’archivio corrente.

es. $archiveName= WPxdamsBridge_getCurrentArchiveDesc() ;

 

WPxdamsBridge_getCurrentArchiveDesc() is in WPxdamsBridge_publicAPI.php

Configurazione Multilingua

Con questa vice di menu è possibile gestire la pubblicazione multilingua degli archivi.

Esistono due tipologie di pagine per definire:

  • traduzione personalizzata dei messaggi di sistema (general terms)
  • traduzione personalizzata delle label dei i campi di output e ricerca

il tasto “add language” consente di aggiungere la traduzione in nuove lingue, questa opzione è disponibile solo nell’opzione general terms.

Per ogni archivio è disponibile la traduzione delle stringhe. Nel caso una lingua non fosse prevista il sistema proporrà i termini del main language.

I termini tradotti vengono memorizzati in file di configurazione conservati nella sottodirectory “languages” della directory “_custom”.

nota bene: la traduzione dei messaggi di sistema fa riferimento all’id del messaggio, pertanto cambiandone la label nella lingua principale non si verificano problemi di alcun genere. Nel caso dei campi di ricerca e di output la lista dei termini da tradurre viene ricavata dall’insieme di label personalizzate, per esempio il xpath/title può avere label “titolo” o “titolo del libro” a seconda del tipo di scheda, oppure può essere il medesimo.

Per questo motivo si è scelto di tradurre direttamente le label, ciò significa che cambiando una di queste, per esempio da “titolo” a “titolo proprio” dovrò aggiornare conseguentemente la traduzione.

Work around language

Al momento il sistema non consente di leggere file già esistenti per linguaggi non ancora inizializzati pertanto l’azione “add language” produce la visualizzazione di una colonna vuota e l’eventuale sovrascrizione di file esistenti al salvataggio. Si consiglia pertanto in situazioni del genere (per esempio da una istanza di test alla produzione) di creare un nuovo file per il linguaggio desiderato e poi sovrapporre i file già generati nell’altra istanza.

xdamsSearch

[xdamsSearch type=’archive ID’ ][/xdamsSearch]

Attiva una form di ricerca a testo libero, nel type potrà essere inserito o l’ID di uno specifico archivio o il valore convenzionale “@all” che consentirà la ricerca su tutti gli archivi.

Tra tag iniziale e tag finale può essere inserita una o una serie di condizioni aggiuntive rispetto al testo da cercare, questa opzione può risultare particolarmente utile se si desidera limitare l’esito della ricerca ai soli oggetti dell’archivio come nell’esempio che segue:

[xdamsSearch type=’storico’ form=’full’]/c/@level=item OR /c/@level=file[/xdamsSearch]

Questa condizione è posta in AND con il testo da cercare per cui occorre fare attenzione a come descrivere l’opzione stessa. Per evitare poco comprensibili effetti derivanti dalla differente priorità tra gli operatori logici al momento sono gestite solo condizioni uguali (tutti AND oppure tutti OR).

Sono previsti i seguenti parametri

listtemplate per definire quale template di pubblicazione (da predisporsi a cura dell’utente e posizionato nella directory “custom”) utilizzare per la pubblicazione dei risultati

formtemplate per definire quale template di pubblicazione (da predisporsi a cura dell’utente e posizionato nella directory “custom”) utilizzare per la pubblicazione del box di ricerca

form per descrivere il risultato atteso nella pubblicazione accetta tre valori

  • basic= inizialmente solo box di ricerca e successivamente risultati e box di ricerca
  • full= box di ricerca e risultati insieme sempre
  • mixed = inizialmente solo box di ricerca e successivamente solo risultati

NOVITA’ VERSIONE 2.2

Sono stati aggiunti diversi attributi che consentono il miglioramento delle funzionalità

redirect

= consente di definire una URL di una pagina differente in cui visualizzare l’elenco risultati

redirectitem 

= consente di definire una URL di una pagina differente in cui visualizzare la scheda

boxdim

= definisce l’eventuale larghezza del box di ricerca

formtemplate

= definisce un template da utilizzare il form di ricerca (nel folder wpxdamsbridge_custom)

formdescpost 

= consente di utilizzare un testo da inserire nel form prima delle chiusura del layout personalizzato

showarchives

= yes se si desidera che nella ricerca multilista oltre all’archivio corrente siano visualizzati anche gli altri archivi che contengono risultati

menutemplate

definisce un template per il menu (elenco) degli archivi personalizzato (funziona solo se showarchives=yes)

itemdescpre itemdescpos listdespre listdescpos

= attributi per aggiungere un testo prima e dopo la la lista e prima e dopo ciascun elemento della lista

showlist

= yes se si desidera che oltre all’elenco generica dei risultati venga pubblicata la lista dei risultati del primo archivio

 

xdamsImage

[xdamsImage type=’archive ID’ ] xdams item id [/xdamsImage]

pubblica l’immagine allegata a una scheda specifica

per pubblicare un’immagine occorre indicare l’identificativo dell’archivio in type e il codice identificativo della scheda tra lo shortcode di apertura e quello di chiusura.

Import ed Export (setting preferences)

Import settings

Questa funzionalità permette di creare un file di tipo json contenente le informazioni che sono state memorizzate sul DB mediante le pagine di configurazione, ovvero le label dei campi, gli indirizzi per le richieste rest, storie ecc.

Al momento il file denominato savedsettings.json viene allocato in:

Directory dei plugin/WPxdamsBridge/WPxdams_config

Scopo principale di questa funzione è il back up dei dati e la migrazione da un’installazione di test a una di produzione o viceversa.

Export settings

Questa funzione è speculare alla precedente e consente di importare sul DB i dati contenuti nel file savedsettings.json precedentemente descritto e posizionato nella directory citata al paragrafo precedente

Import (archives configurations)

Una volta arrivati nella pagina specifica ci si trova di fronte all’elenco degli archivi che si possono aggiornare,  cliccando sul flag di selezione si indica quali archivi saranno importati o re-importati al comando di import.

L’attivazione del comando determinerà la ricopertura di ogni dato già salvato nel DB con i dati presenti nei file pertanto occorre essere perfettamente sicuri di volere importare un archivio.

La prima importazione non creerà ovviamene problemi ma una importazione, successiva alla prima, di archivi già gestiti determinerà la perdita dei dati preesistenti relativamente ai campi di ricerca e visualizzazione.

Import ed Export (introduzione)

Le funzionalità attivabili da questa voce di menù sono tre:

  • Importazione, anche selettiva, di archivi dai file di configurazione pubblicati insieme al plugin
  • Esportazione di tutte le preferenze salvate dall’utente in un file di tipo json
  • Importazione da file delle preferenze salvate come descritto al punto precedente

I file di configurazione si intendono i file pubblicati con il plugin e che descrivono la struttura degli archivi. Il plugin propone alcune configurazioni ionizialai che possono essere modificate dall’utente.

Per una più dettagliata descrizione di questi file si consiglia la lettura del manuale avanzato ma nel paragrafo che segue ne anticipiamo una breve introduzione

La conoscenza dei dettagli relativi a questi file non è necessaria al corretto funzionamento ma l’obiettivo di questa breve introduzione è di dare una prima overview dello schema dei dati che possono essere importati. Tali file sono al momento predefiniti per gli archivi che utilizzano la modalità standard offerta dall’hosting erogato da regesta. I file si trovano bella cartella:

Directory dei plugin/WPxdamsBridge/WPxdams_config

Il file principale è il file archive.json che elenca gli archivi e delle tipologie di schede che si possono gestire.  Correlati a questo ci sono, nella medesima directory, un file specifico per ogni archivio (sempre .json), utilizzati per descrivere le opzioni dei form di ricerca

Per ogni tipo di scheda infine esistono ulteriori opzioni di configurazione specificate in ulteriori file XML

Configurare la visualizzazione delle schede (output fields)

———————————————————————————————————–

NEWS FROM 2.2 VERSION 

Sono state introdotte:

la possibilità di pubblicare i valori di un campo con attributo  di uno specifico.

Sintassi: nome campo[nome attributo=valore da ricercare]

il campo ‘separator’ che introduce un testo solo tra due occorrenze dello stesso campo

———————————————————————————————————-

Per ognuna delle schede disponibili di uno specifico archivio (operazione possibile a partire inizialmente dai file di configurazione di ogni tipologia di scheda) è possibile descrivere quali campi mostrare e con quali label.

In fase di avvio del progetto si può richiamare ogni singola scheda e salvare la configurazione personalizzata. La funzione di import a partire dalla versione 1.1 salva la configurazione di default sul DB già in fase di prima attivazione e da qui la configurazione può essere gestita poi nel plugin.

Si può invertire l’ordine dei campo mediante drag and drop.

E’ possibile modificare

  • il nome del campo da file di configurazione

Attenzione questa  è la stringa che viene utilizzata per identificare il dato nel file di risposta delle API  rest e pertanto deve corrispondere al path (o parte di esso se non ci sono ambiguità) utilizzato per descrivere il dato medesimo:

Altri campi utilizzabili per la personalizzazione:

  • la casella di input per definire la propria label personalizzata
  • il flag per pubblicare o meno il campo.
  • Il flag per cancellare il campo
  • il flag per pulire un campo da eventuale html incluso (tag e testo incluso tra i tag)
  • 4 campi di testo il cui contenuto viene inserito prima e dopo il titolo e il valore assunto dal campo.

Questi 4 campi servono a personalizzare la visualizzazione delle liste senza alcun intervento di programmazione infatti possono contenere semplice testo (es. punteggiatura) o comandi HTML (es. <br> per a capo, <strong> e </strong> per il grassetto o <em> e </em> per il corsivo).

Per i più esperti è possibile anche definire una classe la cui descrizione includere poi in un file CSS.

Viene pubblicata anche

  • l’informazione se è un gruppo di campi
  • l’informazione se prevede un attributo
  • la label originale del file di configurazione

Nel caso si importi un nuovo file di configurazione occorre ripetere l’operazione e salvare. Nella stessa pagina è inoltre disponibile il pulsante “update and add” che consente di inserire un campo ex-novo direttamente da back office.

Per gestire più viste dei medesimi dati si può procedere come al punto “work around” del form di ricerca

Configurare più form di ricerca diversi (work around)

——— OBSOLETE ————————–

DALLA VERSIONE 2.2 E’ STATO INTRODOTTO UN ATTRIBUTO NEGLI SHORTCODE CHE PREVEDE FORM PERSONALIZZATI A LIVELLO DI OGNI SINGOLA PAGINA – VEDI FORMTEMPLATE

Al momento è possibile solo un form di ricerca per ogni archivio ma lo shortcode permette di creare form di ricerca con tutti i campi o solo con un campo specifico.

Nel caso si desideri creare una nuova vista del form di ricerca personalizzata è possibile definire un nuovo archivio virtuale, che insista sempre su un medesimo archivio reale, ma che consente di creare una maschera con dati diversi da quella già definita.

Ragionamento analogo può essere applicato nel caso della visualizzazione di dettaglio di una scheda, più archivi virtuali possono rendere possibile definire schemi di visualizzazione diversi in base a necessità diverse ma su medesimi archivi