Manuale utente. Indice generale. Nota. Java User Group Marche

Transcript

1 Manuale utente Nota Come modello per questo documento è stato preso il template dei documenti Write di OpenOffice disponibile sul sito dello JUG Sardegna. Si ringrazia il JUG Sardegna per la cortese collaborazione. Il documento è in costante aggiornamento. Se ci sono domande/dubbi urgenti sul codice sorgente o sull'architettura si possono porre le proprie domande sul forum del progetto (previa iscrizione) o mandando una mail alla mailing list di sviluppo jug4tendadev@googlegroups.com o ancora più comodamente ad andrea.on.web@libero.it. Indice generale Manuale utente...1 Nota...1 1Guida operativa Home Page: Gestione ospiti Ricerca ospite Gestione accoglienze Ricerca accoglienze (new!) Gestione news Layout di stampa delle pagine (new!) Personalizzazione elementi testuali I file messages.properties e custommessages.properties Esempi di personalizzazione voci Personalizzazione dei loghi di testata Personalizzazione della lista indumenti delle accoglienze Appendice: il file indice di ricerca Appendice: creazione degli operatori / 21

2 2 / 21

3 1 Guida operativa 1.1 Home Page: Immagine 1: Home page principale Cosa ci dice questa pagina? Come prima cosa ci dice quali ospiti sono attualmente accolti in casa compresa la Data Fine accoglienza, nel computer, ci dice qual'è l'ultima notte in cui il relativo ospite ha il diritto di dormire in casa). Ogni Volontario ha la possibilità di fare annotazioni sugli ospiti e renderle visibili (oppure no) nell'ultima colonna a destra sotto la voce News. Ogni riga relativa ad un ospite che è al suo ultimo giorno di accoglienza si evidenzia di rosa. Le voci scritte in blu nel riquadro centrale, sono quelle su cui è possibile cliccare (premere sopra la voce con il tasto sinistro), e così usufruire di alcune specifiche funzionalità. Cliccare sopra il nome di un ospite ci permette di entrare direttamente nella scheda personale dell'ospite, invece cliccare sopra Data Fine ci permette di ordinare gli ospiti in base alla data di uscita. Il box verde a sinistra riassume tutte le funzionalità di questo programma. La pagina appena descritta rappresenta la funzionalità Home. 3 / 21

4 1.2 Gestione ospiti Ricerca ospite Immagine 2: Maschera di ricerca ospite Come prima cosa il programma rende possibile la ricerca di un particolare ospite (se possibile consigliamo di fare la ricerca attraverso la Data di Nascita ) oppure cliccando sopra la voce Lista Ospiti. La ricerca di un ospite per nome/cognome può risultare inefficace se non si conoscono con esattezza il nome e/o il cognome dell'ospite voluto e ciò può capitare specie se si cercano ospiti stranieri. Per questo motivo nella maschera di ricerca è presente l'opzione Usa la ricerca indicizzata che permette di fare ricerche alla Google sul nome e cognome dell'ospite. Questo significa che gli ospiti possono essere trovati anche senza scrivere in maniera esatta il loro nome o cognome. Per usare la ricerca indicizzata occorre prima costruire l'indice di ricerca come descritto in Appendice: il file indice di ricerca. Una demo animata di questo tipo di ricerca è presente all'indirizzo internet 4 / 21

5 Immagine 3: Elenco dei risulati di ricerca ospite è possibile scorrere un elenco completo di tutte le persone che sono state accolte, almeno una volta, in casa.anche questo elenco può essere ordinato (cliccando nelle voci in blu) per Num.Ospite, Cognome, Cittadinanza o Sesso. Se l'ospite che stiamo cercando non è mai stato accolto e dobbiamo registrarlo per la prima volta occorre selezionare la voce Nuovo Ospite Immagine 4: Creazione di un nuovo ospite la pagina Dati Ospiti illustra chiaramente quali dati devono essere inseriti per la registrazione del 5 / 21

6 nuovo ospite nel computer. Premere Salva. Fatto questo il nuovo ospite ha una pagina personale di questo tipo: Immagine 5: Pagina principale dei dati ospite In cui possiamo usufruire delle funzionalità espresse in alto (in blu). Potremmo infatti modificare i dati dell'ospite, inserire una nuova accoglienza oppure fare osservazioni sull'ospite. 6 / 21

