proseguito lavoro doc

doc/calendario.rst

@@ -0,0 +1,98 @@
+*************
+Il calendario
+*************
+
+.. image:: img/calendario_menu.png
+	:align: center
+
+Il calendario è il contenitore dei :doc:`turni <turno>`, essi vengono rappresentati disposti su sette colonne in ordine cronologico.
+
+ .. note::
+
+	Se due turni inziano contemporaneamente verrannò ordinato secondo la priorità del :ref:`tipo di turno <tipo_turno-label>`
+
+GeT può gestire più calendari contemporaneamente riconoscibili dalla medesima icona nel menu principale.
+
+Visualizzazione del calendario
+==============================
+
+La visualizzazione del calendario varia secondo il seguente schema:
+
+* Utente non loggato
+* Utente semplice
+* Membro dello staff
+
+Calendario utente non loggato
+-----------------------------
+
+.. image:: img/calendario_sloggato.png
+	:align: center
+
+Se si accede al calendario senza prima aver effettuato il login non saranno visibili i nomi delle persone segnate. Saranno però già riconoscibili i turni coperti e non in base al loro colore (verde coperto, rosso non coperto).
+
+Calendario utente semplice
+--------------------------
+
+.. image:: img/calendario_utente.png
+	:align: center
+
+Quando il calendario è visualizzato da un utente semplice dopo aver effettuato il login appariranno i nomi delle persone già segnate e tutti i turni diventeranno clickabili.
+
+.. image:: img/utente_disponibilita.png
+	:align: center
+
+Facendo click su un turno è possibili modificare la propria disponibilità. Se la modifica avviene entro i tempi preimpostati verrà mostrata una finestra di dialogo che permetterà all'utente di selezionare la mansione che vuole ricoprire. Se il click avviene su un turno per cui l'utente si è già reso disponbile egli sarà in grado di cancellarsi. In entrambi i casi verrà inviata una :doc:`notifica <notifiche>` all'utente dello staff predisposto.
+
+ .. note::
+ 	I limiti temporali entro cui è possibile segnarsi o cancellarsi da un turno vengono impostati all' interno di un file di configurazione predefinito
+
+ .. note::
+ 	La mansioni che saranno mostrate all'utente per potersi segnare vengono selezionate dal software in modo che non vadano in conflitto con i requisiti pre-impostati (se ad esempio è necessario massimo una autista e un utente si è già segnato nessun altro potrà farlo)
+
+Calendario per lo staff
+-----------------------
+
+.. image:: img/calendario_staff.png
+	:align: center
+
+Quando è stato effettuato il login come menbro dello staff la visualizzazione del calendario risulta completa di tutte le informazioni sia sulle persone disponibili sia dei requisiti del singolo turno.
+
+La visualizzazione del turno per i membri dello staff è la seguente:
+
+.. image:: img/turno.png
+	:align: center
+
+All'interno del turno appaiono tutte le mansioni e sulla destra sono indicati i requisiti numerici all'interno di un badge colorato |E|. Esso può essere dei seguenti colori:
+
+* **verde**: requisito soddisfatto
+* **rosso**: requisito non soddisfatto
+* **blu**: requisito sufficiente
+* **grigio**: requisito non necessario
+
+Facendo click sul badge si aprirà la pagina di ricerca delle persone per quella mansione. si veda la sezione :doc:`disponibilità <disponibilita>` per ulteriori informazioni.
+
+ .. note::
+ 	se un requisito è indicato come *extra* apparirà un asterisco alla sua sinistra
+
+ .. note::
+ 	se un requisito è indicato come *nascosto* non risulterà clickabile e sarà visibile solo allo staff
+
+Nella parte superiore del turno sono indicate l'ora di inizio e fine del turno |A| ed un identificativo opzionale |D|.
+
+Sono inoltre presenti due bottoni: il primo |B| richiama la pagina di modifica della disponibilità per un gruppo (si faccia ulteriore riferimento alla sezione :doc:`disponibilità <disponibilita>`) ed il secondo |C| permette di modificare o eliminare il turno.
+
+
+Infine in basso |F| è riportata la tipologia del turno. 
+
+
+Filtrare i giorni
+=================
+
+Tramite il bottone in alto a destra "FILTRA" è possibile visualizzare solo determinati giorni della settimana, i giorni feriali, prefestivi o festivi.
+
+.. |A| image:: img/A.png
+.. |B| image:: img/B.png
+.. |C| image:: img/C.png
+.. |D| image:: img/D.png
+.. |E| image:: img/E.png
+.. |F| image:: img/F.png

doc/disponibilita.rst

@@ -0,0 +1,28 @@
+**************
+Disponibilità
+**************
+
+La disponibilità rappresenta la relazione tra una persona ed un turno.
+
+Essa può essere di di 4 tipi:
+
+* Disponbile
+* Indisponbile
+* Da richiamare
+* Non risponde
+
+Creare/rimuovere disponibilità
+==============================
+
+L'inserimento o la cancellazione di una disponbilità può avvenire in due modi:
+* La persona dopo aver effettuato il login esegue un click sul turno scelto
+* Un membro dello staff utilizza la pagina di ricerca delle persone o modifica la disponibilità di un gruppo per un turno
+
+Ricerca persone per mansione
+----------------------------
+
+
+
+
+Aggiunta di un gruppo ad un turno
+---------------------------------

doc/impostazioni.rst

@@ -41,6 +41,8 @@ Per modificare/eliminare una mansione è sufficiente utilizzare il selettore nel
 
 	Eliminando una mansione vengono eliminati anche tutti i requisiti che la utilizzano
 
+.. _impo_notifiche-label:
+
 Notifiche
 ===========
 
