-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.html
143 lines (143 loc) · 11.5 KB
/
main.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<title>Home</title>
<link rel="stylesheet" type="text/css" href="css/welcome-style.css">
</head>
<body>
<div class="well well-lg" id="title">
<h1>Raschietto</h1>
<h3>Informazioni e guida generale su come utilizzare il tool</h3>
<div id="image">
<img id="imgPrincipale" alt="logoHeisenberg" src="image/logoHeisenberg.png">
</div>
<br />
<h4><b>1. Informazioni generali</b></h4>
<p>Benvenuti! "Raschietto" è una web application realizzata dal gruppo Heisenberg (Antonio Faienza, Alessandro
Pecorari, Riccardo Zandegiacomo) come progetto del corso di Tecnologie Web del corso di Laurea in Informatica
per il Management dell'Università di Bologna. L'applicazione consente la visualizzazione e annotazione di
pagine web di carattere scientifico; è inoltre possibile utilizzarla (con qualche limitazione) per qualsiasi
altra pagina web.</p>
<br />
<h4><b>2. Guida rapida alle funzionalità principali</b></h4>
<p>Le principali funzionalità dell'applicazione sono la visualizzazione di pagine web di carattere scientifico
e l'annotazione delle stesse.
Sono disponibili due modalità di utilizzo: "Reader" e "Annotator"; nella modalità "Reader" è possibile visualizzare
pagine web, scegliendo tra quelle già presenti nell'applicazione (tramite il pannello laterale "Documenti") oppure
aggiungendone di nuove inserendone l'url completo nella barra di ricerca. Al caricamento di una pagina, verranno
mostrate automaticamente alcune annotazioni realizzate dall'applicazione stessa attraverso un meccanismo di
scraping; è possibile visualizzarle cliccandovi sopra.
Per poter inserire nuove annotazioni o modificare quelle presenti, è necessario passare alla modalità "Annotator";
per farlo è necessario cliccare sul pulsante "Switch to Annotator" e autenticarsi; a questo punto, tramite la
barra degli strumenti che verrà mostrata, sarà possibile procedere con le modifiche desiderate ed eventualmente
tornare alla modalità "Reader".</p>
<br />
<h4><b>3. Autenticazione</b></h4>
<p>Il servizio non prevede un meccanismo di registrazione al servizio, ma è necessario autenticarsi fornendo
alcune informazioni di base (nome, cognome e indirizzo e-mail) per poter rintracciare la provenance delle
modifiche effettuate. L'inserimento di queste informazioni è effettuato tramite un pannello di "login" che
viene mostrato quando si decide di passare alla modalità "Annotator" tramite l'apposito pulsante; il "logout" è
automatico, e avviene alla chiusura della pagina o quando si decide di tornare alla modalità "Reader" con
l'apposito pulsante.</p>
<br />
<h4><b>4. Funzionalità principali</b></h4>
<h5><b>4.1 Visualizzazione di pagine web</b></h5>
<p>E' possibile visualizzare pagine web già presenti nel database o esterne; per visualizzare le pagine già
presenti, è necessario selezionarle tramite l'apposito pannello "Documenti".
Ogni pagina presente in questo pannello è già stata caricata in passato da altri utenti, e pertanto possiederà
già delle annotazioni (automatiche o manuali) che verranno caricate contestualmente.<br />
Nel caso in cui si volesse visualizzare ed eventualmente annotare una pagina non presente nel database, è
possibile inserirne l'url completo nell'apposita barra di ricerca presente nella barra principale dell'applicazione;
le pagine così caricate verranno analizzate dall'applicazione per cercare di visualizzarle in modo ottimale;
purtroppo, per ragioni di sicurezza e necessità grafiche e pratiche, è necessario effettuare una serie di operazioni
di pulizia per quelle pagine che non presentano l'aspetto standard accettato dall'applicazione.<br />
Questo comporta l'eliminazione degli script (javascript o altro), del CSS e di alcuni tag HTML dalla pagina stessa
prima della visualizzazione, per poter garantire un utilizzo ottimale delle funzionalità di annotazione; in alcuni
casi, le pagine mostrate potranno essere solo parziali o addirittura del tutto bianche, qualora fossero realizzate
interamente tramite script oppure per motivi di sicurezza impedissero la visualizzazione su pagine esterne al loro
dominio. <br />
Non è in nostro potere interferire con questi meccanismi di creazione delle pagine web, pertanto ci scusiamo qualora
si dovessero presentare situazioni del genere, che durante i nostri test si sono comunque limitate a poche pagine.
<br />
<br />
<b>NOTA!</b> Caricare una nuova pagina, sia attraverso il pannello "Documenti" che inserendo un url, comporterà la cancellazione
di tutte le annotazioni non salvate effettuate sul documento aperto precedentemente.
</p>
<h5><b>4.2 Visualizzazione delle annotazioni</b></h5>
<p>E' possibile visualizzare le annotazioni presenti su una pagina o un documento caricati semplicemente cliccandovi
sopra; graficamente la possibilità di cliccare su un'annotazione è mostrata tramite un meccanismo di "highlight"
delle annotazioni stesse. <br />
I dettagli delle annotazioni verranno mostrati in un'apposita finestra che si aprirà una volta cliccato su
un'annotazione. In caso di annotazioni multiple presenti sullo stesso frammento di pagina, verranno mostrati
i dettagli di tutte le annotazioni presenti, ordinate dalla più recente alla meno recente.</p>
<h5><b>4.3 Inserimento delle annotazioni</b></h5>
<p>Per poter inserire annotazioni, è necessario passare alla modalità "Annotator". <br />
E' possibile inserire due diversi tipi di annotazione.<br />
<b>NOTA!</b> Le annotazioni inserite manualmente sono solo presenti in locale; sarà necessario salvarle (vedi punto
4.4) in modo definitivo perchè vengano inviate al server e siano accessibili ad altri utenti o al riavvio della
pagina.</p>
<h6><b>4.3.1 Annotazioni sul documento</b></h6>
<p>Le annotazioni sul documento sono annotazioni di carattere generale relative al documento, e non sono
legate ad alcun frammento del documento stesso. E' possibile inserirle tramite il pulsante "Inserisci una
nuova annotazione sul documento" presente nella barra delle funzionalità del documento, il quale aprirà una
finestra per l'inserimento rapido.<br />
Il procedimento di inserimento delle annotazioni sul documento è molto semplice; è sufficiente scegliere il tipo
di annotazione (sono disponibili 5 tipi: Autore, Anno di Pubblicazione, Titolo, DOI, URL), specificare
il contenuto dell'annotazione stessa (ad esempio, nel caso dell'autore, "Mario Rossi") e premere "Inserisci
annotazione".<br />
Le annotazioni sul documento inserite verranno mostrate nel pannello "Annotazioni Documento".</p>
<h6><b>4.3.2 Annotazioni su frammento</b></h6>
<p>Le annotazioni su frammento sono annotazioni specifiche, relative ad un particolare frammento della pagina
web visualizzata. Per inserirle, è necessario selezionare un frammento della pagina (tramite il mouse) e cliccare
sul pulsante "Inserisci una nuova annotazione su un frammento" presente nella barra delle funzionalità del
documento.<br />
Si aprirà una finestra di inserimento che consentirà di verificare che il frammento selezionato sia quello voluto;
successivamente, analogamente alle annotazioni sul documento, sarà possibile scegliere il tipo di annotazione
(oltre ai 5 precedenti, ora sono disponibili anche Commento, Funzione Retorica e Citazione), specificare
il contenuto dell'annotazione stessa (ad esempio, nel caso dell'autore, "Mario Rossi") e premere "Inserisci
annotazione".<br />
Le annotazioni su frammento inserite verranno mostrate graficamente all'interno del documento stesso.</p>
<h5><b>4.4 Modifica delle annotazioni e salvataggio delle stesse</b></h5>
Tramite il tasto "Gestisci le annotazioni inserite" presente nella barra delle funzionalità del documento, è
possibile modificare le annotazioni (sia automatiche che manuali) ed eventualmente salvarle in modo definitivo.<br />
Nella finestra che si aprirà, sarà possibile cancellare le singole annotazioni o modificarle tramite appositi
pulsanti; in caso di modifica, in base al tipo di annotazione sarà possibile modificarne tipo, contenuto ed
eventualmente target nella pagina web.<br />
Il pulsante "Invio" salva in modo definitivo le annotazioni effettuate inviandole al server.
<br />
<h4><b>5. Funzionalità avanzate</b></h4>
<h5><b>5.1 Filtri</b></h5>
<p>E' possibile filtrare le annotazioni presenti sul documento utilizzando gli appositi pulsanti presenti
nel pannello laterale "Filtri"; una volta cliccati, renderanno invisibili le annotazioni del tipo specificato
dal pulsante stesso. E' possibile utilizzare più filtri contemporaneamente (anche tutti e 8 se necessario) senza
alcun problema; è importante sottolineare che l'applicazione di un filtro NON cancella un'annotazione, e che
pertanto un'annotazione filtrata verrà comunque rilevata dal pannello di modifica e invio, e sarà possibile
interagire con la stessa.</p>
<h5><b>5.2 Force Scraping</b></h5>
<p>E' possibile forzare il meccanismo di scraping di una pagina utilizzando il pulsante "Force Scraping"
presente nella barra principale dell'applicazione. L'utilizzo di questo pulsante comporterà la cancellazione
di tutte le annotazioni automatiche non modificate presenti sulla pagina, e la ripetizione dello scraping della
stessa.
L'utilizzo di questo pulsante NON comporta la cancellazione di tutte le annotazioni manuali effettuate sulla
pagina, siano esse su frammenti o sull'intero documento.</p>
<h5><b>5.3 Temi</b></h5>
<p>E' possibile modificare il tema del pannello di visualizzazione documenti tramite il pulsante "Modifica
aspetto della pagina" presente nella barra principale dell'applicazione; esso consente di scegliere tra 3
differenti temi ("chiaro", "scuro" e "seppia"); il tema in uso di default è "chiaro".
Ecco nel dettaglio i cambiamenti che ogni tema apporta:</p>
<ul><li>"Chiaro": il colore di background del pannello è il bianco; il colore del testo è quello di default della
pagina visitata;</li>
<li>"Scuro": il colore di background del pannello è il nero; il colore del testo è modificato: bianco quando di
default sarebbe nero, e immutato per tutti gli altri colori;</li>
<li>"Seppia": il colore di background del pannello è il seppia; il colore del testo è quello di default della
pagina visitata.</li>
</ul>
<h5><b>5.4 Ritorno alla schermata principale</b></h5>
<p>Tramite il pulsante "Ritorna alla schermata principale" presente nella barra principale dell'applicazione,
è possibile effettuare un "soft reset" della pagina, ovvero pulire il pannello di visualizzazione del documento
e quello di visualizzazione delle Annotazioni sul Documento; inoltre, verranno eliminate tutte le annotazioni
non salvate presenti.</p>
</div>
</body>
</html>