7 1.3 Gestione accoglienze Dopo aver inserito i dati di un nuovo ospite, entrati nella sua pagina personale (vedi subito sopra), procediamo con il registrare una nuova accoglienza, quindi selezioneremo la voce Nuova Accoglienza (in blu in alto): Immagine 6: Creazione di una nuova accoglienza Da solo il programma suggerisce la Data Inizio e Data Fine accoglienza ma questo non ci impedisce di modificarla (ad esempio nel voler effettuare un prolungamento). In questa pagina è stata anche inserita una bacheca in cui segnalare gli indumenti distribuiti all'ospite. Premere Salva. Supponiamo ora di vole fare una segnalazione relativa allo stesso ospite quindi nella pagina Dati Ospite (due figure sopra) selezioniamo la voce Nuova News : 7 / 21

8 Immagine 7: Creazione di una nuova news ospite Il programma distingue due date, una relativa all'inserimento (ovvero la data del giorno stesso) e una relativa alla pubblicazione nella pagina principale (home page). E' infatti possibile scrivere una nota all'ospite senza che la stessa venga mai visualizzata nella pagina principale rimanendo però presente nella sua pagina personale (questa operazione è possibile selezionando una data di pubblicazione maggiore della data di fine accoglienza). Bisogna poi selezionare il nome dell'operatore che scrive la nota (premere l'iniziale del nome tante volte quanto necessario per farlo apparire) ed assegnarli un livello di gravità che può essere basso,medio o alto (a discrezione del volontario). Procedere con la scrittura del testo e salvare. 8 / 21

9 1.4 Ricerca accoglienze (new!) Nel menù della Gestione Ospiti è presente una funzione studiata per effettuare rapidamente ricerche sulle accoglienze presenti nel database: La pagina di ricerca delle accoglienze richiede di specificare una data per trovare le accoglienze attive in quel giorno. Se non si specifica alcuna data viene preso la data odierna come default. Per indicare questa data si può usare il calendario pop-up richiamabile mediante click sull'icona del calendario: Immagine 8: Pagina principale Ricerca Accoglienza La ricerca delle accoglienze attive viene fatta anche sui due giorni precedenti alla data indicata e sui due successivi. I risultati della ricerca vengono mostrati suddivisi per giorno in forma tabellare: 9 / 21

10 Immagine 9: Risultati sulla ricerca accoglienze al 27/03/2010 Cliccando sulla casella Visualizza come elenco si possono visualizzare i risultati della ricerca come un unico elenco: Immagine 10: I risultati mostrati come elenco (solo i primi due) 10 / 21

11 1.5 Gestione news NOTA: per utilizzare questa funzionalità occorre che siano stati precedentemente registrati i dati relativi ai volontari che operano nel sistema. Nel paragrafo Appendice: creazione degli operatori viene indicato come creare i profili degli operatori necessari per utilizzare la gestione delle news. E' possibile registrare osservazioni relative alla gestione della casa, indipendenti dagli ospiti (esempio: la sveglia è rotta, il bagno è otturato etc..). Questo tipo di segnalazioni vengono gestite nella sezione Gestione news del programma a cui si accede dal menù principale: La pagina principale della Gestione news è quella di ricerca: Immagine 11: Ricerca news 11 / 21

12 In maniera analoga a quanto accade nella Gestione ospiti è possibile consultare la lista completa delle news tramite la voce Lista News del nuovo menù: Immagine 12: Elenco news Per inserire una nuova news si usi la voce Nuova News Immagine 13: Modifica news 12 / 21

13 Inserire una nuova osservazione con le stesse modalità descritte sopra. 1.6 Layout di stampa delle pagine (new!) L'applicativo dispone di una formattazione automatica (mediante CSS) che consente di stampare il contenuto delle pagine rimuovendo il menù di sinistra e l'header dell'applicativo: Immagine 14: Anteprima di stampa della ricerca accoglienze In questo modo è possibile stampare i propri dati in maniera leggibile e compatta. 13 / 21

14 2 Personalizzazione elementi testuali NOTA: per effettuare le personalizzazioni suggerite in questo capitolo sono necessarie competenze sistemistiche per lavorare con le cartelle di installazione dell'applicativo e con l'application server che lo ospita. Si consiglia di fare eseguire le modifiche descritte solo ad utenti in possesso delle competenze necessarie. 2.1 I file messages.properties e custommessages.properties Per elemento testuale si intendono le etichette descrittive visibili sui menù e sui pulsanti dell'applicativo (es: Nuova Accoglienza, Cerca News, Salva News, ecc...). Jug4Tenda raccoglie tutti questi elementi in un comune file di testo (.txt) consultabile con un semplice editor ma non modificabile (in seguito vedremo perchè). Il nome del file è messages.properties e si trova nella sottocartella WEB-INF/classes: Immagine 15: Il file messages.properties Se si apre il file si troverà un elenco di voci/valori separati dal carattere uguale. Le righe che iniziano con il carattere cancelletto # sono righe di commento e possono essere trascurate. La maggior parte di queste voci sono usate dal programma per visualizzare gli elementi testuali di cui abbiamo appena parlato. Così ad esempio il seguente frammento del file # # form buttons # savebutton=salva cancelbutton=annulla deletebutton=elimina searchbutton=cerca modifybutton=modifica specifica il testo visualizzato sui pulsanti di salvataggio ( Salva ), annullamento ( Annulla ), eliminazione ( Elimina ), ecc... che si trovano nel programma (es: vedi Immagine 4: Creazione di 14 / 21

15 un nuovo ospite). Eventuali modifiche al valore di queste voci si riflettono sugli elementi testuali dell'applicazione. In questo modo se per la voce savebutton scrivessimo savebutton=save vedremmo la scritta Save al posto di Salva sui pulsanti di salvataggio del programma. Tuttavia come anticipato le modifiche che si vogliono apportare alle voci del file message.properties non vanno fatte direttamente su questo file, bensì sul file custommessages.properties presente nella stessa cartella del file message.properties. Se si apre questo file si noterà che è vuoto e non contiene coppie voci/valori come il suo file gemello message.properties. Il contenuto di custommessages.properties va a sovrascrivere quello di message.properties e quindi sarà l'utente che a sua discrezione potrà inserire le voci già presenti in message.properties ma valorizzate a piacimento. Di seguito vedremo alcuni esempi utili di personalizzazione delle voci di message.properties tramite il file custommessages.properties. 2.2 Esempi di personalizzazione voci Alcune voci non sono usate come elemento testuale ma come parametro funzionale, ossia il loro valore influisce sul funzionamento dell'applicativo. Queste voci si trovano all'inizio del file di properties # # business prameters configuration # accoglienza.maxaccoglienzaday=10 accoglienza.monthsinbeetween=3 accoglienza.bedformen=10 accoglienza.bedforwomen=3 # # date format # dateformat=dd/mm/yyyy #icone dell'header headerleftlogo=img/logo_jug4tenda.jpg headerrightlogo=img/logo_latendadabramo.gif Di seguito descriviamo la funzione di questi parametri: accoglienza.maxaccoglienzaday indica la durate massima in giorni di un'accoglienza accoglienza.monthsinbeetween indica l'intervallo di tempo minimo in mesi che deve intercorrere tra un'accoglienza e l'altra per uno stesso ospite. accoglienza.bedformen indica il numero di posti letto disponibili per ospiti di sesso 15 / 21