@@ -64,6 +66,7 @@ Il calendario rappresenta il contenitore per i turni, ogni calendario creato è
 
 	Solo gli ammnistratori posso creare, modificare o eliminare un calendario
 
+.. _tipo_turno-label:
 
 Tipi di Turno
 =============

doc/index.rst

@@ -15,6 +15,10 @@ Il software è completamente personalizzabile e può essere adattato ai più dis
    :maxdepth: 2
 
    Introduzione <introduzione.rst>
-   Impostazioni <impostazioni.rst>
    Le persone <persone.rst>
+   Impostazioni <impostazioni.rst>
+   Il calendario <calendario.rst>
+   Il turno <turno.rst>
+   Le disponibilità <disponibilita.rst>
+   Notifiche <notifiche.rst>
 

doc/introduzione.rst

@@ -3,11 +3,11 @@ Introduzione
 
 GeT si occupa innanzitutto di archiviare una anagrafica delle :doc:`persone <persone>` fornendo all'amministratore la possibilità di inserire informazioni rispetto alle :ref:`mansioni <mansioni-label>` che ogni singola persona è in grado di svolgere. Le mansioni posso essere create a piacimento a seconda delle esigenze.
 
-In base alla mansioni che sono state create all'interno del programma è possibile definire delle tipologie di turno con requisiti basati proprio su quest'ultime. Esempio: deve essere presente almeno un autista.
+In base alla mansioni che sono state create all'interno del programma è possibile definire delle :ref:`tipologie di turno <tipo_turno-label>` con requisiti basati proprio su quest'ultime. Esempio: deve essere presente almeno una persona con mansione autista.
 
-A questo punto possono essere creati i turni di cui ho bisogno, fornendo l'orario e la tipologia di turno. Un volta che il turno è stato creato l'amministratore sarà in grado di aggiungere delle disponibilità che potranno essere sia favorevoli che no, in modo che anche gli altri responsabili possano sapere se una persona ha già dichiarato di non essere disponibile per quel turno.
+A questo punto possono essere creati i :doc:`turni <turno>` di cui ho bisogno, fornendo l'orario e la tipologia. Un volta che il turno è stato creato l'amministratore sarà in grado di aggiungere delle disponibilità che potranno essere sia favorevoli che no, in modo che anche gli altri responsabili possano sapere se una persona ha già dichiarato di non essere disponibile per quel turno.
 
-Le persone dotate di un account utente hanno la possibilità di vedere da casa chi è già inserito all'interno del calendario ma possono anche rendersi disponibili o cancellarsi da un turno autonomamente.
+Le persone dotate di un account utente hanno la possibilità di vedere da casa chi è già inserito all'interno del :doc:`calendario <calendario>` ma possono anche rendersi disponibili o cancellarsi da un turno autonomamente.
 
 Iniziare ad usare GeT
 ---------------------

doc/notifiche.rst

@@ -0,0 +1,27 @@
+**********
+Notifiche
+**********
+E' possibile accedere alla sezione "notifiche" dal menu principale:
+
+.. image:: img/notifiche_menu.png
+	:align: center
+
+Il numero all'interno del riquadro rosso indica il numero di notifiche non lette.
+
+Le notifiche vengono inviate ogni qualvolta una persona aggiunge o rimuove la propria disponibilità ad un turno.
+
+.. note::
+
+	Questa sezione è accessibile solo ai membri dello staff o amministratori
+
+.. image:: img/elenco_notifiche.png
+	:align: center
+
+
+In questa sezione sono elencate le notifiche ricevute, le notifiche evidenziate in giallo sono quelle non lette.
+
+Per modificare lo stato di una o più notifiche è sufficiente selezionarle ed utilizzare il selettore in alto a destra.
+
+.. note::
+
+	Le notifiche  che un membro dello staff riceverà sono configurare nella sezione :ref:`impostazioni <impo_notifiche-label>`

doc/turno.rst

@@ -0,0 +1,37 @@
+*************
+Il turno
+*************
+
+I turni già presentati nella sezione calendario raccolgono le disponibilità o indisponibilità delle persone
+
+Creare un nuovo turno
+=====================
+
+Per creare un nuovo turno è sufficiente utilizzare il pulsante "NUOVO TURNO" posto in alto a destra nella pagina di visualizzazione del calendario.
+
+Nella schermata successiva potrà essere indicato un identificativo (opzionale) per riconoscere il turno appena creato.
+
+.. figure:: img/nuovo_turno.png
+	:align: center
+
+E' necessario indicare giorno ed ora di inizio e fine del turno con il vincolo che questo si sviluppi interamente entro un giorno.
+Selezionamo il tipo di turno (quindi anche i requisiti che questo dovrà avere) ed il punteggio.
+
+.. note::
+
+	Il punteggio viene utilizzato esclusivamente nelle statistiche e può essere utilizzato per attribuire un valore maggiore ad alcuni turni.
+
+Selezionamo infine il calendario che dovrà ospitare il turno.
+
+Ripetere il turno
+------------------
+
+Facendo click sulla voce "RIPETI TURNO" si apriranno ulteriori campi che permettono di ripetere il turno appena configurato.
+Indicando l'intervallo di date e selezionando i giorni richiesti il turno verrà replicato su ognuno di questi giorni al medesimo orario.
+
+.. figure:: img/ripeti_turno.png
+	:align: center
+
+.. note::
+
+	I turni creati con la funzione "RIPETI TURNO" rimangono legati e sarà possibile modificarli o eliminarli contemporaneamente.

todo

@@ -0,0 +1,2 @@
+fare in modo che lo staff possa eliminare solo un turno vuoto
+fare in modo che lo staff possa eliminare solo turni futuri