Utilizzo della verifica di completezza con documenti DITA
Arbortext Editor estende la normale verifica di completezza per garantire una verifica di completezza avanzata per i documenti DITA. Quando si crea un documento DITA e si seleziona > o si fa clic sul pulsante della barra degli strumenti Verifica completezza, sul documento viene inizialmente eseguita una normale verifica di completezza. Una volta eseguita la normale verifica di completezza, Arbortext Editor esegue una verifica di completezza avanzata per controllare la presenza di problemi specifici per DITA. Gli eventuali problemi vengono riportati in Log di verifica di completezza. Se occorrono più di alcuni secondi per eseguire la verifica di completezza avanzata, viene visualizzato un indicatore di stato.
La normale verifica di completezza consente di controllare se sono presenti elementi che possono essere convalidati mediante il tipo di documento associato al documento. La verifica di completezza avanzata consente di controllare gli elementi descritti nello standard DITA, ma non possono essere convalidati in base allo schema DTD o XML. Ad esempio, la verifica di completezza avanzata consente di controllare file mancanti, formati URL non corretti o inusuali,, valori di attributi format e type inusuali, utilizzo di elementi o attributi obsoleti e così via.
È possibile eseguire una verifica di completezza avanzata su un argomento o una mappa DITA. Per un argomento DITA, la verifica di completezza avanzata viene eseguita solo sull'argomento. Per una mappa DITA, la verifica di completezza avanzata viene eseguita non solo sulla mappa ma anche su qualsiasi altra mappa o argomento DITA referenziato dalla mappa, a seconda dell'impostazione della preferenza avanzata ditacheckreferences. Nella verifica di completezza avanzata è anche incluso il contenuto DITA referenziato dalle mappe DITA che vengono referenziate dalla mappa originale. È inoltre possibile selezionare parte di una mappa DITA e configurare la funzione di verifica di completezza avanzata in modo che venga eseguita solo sulla parte della mappa selezionata. In questo caso, la normale verifica di completezza viene eseguita sull'intera mappa, mentre la verifica di completezza avanzata viene eseguita solo sulla parte selezionata della mappa.
Quando la verifica di completezza avanzata viene avviata, viene visualizzato il messaggio Verifica di completezza avanzata avviata … nell'area dei messaggi nella parte inferiore della finestra di Arbortext Editor. Man mano che la verifica avanza, questo messaggio indica lo stato della verifica di completezza avanzata. Una volta completata la verifica, viene visualizzato il messaggio Verifica di completezza avanzata completata: nessun errore/avvertenza o Verifica di completezza avanzata completata: vedere la finestra dei messaggi per i dettagli. Nel secondo caso, viene visualizzata la finestra Log di verifica di completezza, in cui vengono elencati tutti gli errori o le avvertenze DITA rilevate nel documento. Ciascun errore o avvertenza include un link dopo il messaggio associato. Se si fa doppio clic sul link, il cursore viene spostato sulla posizione all'interno del documento associato in cui è stato rilevato l'errore o l'avvertenza. Se l'errore o l'avvertenza è relativa a un documento referenziato da una mappa DITA, tale documento viene aperto in una nuova finestra di Arbortext Editor.
La funzione Verifica di completezza avanzata controlla le categorie di problemi DITA riportati di seguito.
• Problemi relativi al markup DITA - Problemi quali utilizzo di markup obsoleti, valori di attributi non validi non controllati dal tipo di documento, utilizzo di tag progettati per la specializzazione e così via.
• Problemi relativi ai riferimenti DITA - Problemi quali valori di attributo href non validi, valori di attributo format e type non standard e non corretti e così via.
I valori rispetto ai quali viene controllato l'attributo format sono determinati dall'impostazione della preferenza avanzata ditaexpectedformats.
• Problemi relativi alle chiavi DITA e ai riferimenti chiave - Problemi relativi a chiavi e a riferimenti a chiave, come riferimenti a chiave non definiti, nomi di definizioni di chiavi non validi e problemi di risoluzione dei riferimenti conkeyref.
La finestra Log di verifica di completezza include due menu e un menu di scelta rapida.
Il menu File presenta le opzioni riportate di seguito:
• Salva - Salva il contenuto della finestra messaggi in un file .xml. Al primo salvataggio da quando è visualizzata la finestra, viene richiesto di selezionare un nome file di output.
• Salva con nome - Salva il contenuto in un output con un altro nome.
• Salva come HTML - Salva il contenuto in un file .htm.
• Stampa - Stampa una versione pubblicata della finestra messaggi. Questa stampa mostra le informazioni impostate attualmente per la visualizzazione nel menu Visualizza.
• Chiudi - Chiude la finestra messaggi.
Il menu Visualizza presenta le opzioni seguenti:
• Visualizza - Stabilisce il tipo di contenuto da visualizzare nella finestra messaggi:
◦ Messaggi - Visualizza tutte le informazioni (messaggi, avvertenze ed errori).
◦ Avvertenze - Visualizza solo le avvertenze e gli errori. Questa è l'impostazione di default.
◦ Errori - Visualizza solo gli errori.
• Dimensione carattere - Fornisce due opzioni per modificare la dimensione carattere nella finestra messaggi:
◦ Aumenta - Aumenta la dimensione del carattere di visualizzazione.
◦ Riduci - Riduce la dimensione carattere di visualizzazione.
Il menu di scelta rapida viene visualizzato quando si fa clic con il pulsante destro del mouse all'interno della finestra dei messaggi. Presenta le opzioni seguenti:
• Copia - Copia la regione selezionata negli Appunti. Questa opzione è disponibile solo quando si fa clic all'interno della regione selezionata.
• Segui link - Facendo doppio clic su un LINK nella finestra messaggi e selezionando questa opzione, il documento associato viene visualizzato con il cursore nella posizione appropriata all'interno del documento di origine. Questa opzione non ha alcun effetto se la finestra messaggi non contiene link.
• Comprimi/espandi - Comprime o espande la voce corrente.
La verifica di completezza avanzata presenta le seguenti limitazioni:
• Per una mappa DITA, la normale verifica di completezza viene eseguita solo sulla mappa e non viene eseguita su alcun argomento o mappa DITA referenziata dalla mappa originale.
• Gli argomenti DITA referenziati da altri argomenti non vengono inclusi nella verifica di completezza avanzata.
• Per le mappe DITA che contengono un numero elevato di riferimenti ad argomento, il completamento della verifica di completezza avanzata potrebbe richiedere più tempo rispetto alla normale verifica di completezza.