16 maschile accoglienza.bedforwomen indica il numero di posti letto disponibili per ospiti di sesso femminile dateformat esprime il formato data usato all'interno dell'applicativo nella forma giorno (dd), mese (MM), anno (yyyy). Il formato italiano è dd/mm/yyyy (ad esempio 15/01/2008) mentre quello anglosassone è MM/dd/yyyy (ad esempio 01/15/2008) Gli ultimi due parametri (headerleftlogo e headerrightlogo) indicano i file di immagine (jpeg, png, gif, ecc...) visualizzati a sinistra e a destra dell'header (ossia la parte superiore) delle pagine dell'applicativo (vedi immagine seguente). Immagine 16: headerleftlogo e headerrightlogo con le immagini di default 2.3 Personalizzazione dei loghi di testata Vediamo come attraverso i file di properties si possano personalizzare i loghi mostrati nella figura precedente. Le immagini dei loghi vengono cercate nella cartella img che ospita gli elementi grafici dell'applicativo : 16 / 21

17 Possiamo personalizzare le voci del file di properties per caricare delle immagini arbitrarie come logo sinistro e logo destro. L'unico vincolo è che le nuove immagini non abbiano un altezza e una lunghezza eccessive che le faccia uscire dall'area di intestazione. Nel seguente esempio usiamo per i loghi di un'altra struttura di accoglienza chiamata La città della gioia in modo da personalizzare l'intestazione dell''applicazione. Usiamo per headerleftlogo l'immagine DescrCasa.png e per headerrightlogo l'immagine Casa.png: #icone dell'header headerrightlogo=img/casa.png headerleftlogo=img/descrcasa.png Di seguito possiamo vedere le due immagini utilizzate nell'esempio: Una volta salvato il file custommessages.properties al prossimo riavvio dell'application server si otterrà il risultato mostrato in figura. Immagine 17: I loghi personalizzati 17 / 21

18 2.4 Personalizzazione della lista indumenti delle accoglienze Quando creiamo un'accoglienza possiamo indicare un massimo di 9 indumenti o accessori per la cura personale consegnati all'ospite che si sta accogliendo. Questi elementi sono elencati nel riquadro Indumenti (vedi figura): Immagine 18: La lista di default degli indumenti L'uso dei file di properties consente di personalizzare questa lista a seconda delle esigenze della struttura. Nel file messages.properties le voci che corrispondono agli indumenti visualizzati sono indum.option0, indum.option1 e così via fino a indum.option8. Nel file custommessages.properties possiamo sovrascrivere queste voci per personalizzare la lista degli indumenti proposti. Come esempio usiamo il testo seguente: ###### indumenti ####### indum.option0=lenzuola coperta indum.option1=lenzuola materasso indum.option2=federa indum.option3=lametta da barba indum.option4=spazzolino indum.option5=dentifricio indum.option6=asciugamano grande indum.option7=asciugamano piccolo indum.option8= Si noti che l'ultima delle voci, indum.option8, non è valorizzata. Questo perchè vogliamo ottenere una lista di indumenti con 8 elementi e nono 9, quindi quelli in eccesso vanno lasciati non valorizzati. Il risultato di questa personalizzazione è il seguente: 18 / 21

19 Immagine 19: La lista indumenti personalizzata. Sono visibili i nuovi 8 elementi della lista voluti. 19 / 21

20 3 Appendice: il file indice di ricerca. Per poter utilizzare la ricerca indicizzate degli ospiti (vedi il paragrafo Ricerca ospite) occorre prima effettuare l'operazione di costruzione dell'indice di ricerca. Questo indice è un insieme di file che il sistema utilizza per poter effettuare ricerche alla Google sul nome e cognome degli ospiti, permettendo di trovare ospiti con nome e cognome simili ai valori di ricerca immessi. Ad esempio indicando come nome Moamed vengono restituiti gli ospiti che si chiamano Mohamed. Per costruire l'indice basta accedere alla pagina buildindex.html e premere il pulsante Index: La pagina buildindex.html non è accessibile da nessun menù dell'applicativo e va quindi digitata a mano nella barra degl'indirizzi. Di norma quest'operazione può essere evitata se si inizia a lavorare con un database vuoto, ossia senza nessun ospite registrato. Deve essere invece svolta in fase di configurazione del software se si vuole lavorare su un database già popolato con dati relativi agli ospiti. Uno scenario del genere poterebbe presentarsi se si volesse installare il software e il database in uso su un nuovo pc. L'operazione va comunque eseguita una volta sola prima di utilizzare il software per gestire i dati degli ospiti. 20 / 21

21 4 Appendice: creazione degli operatori Alcune funzionalità dell'applicativo (es: 1.5 Gestione news) richiedono di indicare quale volontario della struttura sta inserendo i dati nel sistema. Per fare ciò occorre che nel sistema siano stati precedentemente registrati i dati dei volontari che operano nel sistema. Dal menù principale del programma si può accedere alla sezione di gestione degli operatori cliccando sulla voce Gestione operatori : La pagina principale di questa sezione mostra l'elenco degli operatori creati: Le altre funzionalità offerte sono la creazione di nuovi operatori e la ricerca di quelli esistenti in base al nome e cognome degli stessi: 21 / 21