regole per la pubblicazione e la redazione dei documenti sul portale

PROVINCIA DI VERONA
REGOLE PER LA PUBBLICAZIONE E LA REDAZIONE DEI DOCUMENTI
SUL PORTALE WEB PROVINCIALE
SOMMARIO
1.
2.
3.
4.
5.
6.
PREMESSA .....................................................................................................................................................................3
TIPI DI DOCUMENTI.....................................................................................................................................................3
ACCORGIMENTI PER LA REDAZIONEDEI DOCUMENTI......................................................................................3
PUBBLICAZIONE IN FORMATO PDF ........................................................................................................................3
PUBBLICAZIONE DI MODULI O QUESTIONARI.....................................................................................................6
PRODURRE UNA PAGINA WEB PER IL PORTALE .................................................................................................8
6.1.
Inserimento dei segnalibri .....................................................................................................................................9
6.2.
Immagini e link ...................................................................................................................................................13
6.3.
Abbreviazioni ......................................................................................................................................................15
6.4.
Acronimi..............................................................................................................................................................15
6.5.
Cambio di lingua .................................................................................................................................................16
6.6.
Liste di definizione. .............................................................................................................................................16
6.7.
Tabelle dati..........................................................................................................................................................17
6.8.
Colore ..................................................................................................................................................................18
6.9.
Contrasto .............................................................................................................................................................18
6.10.
Salto all’interno della pagina ..........................................................................................................................18
6.11.
Tabelle di layout .............................................................................................................................................18
7. UTILIZZO DEI MODELLI PER LA REDAZIONE DI DOCUMENTI ACCESSIBILI ..............................................18
7.1.
Modello generico.................................................................................................................................................18
7.2.
Modelli specifici..................................................................................................................................................21
1. PREMESSA
Questo documento è destinato ad utenti pubblicatori. Nella redazione si è supposto che chi legge abbia
già dimestichezza con il software di pubblicazione “Openshare”. Per approfondimenti sull’utilizzo di
tale software si rimanda al manuale utente disponibile sul portale provinciale, all’indirizzo
http://www.provincia.vr.it/newweb/Segretario-direttore-generale/Unit--oper/Manuali-di/Manualidi/index.htm.
2. TIPI DI DOCUMENTI
La pubblicazione di documenti sul portale deve essere effettuata tenendo in considerazione la tipologia
di documento prodotto e il tipo di informazione che questo deve veicolare. In particolare:
• Documenti che costituiscono atti ufficiali dell’Ente (deliberazioni, determinazioni, decreti,
ordinanze, direttive, regolamenti) devono essere pubblicati in formato pdf, secondo quanto
prescritto al capitolo 4 “pubblicazione in formato pdf”;
• Documenti che devono essere rielaborati dagli utenti (moduli, questionari, etc.) devono essere
pubblicati, oltre che in formato pdf, ANCHE in formato rtf, secondo quanto prescritto al
capitolo 5 “pubblicazione di moduli o questionari”;
• Documenti che devono essere pubblicati “come contenuto” e che quindi rappresentano
descrizioni di progetti, servizi, uffici, etc., devono essere prodotti e pubblicati secondo quanto
previsto al capitolo 6 “produrre una pagina web per il portale”.
• Le “News” devono essere pubblicate secondo quanto indicato dal relativo manuale, disponibile
all’indirizzo
http://www.provincia.vr.it/newweb/Segretario-direttore-generale/Unit-oper/Manuali-di/Manuali-di/index.htm.
3. ACCORGIMENTI PER LA REDAZIONEDEI DOCUMENTI
Indipendentemente dalla tipologia del documento prodotto, ci sono alcuni accorgimenti che devono
essere sempre adottati nella redazione.
Oltre al rispetto delle regole di redazione degli atti e della documentazione amministrativa, a cui si
rimanda, si deve evitare di inserire elementi multimediali ed immagini in movimento all’interno del
documento. Infatti, questi elementi possono non essere fruibili direttamente (senza una alternativa) da
alcune categorie di utenti con disabilità o con strumenti hardware e software particolari e/o datati.
Ecco un elenco dei tipi di contenuto da evitare:
• applet Java;
• codice Javascript;
• filmati Flash;
• audio
• video
Solo per esperti: se non si può fare a meno di utilizzare uno degli oggetti non di testo sopra elencati si deve fornire
un’alternativa testuale equivalente che veicoli la stessa informazione commisurata alla funzione esercitata
dall'oggetto originale nello specifico contesto.
4. PUBBLICAZIONE IN FORMATO PDF
I documenti che costituiscono atti ufficiali dell’Ente (deliberazioni, determinazioni, decreti, ordinanze,
direttive, regolamenti) devono essere pubblicati in formato pdf.
Per fare ciò, sono utilizzabili due metodi alternativi:
Primo metodo.
Se sul proprio PC non è presente un programma di conversione in formato pdf, è possibile utilizzare la
conversione automatica di Openshare.
Per fare ciò, dopo aver prodotto il file originale con Word, procedere alla pubblicazione tramite
Openshare avendo cura di:
• aprire la finestra “Presentazione”;
• deselezionare l’opzione “html”;
• selezionare l’opzione “Adobe pdf”;
• impostare l’opzione “Filtro assente”;
(vedi immagine successiva).
Openshare pubblicherà il file originale in formato Word e il file convertito in formato pdf.
Secondo Metodo
Se sul proprio PC è presente il programma di conversione in pdf dei file formato Office (ad. Es.
qvPdf), installato come stampante aggiuntiva, produrre il file da pubblicare con Word e, tramite il
comando “stampa…”, selezionare la stampante pdf e premere OK, (vedi immagine seguente).
Quindi, selezionare il tasto “folder” per indicare in quale cartella deve essere salvato il file pdf
prodotto (vedi immagine successiva).
In alternativa, è possibile selezionare il tasto “desktop” per salvare il file sul proprio desktop.
IMPORTANTE: nell’indicazione del nome del file, il software propone “nomefile.doc.pdf”;.è
necessario eliminare “.doc”, in modo che il nome risulti “nomefile.pdf”. Il nome del file può essere
scelto a piacere.
Il file pdf viene prodotto e salvato nella cartella indicata. Pubblicare con Openshare esclusivamente
questo file.
NOTA BENE: Tra i due metodi illustrati è da preferire il primo nel caso di determinazioni,
regolamenti e altri documenti per i quali si voglia mettere a disposizione sul portale il file sorgente, in
quanto consente la pubblicazione del file in formato pdf e del file sorgente in formato word.
5. PUBBLICAZIONE DI MODULI O QUESTIONARI
I documenti che devono essere scaricati e rielaborati dagli utenti (moduli, questionari, etc.) devono
Salva con
essere preparati con il programma Word e salvati in formato rtf (menu file
nome selezionare in basso il tipo file “rich text format (rtf)” (vedi immagine successiva)
.
Il file formato rtf così prodotto deve essere pubblicato tramite Openshare, avendo cura di:
• aprire la finestra “Presentazione”;
• deselezionare l’opzione “html”;
• selezionare l’opzione “Adobe pdf”;
• impostare l’opzione “Filtro assente”;
(vedi immagine successiva).
Il risultato sul portale sarà la pubblicazione del file originale in formato rtf e di un file convertito in
formato pdf.
6. PRODURRE UNA PAGINA WEB PER IL PORTALE
Ci sono diversi accorgimenti da adottare, poiché la struttura di un documento word in generale non
consente ad Openshare di convertire il documento in un file HTML accessibile.
Occorre quindi intervenire sulla struttura del documento durante la sua redazione, ponendo particolare
attenzione ai seguenti elementi:
• linguaggio semplice e chiaro;
• immagini e link;
• abbreviazioni;
• acronimi;
• cambi di lingua;
• liste di definizione;
• tabelle;
• non affidarsi al colore;
•
•
•
contrasto;
salto all’interno della pagina;
non utilizzare tabelle di layout
L’uso corretto degli elementi elencati è spiegato dettagliatamente nel seguito del documento.
Alla maggior parte di tali elementi dovranno essere associati degli opportuni oggetti di Word
(Segnalibri) che li individuino all’interno del testo.
6.1. Inserimento dei segnalibri
Ogni segnalibro deve essere dapprima inserito nel documento Word (memorizzato) per poi poter
essere richiamato all’interno del testo nelle posizioni opportune.
Per inserire un segnalibro, dal menu di Word selezionare “Inserisci”, quindi “Segnalibro”, assicurarsi
che sia selezionata la spunta “segnalibri nascosti”, inserire il nome del segnalibro e fare click sul tasto
“Aggiungi” (vedi immagine successiva).
Per richiamare un segnalibro all’interno del testo, posizionarsi con il cursore nel punto del testo
desiderato, selezionare dal menu “Inserisci”, quindi “Collegamento ipertestuale” , fare click sul tasto
“Segnalibro…” (vedi immagine successiva)
Nella finestra successiva, selezionare il nome del segnalibro desiderato, fare click su “OK” (vedi
immagine successiva)
A questo punto, nella finestra di inserimento del collegamento fare click sul tasto “Descrizione” (vedi
immagine successiva)
Inserire la descrizione associata al segnalibro (significato dell’abbreviazione, dell’acronimo, lingua,
etc.) e chiudere tutte le finestre con i tasti “OK” (vedi immagine successiva).
NOTA BENE: Per facilitare l’utilizzo dei segnalibri è disponibile sul portale, nelle pagine dedicate al
supporto informatico, un modello di Word vuoto, contenente appositi pulsanti per l’inserimento
automatico dei segnalibri e il loro utilizzo all’interno del testo. L’utilizzo di tale file è descritto nel
capitolo 7 “Utilizzo del modello per la redazione di documenti accessibili”.
6.2. Immagini e link
Ogni immagine (a meno che non sia puramente decorativa) e ogni link presenti all’interno del
documento devono essere associati alle corrispondenti descrizioni.
Come per gli altri tipi di oggetto multimediali, anche per le immagini la descrizione deve essere
commisurata alla funzione esercitata dall'oggetto originale nello specifico contesto.
Per inserire tali descrizioni bisogna utilizzare l’apposita funzionalità di Word:
• per i link, all’interno della finestra di inserimento collegamento ipertestuale, fare click sul
pulsante “Descrizione” e inserire il testo descrittivo (vedi immagine successiva);
•
per le immagini, dopo aver inserito l’immagine, fare click con il tasto destro sull’immagine,
selezionare “Formato immagine”, poi il menu “Web” e quindi inserire il testo alternativo che
descrive l’immagine (vedi immagine successiva).
6.3. Abbreviazioni
Le abbreviazioni, affinché possano essere espanse nella pagina HTML, ad esempio dai supporti di
lettura, devono essere segnalate tramite gli appositi segnalibri:
• WF_ABR, posto all’inizio dell’abbreviazione;
• WF_ENDABR, posto alla fine dell’abbreviazione;
Ogni abbreviazione deve essere quindi “delimitata” da questa coppia di segnalibri. Ogni inserimento
deve contenere, come descrizione, il significato dell’abbreviazione.
Esempio:
…si richiede di allegare l’ultimo #WF_ABRmod.#WF_ENDABR 740 depositato.
6.4. Acronimi
Gli acronimi, per essere sciolti nella pagina HTML, devono essere segnalati tramite gli appositi
segnalibri:
• WF_ACR, posto all’inizio dell’acronimo;
• WF_ENDACR, posto alla fine dell’acronimo;
Ogni acronimo deve essere quindi “delimitato” da questa coppia di segnalibri. Ogni inserimento deve
contenere, come descrizione, il significato dell’acronimo.
Esempio:
…fare riferimento alla data di approvazione del #WF_ACRP.E.G.#WF_ENDACR in vigore.
6.5. Cambio di lingua
I cambi di lingua devono essere segnalati tramite gli appositi segnalibri:
• WF_LNG, posto all’inizio del cambio di lingua;
• WF_ENDLNG, posto alla fine del cambio di lingua;
Ogni cambio di lingua deve essere quindi “delimitato” da questa coppia di segnalibri. Ogni
inserimento deve contenere, come descrizione, il codice della lingua.
Segnalare correttamente i cambi di lingua consente ai sintetizzatori vocali di pronunciare correttamente
i termini scritti nelle diverse lingue.
I codici utilizzati per indicare le lingue sono i seguenti:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
en: inglese
fr: francese
de: tedesco
nl: olandese
el: greco
es: spagnolo
pt: portoghese
ar: arabo
he: ebraico
ru: russo
zh: cinese
ja: giapponese
hi: hindi
ur: urtu
sa: sanscrito
Esempio:
…per valutare il livello di soddisfazione degli utenti attraverso una cosiddetta “#WF_LNGcustomer
satisfaction#WF_ENDLNG”.
6.6. Liste di definizione.
Si tratta di elenchi composti di due parti: un termine e la relativa definizione, oppure un termine e la
relativa specificazione.
Tali liste devono essere segnalate tramite gli appositi segnalibri:
• WF_DL, posto all’inizio della lista;
• WF_EDL, posto alla fine della lista;
Ogni lista deve essere quindi “delimitata” da questa coppia di segnalibri. Per questi segnalibri non è
richiesta descrizione.
Esempio:
#WF_DL
Valle d’Aosta
Aosta
Piemonte
Torino
Lombardia
Milano
Veneto
Venezia
#WF_EDL
6.7. Tabelle dati
Ogni tabella dati è costituita, in generale, dai seguenti elementi:
• Una descrizione breve;
• Una descrizione estesa;
• Una riga di intestazione;
• Una colonna con intestazioni di riga;
ciascuno di questi elementi deve essere trattato opportunamente.
Inoltre, all’interno di ogni cella vi deve essere una sola informazione rilevante.
Descrizione breve
Prima della tabella, inserire il segnalibro WF_CAP associando la descrizione breve della tabella.
Descrizione estesa
Prima della tabella e dopo la descrizione breve, inserire il segnalibro WF_SUM associando la
descrizione estesa della tabella.
Riga di intestazione
La riga (o le righe) di intestazione vanno segnalate nel modo seguente:
1. Selezionare le righe di intestazione;
2. Fare click sul menu “Tabella”, quindi su “Proprietà tabella”;
3. Nel pannello “Riga”, spuntare la voce “Ripeti come riga di intestazione all’inizio di ogni
pagina”.
Se il testo all’interno di un delle celle di intestazione è troppo lungo e lo si vuole abbreviare, occorre
inserire prima dell’abbreviazione il segnalibro WF_TABBR, specificandone nella descrizione il
significato.
Colonna con intestazioni di riga
In presenza di una colonna con intestazioni di riga, prima del testo all’interno di ogni cella della
colonna occorre inserire il segnalibro WF_THR.
Esempio:
#WF_CAP
#WF_SUM
Nascite
#WF_THRGennaio 54
#WF_THRFebbraio 42
85
#WF_THRMarzo
#WF_TABBRMatr.
5
10
25
Decessi
60
38
80
6.8. Colore
Garantire che tutti gli elementi informativi e tutte le funzionalità siano disponibili anche in assenza del
particolare colore utilizzato per presentarli nella pagina.
Questo accorgimento assicura che anche chi è provvisto di display non a colori o che abbia problemi di
vista possa navigare nel sito.
6.9. Contrasto
Garantire che siano sempre distinguibili il contenuto informativo (foreground) e lo sfondo
(background), ricorrendo ad un sufficiente contrasto.
6.10.
Salto all’interno della pagina
Per pagine lunghe, sempre utilizzando la tecnica dei segnalibri in Word si può realizzare un sommario
a inizio pagina contenente i link ai contenuti principali della pagina. Non serve solo a rendere più
comoda la consultazione del documento, ma a garantire un migliore accesso ai contenuti a chi ascolta
la pagina e non può vederla.
6.11.
Tabelle di layout
Nella redazione del documento non devono essere utilizzate tabelle per la disposizione del testo. Le
tabelle vanno utilizzate esclusivamente per la presentazione di dati ove sia necessario. In questo caso
devono essere rispettate le regole di cui al paragrafo “tabelle di dati”.
7. UTILIZZO DEI MODELLI PER LA REDAZIONE DI DOCUMENTI ACCESSIBILI
7.1. Modello generico
Sul portale provinciale, all’indirizzo http://www.provincia.vr.it/newweb/Segretario-direttoregenerale/Unit--oper/Manuali-di/Manuali-di/index.htm, è disponibile il file “ModelloAccessibilita.dot”,
che costituisce il modello per la redazione di documenti generici da pubblicare come contenuto.
Per utilizzare i pulsanti predisposti nel modello assicurarsi che il livello di protezione delle macro in
Word sia impostato a “medio”. Per verificare il livello di protezione, aprire Word, selezionare dal
menu “Strumenti” la voce “Macro”, quindi la voce “Protezione”. Nella finestra della protezione,
selezionare l’opzione “Medio”, quindi fare click sul tasto OK (vedi immagine successiva).
Nel caso di una variazione al livello di protezione, sarà necessario riavviare Word per rendere effettive
le modifiche.
Per utilizzare il modello di documento, scaricarlo dal portale provinciale sul proprio pc, quindi aprirlo
(all’apertura, consentire l’attivazione delle macro).
Word creerà automaticamente un nuovo documento vuoto, che mette a disposizione dei tasti aggiuntivi
per facilitare l’inserimento dei segnalibri già descritti. Tali tasti hanno lo stesso nome dei segnalibri
(#WF_ABR, #WF_ACR, etc.) e si trovano all’interno della barra degli strumenti superiore. Se non
dovessero comparire perché la barra è già occupata da altri pulsanti, fare click sulla piccola freccia
presente al margine destro della barra per espandere il set di pulsanti (vedi immagine successiva).
Per inserire i segnalibri, è sufficiente selezionare il testo che interessa e fare click sul pulsante del
segnalibro desiderato. Ad esempio, dovendo scrivere la seguente frase:
“fare riferimento alla data di approvazione del P.E.G. in vigore”
che richiede l’esplicitazione dell’acronimo P.E.G., basterà selezionare il testo “P.E.G.”, quindi fare
click sul tasto “#WF_ACR” . Si aprirà una finestra che richiede l’inserimento della descrizione (“piano
esecutivo di gestione”) e quindi il programma automaticamente inserirà i segnalibri di apertura e
chiusura con la descrizione impostata e il testo precedente diventerà:
“fare riferimento alla data di approvazione del #WF_ACRP.E.G.#WF_ENDACR in vigore”.
Posizionando il cursore sul collegamento al segnalibro di apertura sarà possibile vedere la descrizione
impostata.
Per eliminare un segnalibro, è sufficiente selezionarlo con il cursore e cancellarlo con il tasto “canc”.
Per modificare un segnalibro già inserito, è consigliabile (perché più veloce) eliminarlo e reinserirlo.
Nell’uso del modello è opportuno organizzare il testo sulla base dei soli stili “Normale”, “Titolo1”,
“Titolo2”…”Titolo5”, e verificare come questi sono resi da Openshare nella pubblicazione del
documento.
7.2. Modelli specifici
Oltre al modello generico presentato nel paragrafo precedente, sono disponibili altri modelli, specifici
per la redazione di particolari documenti accessibili (schede di presentazione, deliberazioni,
determinazioni, etc.).
Per l’utilizzo di questi modelli, oltre alle stesse indicazioni presentate nel paragrafo precedente,
occorre tener presente che gli stili del testo che si trovano all’interno della struttura sono stati impostati
in modo da essere resi adeguatamente a seguito della conversione effettuata da Openshare. Quindi,
nella redazione di documenti basati su modelli specifici, occorre attenersi agli stili di testo già
predisposti nel file Word (Normale, Titolo1, Titolo2, etc.) senza modificarli o aggiungerne altri, pena
una produzione non prevedibile del testo a seguito della conversione.
Infine, è importante sottolineare che l’uso dei modelli proposti ha il solo scopo di facilitare la
redazione dei documenti, ma non garantisce da solo la produzione di documenti “accessibili”, essendo
questa legata anche al rispetto di tutte le regole illustrate nel presente documento.