report done except user evaluation section

This commit is contained in:
Claudio Maggioni 2020-12-08 14:25:09 +01:00
parent d08027718f
commit ec8199ec8d
6 changed files with 45 additions and 0 deletions

1
.gitignore vendored
View File

@ -1,5 +1,6 @@
# Solr installation
solr/**/*
**/.DS_Store
# Collection data
solr_config/data/**/*

Binary file not shown.

View File

@ -5,6 +5,8 @@
\usepackage{parskip}
\usepackage{minted}
\usepackage[utf8]{inputenc}
\usepackage{subcaption}
\usepackage{graphicx}
\setlength{\parindent}{0pt}
@ -305,6 +307,48 @@ search are a 100 results limit and the use of \texttt{t\_*} fields to match
documents (lines 25 and 23 -- remember the definition of the \texttt{text} field).
\section{User interface}
Figure \ref{fig:ui} illustrates the IR system's UI showing its features.
\begin{figure}[H]
\begin{subfigure}{\textwidth}
\centering
\includegraphics[width=0.8\textwidth]{ui_start.png}
\caption{The UI, when opened, prompts to insert a query in the input field
and press Enter. Here the user typed ``Lugano''.}
\vspace{0.5cm}
\end{subfigure}
\begin{subfigure}{0.45\textwidth}
\centering
\includegraphics[width=\textwidth]{ui.png}
\caption{After the user inputs a query and presses Enter, resulting images are shown on the
right. Found clusters are shown on the left using FoamTree.}
\end{subfigure}
\hspace{0.1\textwidth}
\begin{subfigure}{0.45\textwidth}
\centering
\includegraphics[width=\textwidth]{ui_cl.png}
\caption{When a user clicks a cluster, results are filtered depending on the
cluster clicked. If the user clicks again on the cluster, filtering is
removed.}
\end{subfigure}
\caption{The UI and its various states.}
\label{fig:ui}
\end{figure}
The UI has been implemented using HTML5, vanilla CSS and vanilla JS, with the
exception of the \textit{FoamTree} library from the Carrot2 project to handle
displaying the clustering bar to the left of search results.
Event handlers offered by \textit{FoamTree} allowed for the implementation of
the results filtering feature when a clustering in filtered.
This is a single page application, i.e. all updates to the UI happen without
making the page refresh. This was achieved by using AJAX requests to interact
with Solr.
All UI files can be found under the \texttt{ui} directory in the repository root
directory. In order to run the UI, a ``CORS Everywhere'' extension must be
installed on the viewing browser. See the installation instructions for details.
\section{User evaluation}
\end{document}

BIN
report/ui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 MiB

BIN
report/ui_cl.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

BIN
report/ui_start.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB