Piano di lavoro documentazione
Questa funzione permette di visualizzare l'avanzamento di una traduzione. I parametri LANTRA e LANREF permettono di prealimentare la lingua di traduzione e la lingua di riferimento.
Permette anche di estrarre le documentazioni o gli help sui campi per effettuare le traduzioni con i software in grado di tradurre i file XML. L'estrazione si effettua di default in una directory xml creata, se non esistente, nella directory della documentazione definita dal parametro DIRDOC.
Prerequisiti
Riferirsi alla documentazione di Implementazione
Gestione videata
Questa funzione permette di visualizzare l'avanzamento della traduzione nella lingua di traduzione confrontata con una lingua di riferimento.
Permette di estrarre anche in formato XML le documentazioni e gli help sui campi che sono da tradurre.
La funzione è costituita da tre folder:
- il primo presenta l'avanzamento della traduzione ed è caricato utilizzando il bottone
- il secondo permette di effettuare una ricerca delle documentazioni la cui traduzione non è aggiornata usando il bottone. La ricerca può essere limitata per tipo, codice o tranche di codici. Successivamente è possibile elaborare le documentazioni singolarmente col tasto destro oppure insieme.
- il terzo permette di fare una ricerca degli help sui campi la cui traduzione non è aggiornata indicando i criteri ed usando il bottone. La ricerca può essere limitata per codice o tranche di codici. Successivamente è possibile elaborare gli help sui campi singolarmente col tasto destro oppure insieme.
Testata
Presentazione
Permette di indicare la lingua di destinazione della traduzione e la lingua di riferimento.
Chiudi
Campi
I seguenti campi sono presenti in questo folder :
| Definisce la lingua di traduzione |
|
|
| Definisce la lingua di origine del testo da tradurre. |
Chiudi
Folder Avanzamento
Presentazione
Presenta ciò che è tradotto e ciò che rimane da tradurre per le documentazioni e gli help sui campi in maniera globale e dettagliata per tipo di documentazione.
Si noti che sono potenzialmente da tradurre solo le documentazioni interamente validate nella lingua di riferimento. La data di validità di una documentazione tradotta deve essere uguale a quella della lingua di riferimento altrimenti deve essere tradotta.
Per gli help sui campi, la data di creazione dell'help deve essere uguale alla data dell'ultima modifica nella lingua di riferimento altrimenti l'help è da tradurre.
E' il meccanismo di estrazione/import della documentazione che gestisce il passaggio dalla lingua di riferimento alla lingua di traduzione per i dati indicati precedentemente.
Chiudi
Campi
I seguenti campi sono presenti in questo folder :
Riquadro Ripartizione
| Presenta il numero di documentazioni e di help su campo tradotti e da tradurre. |
|
|
|
|
| Presenta il numero di documentazioni e di help su campo tradotti e da tradurre. |
|
|
|
|
Riepilogo
| Presenta il numero di documentazioni interamente validate ed il numero totale di documentazioni per la lingua di riferimento e la lingua di traduzione. |
|
|
|
|
|
|
| Presenta il numero totale di help su campo per la lingua di riferimento e la lingua di traduzione. |
|
|
|
|
|
|
Riquadro Dettaglio per tipo
| Il riquadro presenta per tipo di documentazione:
|
|
|
|
|
|
|
|
|
|
|
Chiudi
Funzioni accessibili tramite click destro sul riquadro
Documentazioni non validate
Presenta l'elenco delle documentazioni non validate
Documentazioni tradotte
Chiudi
Folder Documentazioni
Presentazione
Dopo aver ricercato le documentazioni da tradurre volute con l'aiuto dei criteri, è possibile elaborare:
- una sola documentazione con tasto destro
- tutte o una parte delle documentazioni selezionando le righe volute prima di attivare l'azione col il bottone in basso alla videata .
Per ulteriori spiegazioni sull'azione Elabora, vedere l'allegato Processo di traduzione di una documentazione.
Chiudi
Campi
I seguenti campi sono presenti in questo folder :
Criteri
| Permette di indicare come criterio di ricerca un tipo di documentazione oppure tutte. |
|
|
| Permette di indicare come criterio di ricerca un modulo oppure tutti. |
|
|
|
|
|
|
|
|
|
| Permette di indicare come criterio di ricerca un'intervallo di codici utilizzando i limiti di inizio e fine oppure tutti i codici. |
|
|
|
|
Riquadro Ricerca
| Permette di definire se la riga deve essere elaborata quando si lancia l'elaborazione premendo il bottone corrispondente. |
| Questo campo definisce il tipo della documentazione. Ogni tipo è associato ad un tipo di elementi documentati (documentazione funzionale, che descrive una scheda del dizionario o dei valori di parametrizzazione, che descrive la struttura del dizionario, diverse). Quando un tipo di documentazione corrisponde ad un codice oggetto, viene creata automaticamente una voce Documentazione nella barra di menù dell'oggetto in questione. Si può allora documentare le schede inserite nell'oggetto in questione. Ecco perché l'help funzionale è codificato AFC (codice dell'oggetto Funzioni), l'help sui parametri generali è codificato ADP(codice dell'oggetto Parametri)... Le regole per battezzare le documentazioni sono definite in una documentazione allegata. |
| Questo campo definisce il codice della documentazione. Corrisponde in principio al codice della scheda (funzione, parametro...) che si documenta. Le regole per chiamare le documentazioni sono definite in una documentazione allegata. |
| Questo campo è il titolo del paragrafo. Se è vuoto, viene attribuito un titolo di default iin funzione del tipo di paragrafo (sia in creazione che in modifica). Nel caso dei paragrafi diversi che non figurano nelle tabelle degli argomenti (di tipo MIN), il fatto di indicare il titolo con il solo carattere " ! "disattiva l'inserimento di un titolo. |
| Indica la data di validazione o di ultima modifica ritrovata sull'oggetto per la lingua di riferimento. |
| Indica la data di validazione o di ultima modifica ritrovata sull'oggetto per la lingua di traduzione scelta. |
| Indica se l'oggetto esiste già per la lingua di traduzione scelta. |
|
|
|
|
|
|
Chiudi
Funzioni accessibili tramite click destro sul riquadro
Azione deviazione STANDARD
Quando si ha un riquadro di inserimento di scelte multiple con una scelta di risposta Si / No su ogni riga, questa funzione permette di rispondere Si a tutte le righe a partire dalla riga corrente.
Azione deviazione STANDARD
Quando si ha un riquadro di inserimento di scelte multiple con una scelta di risposta Si / No su ogni riga, questa funzione permette di rispondere No a tutte le righe a partire dalla riga corrente.
Elabora documentazione
Lancia l'elaborazione per la riga corrente del riquadro. Ciò permette di ottenere il file XML che sarà utilizzato per effettuare la traduzione.
Occorrerà indicare una directory in cui saranno estratti i file XML. Di default, questa directory corrisponde alla sotto directory xmldella directory selezionata per memorizzare la documentazione estratta in formato HTML. I file dei capitoli di documentazioni sono estratti direttamente nella directory indicata e i file collegati ad una documentazione sono situati nella sotto-directory FILE della direcotory xml di estrazione.
Per ulteriori spiegazioni sull'azione Elabora, vedere l'allegato Processo di traduzione di una documentazione.
Chiudi
Folder Help sui campi
Presentazione
Dopo aver ricercato gli help sui campi da tradurre voluti con l'aiuto dei criteri, è possibile elaborare:
- un solo help con tasto destro
- tutti o una parte di help selezionando le righe volute prima di attivare l'azione tramite il bottone in basso alla videata .
Per ulteriori spiegazioni sull'azione Elabora, vedere l'allegato Processo di traduzione di una documentazione.
Chiudi
Campi
I seguenti campi sono presenti in questo folder :
Criteri
| Permette di indicare come criterio di ricerca un modulo oppure tutti. |
|
|
|
|
|
|
|
|
|
| Permette di indicare come criterio di ricerca un'intervallo di codici utilizzando i limiti di inizio e fine oppure tutti i codici. |
|
|
|
|
Riquadro Ricerca
| Permette di definire se la riga deve essere elaborata quando si lancia l'elaborazione premendo il bottone corrispondente. |
| Indica la parola chiave e quindi il riferimento dell'help su campo |
| Indica la data di validazione o di ultima modifica ritrovata sull'oggetto per la lingua di riferimento. |
| Indica la data di validazione o di ultima modifica ritrovata sull'oggetto per la lingua di traduzione scelta. |
| Indica se l'oggetto esiste già per la lingua di traduzione scelta. |
|
|
|
|
Chiudi
Funzioni accessibili tramite click destro sul riquadro
Azione deviazione STANDARD
Quando si ha un riquadro di inserimento di scelte multiple con una scelta di risposta Si / No su ogni riga, questa funzione permette di rispondere Si a tutte le righe a partire dalla riga corrente.
Azione deviazione STANDARD
Quando si ha un riquadro di inserimento di scelte multiple con una scelta di risposta Si / No su ogni riga, questa funzione permette di rispondere No a tutte le righe a partire dalla riga corrente.
Elabora help su campo
Lancia l'elaborazione per la riga corrente del riquadro. Ciò permette di ottenere il file XML che sarà utilizzato per effettuare la traduzione.
Occorrerà indicare una directory in cui saranno estratti i file XML. Di default, questa directory corrisponde alla sotto directory xmldella directory selezionata per memorizzare la documentazione estratta in formato HTML.I file di documentazione su campo sono situati nella sotto-directory FLD della directory xml di estrazione.
Per ulteriori spiegazioni sull'azione Elabora, vedere l'allegato Processo di traduzione di una documentazione.
Chiudi
Bottoni specifici
Questo bottone, accessibile anche con tasto funzionale , permette di effettuare il refresh del primo folder. |
Presenta in un nuovo riquadro ciò che è tradotto e ciò che resta da tradurre per le documentazioni per modulo e per tipo di documentazione. |
Questo bottone permette di caricare il riquadro del folder Documentazioni. Lancia la ricerca delle documentazioni che sono da tradurre secondo i criteri inseriti. |
Questo bottone permette di caricare il riquadro del folder Help sui campi. Lancia la ricerca degli help sui campi che sono da tradurre secondo i criteri inseriti. |
Allegato: Processo di traduzione di una documentazione
Preliminari
Attualmente, soltanto la documentazione su funzione dispone di una casella da contrassegnare Validata e di una data di validazione. Si parte dal principio che una documentazione debba essere Validata solo se considerata come terminata e se lo sono anche gli help sui campi che essa integra. Solo le documentazioni interamente validate vengono proposte nella traduzione.
In un flusso continuo di traduzione, le modifiche possono intervenire in un determinato momento e può rivelarsi necessaria una ri-traduzione. In questo caso, la documentazione deve essere rivalidata ad una nuova data e verrà di nuovo proposta nella traduzione.
Nella misura in cui una documentazione funzionale integra anche le documentazioni di help su campo, occorre tradurre simultaneamente le documentazioni sui campi integrati in questa documentazione funzionale.
Azione Elabora
Prima di poter estrarre una documentazione o un help su campo in vista di una traduzione, è necessario che la struttura della documentazione esista nella lingua di traduzione e corrisponda almeno a quella della documentazione di riferimento.
L'azione Elabora permette di effettuare tutte le fasi necessarie fino all'estrazione.
- Generazione: questa operazione creerà i paragrafi della documentazione per la lingua di traduzione, riprendendo i titoli dei folder, la descrizione della funzione e lasciando i paragrafi esplicativi (da tradurre) a blank. E' importante che tutti i testi della funzione siano stati tradotti in precedenza (riguarda ATEXTE e APLSTD) altrimenti non sarà possibile recuperare tutta la terminologia tradotta.
- Copia: La documentazione nella lingua di riferimento, che è stata generata dallo stesso processo di quello descritto qui in alto, ha subito modifiche nel corso della sua redazione. Prima di tutto, sono stati inseriti dei testi nei paragrafi (ma ciò fa giustamente parte degli elementi da tradurre); ma si può aver anche modificato la struttura dei paragrafi. Per riprendere queste modifiche, è necessario lanciare una funzione di copia della documentazione. E' importante notare che i testi dei paragrafi non vengono copiati; solo gli allegati, i paragrafi supplementari (senza il loro testo) le modifiche dei paragrafi in INC, i titoli dei nuovi paragrafi (MIS), la loro assegnazione del codice attività FAL sono trasferiti.
Gli help sui campi vengono creati e le loro caratteristiche vengono copiate in questa fase.
- Estrazione: Ogni documentazione e help su campo viene estratta in un file XML che potrà essere tradotto da un software in grado di tradurre i file XML. Occorrera indicare una directory in cui saranno estratti i file XML. Di default, questa directory corrisponde alla sotto directory xmldella directory selezionata per memorizzare la documentazione estratta in formato HTML.I file dei capitoli delle documentazioni sono estratti direttamente nella directory indicata ed i file collegati ad una documentazione sono situati nella sotto-directory FILE della directory xml di estrazione. I file di documentazione su campo sono situati nella sotto-directory FLD della directory xml di estrazione.
Integrazione dei file tradotti
Dopo la traduzione dei file tramite uno strumento esterno, è la funzione di integrazione di documentazione che permetterà di importare i file e di assegnare gli indici e le date di validità che permetteranno di constatare la validità della traduzione.
Osservazione importante
Ogni documentazione tradotta con questo procedimento non deve essere rivalidata a mano con una data diversa.
Cioè anche se la documetazione è ritoccata, non bisogna assegnargli una data di validazione diversa da quella assegnata dal processo di export/import.
Se è aggiunto un paragrafo (per esempio: un paragrafo MIS specifico della lingua di traduzione) nella documentazione tradotta, occorre rivalidare questa documentazione tradotta con la data assegnata dal processo di traduzione.
Se fosse assegnata un'altra data di validità, il controllo di validità di traduzione rispetto alla lingua di riferimento determinerebbe sempre la traduzione come non valida e proporrebbe sempre la documentazione per la traduzione.
Allegato: formato dei file creati
Il formato del file XML della documentazione su funzione o oggetto, così come si ritrova nella directory xml, è il seguente:
- una testata normalizzata xml,
- un tag DOC con gli attributi TYPE, NAME (che definiscono il tipo ed il codice della documentazione),
- all'interno del tag DOC, per ogni paragrafo, un tag PAR con gli attributi LAN, LEV, SUBLEV, PAR, MSK, STY, VLDDAT, VLDFLG, ACT, e MOD (che definiscono nell'ordine la lingua, il livello, il sotto-livello, il codice del paragrafo, la videata, lo stile , la data di validità, il flag di validità, il codice attività ed il modulo),
- all'interno del tag PAR, un tag TIT per fornire il titolo del paragrafo (se esiste),
- all'interno del tag PAR, un tag HTML contenente il testo del paragrafo in XHTML.
I file di documentazione su campo sono situati nella sotto-directory FLD della directory xml di estrazione. Il formato è il seguente:
- una testata normalizzata xml,
- un tag FLD con gli attributi NAME, LAN, MOD, GEN, LNKHLP, LNKORD, CREDAT, UPDDAT (che definiscono il nome, la lingua, il modulo, l'attributo generico della documentazione, l'help collegato, il legame, la data di creazione e la data di modifica),
- all'interno del tag FLD, un tag HTML contenente il testo del paragrafo in XHTML.
I file collegati ad una documentazione sono situati nella sotto-directory FILE della directory xml di estrazione. Il nome del file è costituito nella seguente maniera:
COD_LAN_TYP_LEV_SUBLEV_LIG_NOMEFILE _LGCLE.EXT, dove:
- COD_LAN_TYP_LEV_SUBLEV_LIG è costituito dalla chiave del file collegato nella tabella ADOCBLB (ciò per garantire l'unicità del nome,
- LGCLE contiene la lunghezza della chiave precedente per poter estrarre correttamente il codice della documentazione,
- NOMEFILE e EXT corrispondono al nome del file (nome e estensione) se indicato in ADOCBLB oppure ad un nome composto con i caratteri "IMG", seguiti dal numero di riga su 3 caratteri (prefissato da zero, se necessario) e seguito dall'estensione .jpg.