diff --git a/Manuale utente.pdf b/Manuale utente.pdf index 7e4d28f6..1b2f381c 100644 Binary files a/Manuale utente.pdf and b/Manuale utente.pdf differ diff --git a/SorgentiTex/Manuale utente/Poppins/OFL.txt b/SorgentiTex/Manuale utente/Poppins/OFL.txt index 76df3b56..246c977c 100644 --- a/SorgentiTex/Manuale utente/Poppins/OFL.txt +++ b/SorgentiTex/Manuale utente/Poppins/OFL.txt @@ -1,93 +1,93 @@ -Copyright 2020 The Poppins Project Authors (https://github.com/itfoundry/Poppins) - -This Font Software is licensed under the SIL Open Font License, Version 1.1. -This license is copied below, and is also available with a FAQ at: -http://scripts.sil.org/OFL - - ------------------------------------------------------------ -SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 ------------------------------------------------------------ - -PREAMBLE -The goals of the Open Font License (OFL) are to stimulate worldwide -development of collaborative font projects, to support the font creation -efforts of academic and linguistic communities, and to provide a free and -open framework in which fonts may be shared and improved in partnership -with others. - -The OFL allows the licensed fonts to be used, studied, modified and -redistributed freely as long as they are not sold by themselves. The -fonts, including any derivative works, can be bundled, embedded, -redistributed and/or sold with any software provided that any reserved -names are not used by derivative works. The fonts and derivatives, -however, cannot be released under any other type of license. The -requirement for fonts to remain under this license does not apply -to any document created using the fonts or their derivatives. - -DEFINITIONS -"Font Software" refers to the set of files released by the Copyright -Holder(s) under this license and clearly marked as such. This may -include source files, build scripts and documentation. - -"Reserved Font Name" refers to any names specified as such after the -copyright statement(s). - -"Original Version" refers to the collection of Font Software components as -distributed by the Copyright Holder(s). - -"Modified Version" refers to any derivative made by adding to, deleting, -or substituting -- in part or in whole -- any of the components of the -Original Version, by changing formats or by porting the Font Software to a -new environment. - -"Author" refers to any designer, engineer, programmer, technical -writer or other person who contributed to the Font Software. - -PERMISSION & CONDITIONS -Permission is hereby granted, free of charge, to any person obtaining -a copy of the Font Software, to use, study, copy, merge, embed, modify, -redistribute, and sell modified and unmodified copies of the Font -Software, subject to the following conditions: - -1) Neither the Font Software nor any of its individual components, -in Original or Modified Versions, may be sold by itself. - -2) Original or Modified Versions of the Font Software may be bundled, -redistributed and/or sold with any software, provided that each copy -contains the above copyright notice and this license. These can be -included either as stand-alone text files, human-readable headers or -in the appropriate machine-readable metadata fields within text or -binary files as long as those fields can be easily viewed by the user. - -3) No Modified Version of the Font Software may use the Reserved Font -Name(s) unless explicit written permission is granted by the corresponding -Copyright Holder. This restriction only applies to the primary font name as -presented to the users. - -4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font -Software shall not be used to promote, endorse or advertise any -Modified Version, except to acknowledge the contribution(s) of the -Copyright Holder(s) and the Author(s) or with their explicit written -permission. - -5) The Font Software, modified or unmodified, in part or in whole, -must be distributed entirely under this license, and must not be -distributed under any other license. The requirement for fonts to -remain under this license does not apply to any document created -using the Font Software. - -TERMINATION -This license becomes null and void if any of the above conditions are -not met. - -DISCLAIMER -THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT -OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE -COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL -DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM -OTHER DEALINGS IN THE FONT SOFTWARE. +Copyright 2020 The Poppins Project Authors (https://github.com/itfoundry/Poppins) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/SorgentiTex/Manuale utente/firstpage.tex b/SorgentiTex/Manuale utente/firstpage.tex index 119bdb98..6f30451b 100644 --- a/SorgentiTex/Manuale utente/firstpage.tex +++ b/SorgentiTex/Manuale utente/firstpage.tex @@ -1,75 +1,75 @@ -\begin{titlepage} - \thispagestyle{empty} - \begin{tikzpicture}[remember picture, overlay] - % TRIANGOLI - \draw[fill=secondarycolor, secondarycolor] (current page.north west) -- (current page.south west) -- (8.8, -28); - \draw[fill=primarycolor, primarycolor] (-3, 5) -- (4, -13.6) -- (11, 5); - - % LOGO - \node [xshift=-5cm, yshift=25cm] (logo) at (current page.south east) {\includegraphics[width=6.5cm]{img/logo.png}}; - - % SWEETCODE - DATE - \node [anchor=north east, align=right, xshift=-1.2cm, yshift=20.5cm, text=black] (sweetcode) at (current page.south east) {\fontsize{32pt}{36pt}\selectfont SWEetCode}; - \draw[line width=4pt, lightcol] ([xshift=-3cm, yshift=-0.37cm]sweetcode.south west) -- ([yshift=-0.37cm]sweetcode.south east); - \node [anchor=north east, align=right, xshift=-1.2cm, yshift=18.7cm, text=black] (date) at (current page.south east){\fontsize{24pt}{24pt} \selectfont \data}; - - % NOME FILE - \node [anchor=north east, text width=15cm, align=right, xshift=-1.2cm, yshift=17cm, text=black] (titolo) at (current page.south east){\fontsize{48pt}{48pt}\textbf{\titolo}}; - - % BOX DATI PARTECIPANTI - \node[anchor=north east, xshift=-1.2cm, yshift=12cm, minimum width=8cm] (box) at (current page.south east){}; - - % VERSIONE - % \node[anchor=north west, align=left] (dati1) at (box.north west) {\fontsize{16pt}{16pt}\selectfont \textbf{Versione}}; - % \draw[line width=4pt, lightcol] (dati1.south west) -- ([xshift=8cm]dati1.south west); - % \node[anchor=north west, align=left] (dati11) at (dati1.south west) - - % COMPONENTI DEL GRUPPO - \node[anchor=north west, yshift=-1cm, align=left] (dati1) at (box.north west) {\fontsize{16pt}{16pt}\selectfont \textbf{Componenti del gruppo}}; - \draw[line width=4pt, lightcol] (dati1.south west) -- ([xshift=8cm]dati1.south west); - - \node[anchor=north west, align=left] (dati11) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Bresolin G.}; - \node[anchor=north west, yshift=-0.7cm, align=left] (dati12) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Campese M.}; - \node[anchor=north west, yshift=-1.4cm, align=left] (dati13) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Ciriolo I.}; - \node[anchor=north west, yshift=-2.1cm, align=left] (dati14) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Dugo A.}; - \node[anchor=north west, yshift=-2.8cm, align=left] (dati15) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Feltrin E.}; - \node[anchor=north west, yshift=-3.5cm, align=left] (dati16) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Michelon R.}; - \node[anchor=north west, yshift=-4.2cm, align=left] (dati17) at (dati1.south west) - {\fontsize{14pt}{14pt}\selectfont Orlandi G.}; - - % COMPONENTI DEL GRUPPO - % \node[anchor=north west, yshift=-1cm, align=left] (dati2) at (dati11.north west) {\fontsize{16pt}{16pt}\selectfont \textbf{Componenti del gruppo}}; - % \draw[line width=4pt, lightcol] (dati2.south west) -- ([xshift=8cm]dati2.south west); - - % \node[anchor=north west, align=left] (dati21) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Bresolin G.}; - % \node[anchor=north west, yshift=-0.7cm, align=left] (dati22) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Campese M.}; - % \node[anchor=north west, yshift=-1.4cm, align=left] (dati23) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Ciriolo I.}; - % \node[anchor=north west, yshift=-2.1cm, align=left] (dati24) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Dugo A.}; - % \node[anchor=north west, yshift=-2.8cm, align=left] (dati25) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Feltrin E.}; - % \node[anchor=north west, yshift=-3.5cm, align=left] (dati26) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Michelon R.}; - % \node[anchor=north west, yshift=-4.2cm, align=left] (dati27) at (dati2.south west) - % {\fontsize{14pt}{14pt}\selectfont Orlandi G.}; - - % UNIPD - SWE - \node [xshift=4.4cm, yshift=2.3cm, draw, secondarycolor, text=white] (uni) at (current page.south west) {\fontsize{20pt}{20pt} \selectfont Università di Padova}; - \node [xshift=0.65cm, yshift=0.7cm, draw, secondarycolor, text=white, below=of uni] (corso) {\fontsize{20pt}{20pt}\selectfont Ingegneria del Software}; - - % FIRMA - % \draw[line width=4pt, lightcol] ([xshift=-1.2cm, yshift=1.8cm]current page.south east) -- ([xshift=-8cm, yshift=1.8cm]current page.south east); - % \node[anchor=north west, xshift=12.9cm, yshift=1.45cm, align=left] at (current page.south west) - % {\fontsize{13pt}{13pt}\selectfont L'Amministratore: Feltrin E.}; - - \end{tikzpicture} +\begin{titlepage} + \thispagestyle{empty} + \begin{tikzpicture}[remember picture, overlay] + % TRIANGOLI + \draw[fill=secondarycolor, secondarycolor] (current page.north west) -- (current page.south west) -- (8.8, -28); + \draw[fill=primarycolor, primarycolor] (-3, 5) -- (4, -13.6) -- (11, 5); + + % LOGO + \node [xshift=-5cm, yshift=25cm] (logo) at (current page.south east) {\includegraphics[width=6.5cm]{img/logo.png}}; + + % SWEETCODE - DATE + \node [anchor=north east, align=right, xshift=-1.2cm, yshift=20.5cm, text=black] (sweetcode) at (current page.south east) {\fontsize{32pt}{36pt}\selectfont SWEetCode}; + \draw[line width=4pt, lightcol] ([xshift=-3cm, yshift=-0.37cm]sweetcode.south west) -- ([yshift=-0.37cm]sweetcode.south east); + \node [anchor=north east, align=right, xshift=-1.2cm, yshift=18.7cm, text=black] (date) at (current page.south east){\fontsize{24pt}{24pt} \selectfont \data}; + + % NOME FILE + \node [anchor=north east, text width=15cm, align=right, xshift=-1.2cm, yshift=17cm, text=black] (titolo) at (current page.south east){\fontsize{48pt}{48pt}\textbf{\titolo}}; + + % BOX DATI PARTECIPANTI + \node[anchor=north east, xshift=-1.2cm, yshift=12cm, minimum width=8cm] (box) at (current page.south east){}; + + % VERSIONE + % \node[anchor=north west, align=left] (dati1) at (box.north west) {\fontsize{16pt}{16pt}\selectfont \textbf{Versione}}; + % \draw[line width=4pt, lightcol] (dati1.south west) -- ([xshift=8cm]dati1.south west); + % \node[anchor=north west, align=left] (dati11) at (dati1.south west) + + % COMPONENTI DEL GRUPPO + \node[anchor=north west, yshift=-1cm, align=left] (dati1) at (box.north west) {\fontsize{16pt}{16pt}\selectfont \textbf{Componenti del gruppo}}; + \draw[line width=4pt, lightcol] (dati1.south west) -- ([xshift=8cm]dati1.south west); + + \node[anchor=north west, align=left] (dati11) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Bresolin G.}; + \node[anchor=north west, yshift=-0.7cm, align=left] (dati12) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Campese M.}; + \node[anchor=north west, yshift=-1.4cm, align=left] (dati13) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Ciriolo I.}; + \node[anchor=north west, yshift=-2.1cm, align=left] (dati14) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Dugo A.}; + \node[anchor=north west, yshift=-2.8cm, align=left] (dati15) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Feltrin E.}; + \node[anchor=north west, yshift=-3.5cm, align=left] (dati16) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Michelon R.}; + \node[anchor=north west, yshift=-4.2cm, align=left] (dati17) at (dati1.south west) + {\fontsize{14pt}{14pt}\selectfont Orlandi G.}; + + % COMPONENTI DEL GRUPPO + % \node[anchor=north west, yshift=-1cm, align=left] (dati2) at (dati11.north west) {\fontsize{16pt}{16pt}\selectfont \textbf{Componenti del gruppo}}; + % \draw[line width=4pt, lightcol] (dati2.south west) -- ([xshift=8cm]dati2.south west); + + % \node[anchor=north west, align=left] (dati21) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Bresolin G.}; + % \node[anchor=north west, yshift=-0.7cm, align=left] (dati22) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Campese M.}; + % \node[anchor=north west, yshift=-1.4cm, align=left] (dati23) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Ciriolo I.}; + % \node[anchor=north west, yshift=-2.1cm, align=left] (dati24) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Dugo A.}; + % \node[anchor=north west, yshift=-2.8cm, align=left] (dati25) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Feltrin E.}; + % \node[anchor=north west, yshift=-3.5cm, align=left] (dati26) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Michelon R.}; + % \node[anchor=north west, yshift=-4.2cm, align=left] (dati27) at (dati2.south west) + % {\fontsize{14pt}{14pt}\selectfont Orlandi G.}; + + % UNIPD - SWE + \node [xshift=4.4cm, yshift=2.3cm, draw, secondarycolor, text=white] (uni) at (current page.south west) {\fontsize{20pt}{20pt} \selectfont Università di Padova}; + \node [xshift=0.65cm, yshift=0.7cm, draw, secondarycolor, text=white, below=of uni] (corso) {\fontsize{20pt}{20pt}\selectfont Ingegneria del Software}; + + % FIRMA + % \draw[line width=4pt, lightcol] ([xshift=-1.2cm, yshift=1.8cm]current page.south east) -- ([xshift=-8cm, yshift=1.8cm]current page.south east); + % \node[anchor=north west, xshift=12.9cm, yshift=1.45cm, align=left] at (current page.south west) + % {\fontsize{13pt}{13pt}\selectfont L'Amministratore: Feltrin E.}; + + \end{tikzpicture} \end{titlepage} \ No newline at end of file diff --git a/SorgentiTex/Manuale utente/headerfooter.sty b/SorgentiTex/Manuale utente/headerfooter.sty index 6848af52..4ff93381 100644 --- a/SorgentiTex/Manuale utente/headerfooter.sty +++ b/SorgentiTex/Manuale utente/headerfooter.sty @@ -1,50 +1,50 @@ -\renewcommand{\footrulewidth}{0pt} -\renewcommand{\headrulewidth}{0pt} - -\footskip = 65pt - -\pagestyle{fancy} -\fancyhf{} -\fancyhead[L]{ -\begin{tikzpicture}[remember picture,overlay] -\node[yshift=-1.7cm] at (current page.north west) - { - \begin{tikzpicture}[remember picture, overlay] - \draw[fill=primarycolor, primarycolor] (0,0) rectangle (\paperwidth,1.7cm); - \end{tikzpicture} - }; - \node[yshift=-0.85cm, xshift=3.7cm] (logo) at (current page.north west) {\includegraphics[width=1.2cm]{img/logo.png}}; -\end{tikzpicture} -} -\fancyhead[C]{ -\begin{tikzpicture}[remember picture,overlay] - \node[xshift=-0.1cm, yshift=-0.85cm] at (current page.north) {\textbf{\titoloHeader}}; -\end{tikzpicture} -} -\fancyhead[R]{ -\begin{tikzpicture}[remember picture,overlay] - \node[xshift=-4.1cm, yshift=-0.85cm] at (current page.north east) {SWEetCode}; -\end{tikzpicture} -} - - -\fancyfoot[L]{ -\begin{tikzpicture}[remember picture,overlay] -\node at (current page.south west) - { - \begin{tikzpicture}[remember picture, overlay] - \draw[fill=secondarycolor, secondarycolor] (0,0) rectangle (\paperwidth,1.6cm); - \end{tikzpicture} - }; -\end{tikzpicture} -\href{mailto:sweetcode.team@gmail.com}{\textcolor{white}{sweetcode.team@gmail.com}} -} -\fancyfoot[C]{ -\begin{tikzpicture}[remember picture,overlay] - \node[xshift=-8.5cm, yshift=0.85cm] at (current page.south east) {\color{white}\faGithub\ \href{https://sweetcode-team.github.io/}{\textcolor{white}{sweetcode}}}; -\end{tikzpicture} - -} -\fancyfoot[R]{ -\textcolor{white}{\thepage \hspace{1pt} di \pageref*{LastPage}} +\renewcommand{\footrulewidth}{0pt} +\renewcommand{\headrulewidth}{0pt} + +\footskip = 65pt + +\pagestyle{fancy} +\fancyhf{} +\fancyhead[L]{ +\begin{tikzpicture}[remember picture,overlay] +\node[yshift=-1.7cm] at (current page.north west) + { + \begin{tikzpicture}[remember picture, overlay] + \draw[fill=primarycolor, primarycolor] (0,0) rectangle (\paperwidth,1.7cm); + \end{tikzpicture} + }; + \node[yshift=-0.85cm, xshift=3.7cm] (logo) at (current page.north west) {\includegraphics[width=1.2cm]{img/logo.png}}; +\end{tikzpicture} +} +\fancyhead[C]{ +\begin{tikzpicture}[remember picture,overlay] + \node[xshift=-0.1cm, yshift=-0.85cm] at (current page.north) {\textbf{\titoloHeader}}; +\end{tikzpicture} +} +\fancyhead[R]{ +\begin{tikzpicture}[remember picture,overlay] + \node[xshift=-4.1cm, yshift=-0.85cm] at (current page.north east) {SWEetCode}; +\end{tikzpicture} +} + + +\fancyfoot[L]{ +\begin{tikzpicture}[remember picture,overlay] +\node at (current page.south west) + { + \begin{tikzpicture}[remember picture, overlay] + \draw[fill=secondarycolor, secondarycolor] (0,0) rectangle (\paperwidth,1.6cm); + \end{tikzpicture} + }; +\end{tikzpicture} +\href{mailto:sweetcode.team@gmail.com}{\textcolor{white}{sweetcode.team@gmail.com}} +} +\fancyfoot[C]{ +\begin{tikzpicture}[remember picture,overlay] + \node[xshift=-8.5cm, yshift=0.85cm] at (current page.south east) {\color{white}\faGithub\ \href{https://sweetcode-team.github.io/}{\textcolor{white}{sweetcode}}}; +\end{tikzpicture} + +} +\fancyfoot[R]{ +\textcolor{white}{\thepage \hspace{1pt} di \pageref*{LastPage}} } \ No newline at end of file diff --git a/SorgentiTex/Manuale utente/img/Screen/cancelupload.png b/SorgentiTex/Manuale utente/img/Screen/cancelupload.png new file mode 100644 index 00000000..896bc767 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/cancelupload.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/chatbotlist.png b/SorgentiTex/Manuale utente/img/Screen/chatbotlist.png new file mode 100644 index 00000000..c006f021 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/chatbotlist.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/chatbotpage.png b/SorgentiTex/Manuale utente/img/Screen/chatbotpage.png new file mode 100644 index 00000000..fcac847e Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/chatbotpage.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/chathistory.png b/SorgentiTex/Manuale utente/img/Screen/chathistory.png new file mode 100644 index 00000000..fdc4c04a Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/chathistory.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/concealdocuments.png b/SorgentiTex/Manuale utente/img/Screen/concealdocuments.png new file mode 100644 index 00000000..8e307a76 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/concealdocuments.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/concealselected.png b/SorgentiTex/Manuale utente/img/Screen/concealselected.png new file mode 100644 index 00000000..ac45e9a1 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/concealselected.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/configuration1.png b/SorgentiTex/Manuale utente/img/Screen/configuration1.png new file mode 100644 index 00000000..853b491e Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/configuration1.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/configuration2.png b/SorgentiTex/Manuale utente/img/Screen/configuration2.png new file mode 100644 index 00000000..1b8bb053 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/configuration2.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/copia.png b/SorgentiTex/Manuale utente/img/Screen/copia.png new file mode 100644 index 00000000..700ccf49 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/copia.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/dashNewChat.png b/SorgentiTex/Manuale utente/img/Screen/dashNewChat.png new file mode 100644 index 00000000..2809ad3e Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/dashNewChat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/dashboard-vis-docs.png b/SorgentiTex/Manuale utente/img/Screen/dashboard-vis-docs.png new file mode 100644 index 00000000..e5a32241 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/dashboard-vis-docs.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/dashboardpage.png b/SorgentiTex/Manuale utente/img/Screen/dashboardpage.png new file mode 100644 index 00000000..ccaad947 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/dashboardpage.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/dashstagedoc.png b/SorgentiTex/Manuale utente/img/Screen/dashstagedoc.png new file mode 100644 index 00000000..f1a7d053 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/dashstagedoc.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/delMultipleDocs.png b/SorgentiTex/Manuale utente/img/Screen/delMultipleDocs.png new file mode 100644 index 00000000..7a93c336 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/delMultipleDocs.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/delchatselected.png b/SorgentiTex/Manuale utente/img/Screen/delchatselected.png new file mode 100644 index 00000000..c977c88f Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/delchatselected.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/deldocumentsList.png b/SorgentiTex/Manuale utente/img/Screen/deldocumentsList.png new file mode 100644 index 00000000..e4f6e2cf Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/deldocumentsList.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/deletechat.png b/SorgentiTex/Manuale utente/img/Screen/deletechat.png new file mode 100644 index 00000000..003e5406 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/deletechat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/deletedocsopopup.png b/SorgentiTex/Manuale utente/img/Screen/deletedocsopopup.png new file mode 100644 index 00000000..42adc994 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/deletedocsopopup.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/deletetext.png b/SorgentiTex/Manuale utente/img/Screen/deletetext.png new file mode 100644 index 00000000..71e739b2 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/deletetext.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/dettaglidocumento.png b/SorgentiTex/Manuale utente/img/Screen/dettaglidocumento.png new file mode 100644 index 00000000..de804a51 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/dettaglidocumento.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentmanagSelect.png b/SorgentiTex/Manuale utente/img/Screen/documentmanagSelect.png new file mode 100644 index 00000000..90a0477a Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentmanagSelect.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentmanagerpage.png b/SorgentiTex/Manuale utente/img/Screen/documentmanagerpage.png new file mode 100644 index 00000000..e84fdc63 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentmanagerpage.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentsList.png b/SorgentiTex/Manuale utente/img/Screen/documentsList.png new file mode 100644 index 00000000..1a2a677b Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentsList.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentsfilter.png b/SorgentiTex/Manuale utente/img/Screen/documentsfilter.png new file mode 100644 index 00000000..9b3e2982 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentsfilter.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentssearch.png b/SorgentiTex/Manuale utente/img/Screen/documentssearch.png new file mode 100644 index 00000000..968923cf Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentssearch.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentstablepagination.png b/SorgentiTex/Manuale utente/img/Screen/documentstablepagination.png new file mode 100644 index 00000000..fa8fbac6 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentstablepagination.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/documentvisDocs.png b/SorgentiTex/Manuale utente/img/Screen/documentvisDocs.png new file mode 100644 index 00000000..0884d794 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/documentvisDocs.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/domandeanalisi.png b/SorgentiTex/Manuale utente/img/Screen/domandeanalisi.png new file mode 100644 index 00000000..f663ebb1 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/domandeanalisi.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/eliminazionechat.png b/SorgentiTex/Manuale utente/img/Screen/eliminazionechat.png new file mode 100644 index 00000000..aa4dfe13 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/eliminazionechat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/embeddocument.png b/SorgentiTex/Manuale utente/img/Screen/embeddocument.png new file mode 100644 index 00000000..a224efa2 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/embeddocument.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/embedsuccesful.png b/SorgentiTex/Manuale utente/img/Screen/embedsuccesful.png new file mode 100644 index 00000000..03a91e34 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/embedsuccesful.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/enabledocuments.png b/SorgentiTex/Manuale utente/img/Screen/enabledocuments.png new file mode 100644 index 00000000..e3f0ae21 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/enabledocuments.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/modpagechatbot.png b/SorgentiTex/Manuale utente/img/Screen/modpagechatbot.png new file mode 100644 index 00000000..54e55162 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/modpagechatbot.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/modvocale.png b/SorgentiTex/Manuale utente/img/Screen/modvocale.png new file mode 100644 index 00000000..411c883e Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/modvocale.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/modvocalestop.png b/SorgentiTex/Manuale utente/img/Screen/modvocalestop.png new file mode 100644 index 00000000..e3858eac Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/modvocalestop.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/navpages.png b/SorgentiTex/Manuale utente/img/Screen/navpages.png new file mode 100644 index 00000000..322076ec Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/navpages.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/newchat.png b/SorgentiTex/Manuale utente/img/Screen/newchat.png new file mode 100644 index 00000000..5b022209 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/newchat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/numeropagine.png b/SorgentiTex/Manuale utente/img/Screen/numeropagine.png new file mode 100644 index 00000000..339a89f0 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/numeropagine.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/nuovachatchatbot.png b/SorgentiTex/Manuale utente/img/Screen/nuovachatchatbot.png new file mode 100644 index 00000000..d5ea9a00 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/nuovachatchatbot.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/ordinamentodocs.png b/SorgentiTex/Manuale utente/img/Screen/ordinamentodocs.png new file mode 100644 index 00000000..13bdd837 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/ordinamentodocs.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/primachat.png b/SorgentiTex/Manuale utente/img/Screen/primachat.png new file mode 100644 index 00000000..faa10b58 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/primachat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/recentchatdash.png b/SorgentiTex/Manuale utente/img/Screen/recentchatdash.png new file mode 100644 index 00000000..2a5d9109 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/recentchatdash.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/recentlistdash.png b/SorgentiTex/Manuale utente/img/Screen/recentlistdash.png new file mode 100644 index 00000000..2a0c81d6 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/recentlistdash.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/ricercachat.png b/SorgentiTex/Manuale utente/img/Screen/ricercachat.png new file mode 100644 index 00000000..4c97dcfa Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/ricercachat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/rinominachat.png b/SorgentiTex/Manuale utente/img/Screen/rinominachat.png new file mode 100644 index 00000000..a9c806ec Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/rinominachat.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/rinominamatita.png b/SorgentiTex/Manuale utente/img/Screen/rinominamatita.png new file mode 100644 index 00000000..37e738d0 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/rinominamatita.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/selectchats.png b/SorgentiTex/Manuale utente/img/Screen/selectchats.png new file mode 100644 index 00000000..336d6c9c Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/selectchats.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/sendtext.png b/SorgentiTex/Manuale utente/img/Screen/sendtext.png new file mode 100644 index 00000000..daf5b607 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/sendtext.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/settings1.png b/SorgentiTex/Manuale utente/img/Screen/settings1.png new file mode 100644 index 00000000..ef621bb9 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/settings1.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/settings2.png b/SorgentiTex/Manuale utente/img/Screen/settings2.png new file mode 100644 index 00000000..b2a5b12a Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/settings2.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/stagingarea.png b/SorgentiTex/Manuale utente/img/Screen/stagingarea.png new file mode 100644 index 00000000..87c0e6d9 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/stagingarea.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/stagingareadel.png b/SorgentiTex/Manuale utente/img/Screen/stagingareadel.png new file mode 100644 index 00000000..abf07898 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/stagingareadel.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/startvoc.png b/SorgentiTex/Manuale utente/img/Screen/startvoc.png new file mode 100644 index 00000000..dd5e05fb Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/startvoc.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/substitutedocuments.png b/SorgentiTex/Manuale utente/img/Screen/substitutedocuments.png new file mode 100644 index 00000000..ec712dff Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/substitutedocuments.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/togglecolumns.png b/SorgentiTex/Manuale utente/img/Screen/togglecolumns.png new file mode 100644 index 00000000..66357c3b Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/togglecolumns.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/typemessage.png b/SorgentiTex/Manuale utente/img/Screen/typemessage.png new file mode 100644 index 00000000..19039d7a Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/typemessage.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/uploadDocs.png b/SorgentiTex/Manuale utente/img/Screen/uploadDocs.png new file mode 100644 index 00000000..2d8d6433 Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/uploadDocs.png differ diff --git a/SorgentiTex/Manuale utente/img/Screen/visualizzacontenutodocument.png b/SorgentiTex/Manuale utente/img/Screen/visualizzacontenutodocument.png new file mode 100644 index 00000000..ad662a9a Binary files /dev/null and b/SorgentiTex/Manuale utente/img/Screen/visualizzacontenutodocument.png differ diff --git a/SorgentiTex/Manuale utente/main.tex b/SorgentiTex/Manuale utente/main.tex index 65df1fa7..08a36aaf 100644 --- a/SorgentiTex/Manuale utente/main.tex +++ b/SorgentiTex/Manuale utente/main.tex @@ -1,370 +1,714 @@ -\documentclass[10pt, a4paper]{article} - -\input{parameters} - -\usepackage{style} -\usepackage{headerfooter} - -\title{\titolo} -\author{SWEetCode} - -\begin{document} - -% PRIMA PAGINA -\include{firstpage} - -% REGISTRO DELLE VERSIONI -\include{registroversioni} -\newpage - -% INDICE -\tableofcontents -\newpage - -\listoffigures -\newpage -% INIZIO PAGINE -\section{Introduzione} -\subsection{Obiettivo del documento} -Lo scopo del documento è l'illustrazione delle funzionalità del prodotto \textit{Knowledge Management AI}. Il documento include: -\begin{itemize} - \item Come configurare prodotto; - \item Descrizione dell'interfaccia utente del prodotto e le possibili interazioni con essa da parte degli utenti. -\end{itemize} -Non viene descritta l'installazione del prodotto poichè nel contesto di questo progetto le figure di utente e di installatore/manutentore sono distinte, quindi non sarà l'utente a provvedere all'installazione dei software necessari all'uso dell'applicazione. -\subsection{Glossario} -Per evitare ambiguità e incomprensioni relative al linguaggio e ai termini utilizzati nella documentazione relativa al progetto viene presentato un Glossario. I termini ambigui o specifici presenti nello stesso, verranno identificati con un pedice |g|. All’interno dei documenti viene identificata con tale scrittura solo e soltanto la prima occorrenza presente nel testo di un termine definito nel Glossario. - -\subsection{Riferimenti} -\subsubsection{Riferimenti normativi} -\begin{itemize} - \item \textit{(Norme di progetto v2.0.0(0))}; - \item \textit{Regolamento del progetto didattico}: \\ - \url{https://www.math.unipd.it/~tullio/IS-1/2023/Dispense/PD2.pdf}\\ - (Ultimo accesso: 2024-03-14); - \item \textit{Standard ISO/IEC 9126}:\\ - \url{https://it.wikipedia.org/wiki/ISO/IEC_9126}\\ - (Ultimo accesso: 2024-03-14). - \end{itemize} -\subsubsection{Riferimenti informativi} -\begin{itemize} - \item \textit{(Analisi dei requisiti v2.0.0(0))}; - \item \textit{Capitolato C1}: \textit{Knowledge Management AI}: \\ \url{https://www.math.unipd.it/~tullio/IS-1/2023/Progetto/C1.pdf}\\ - (Ultimo accesso: 2024-02-08); - - \end{itemize} - -\newpage - - -\section{Istruzioni per l'utente} -Questa sezione comprende le istruzioni per l'uso del prodotto delle funzionalità disponibili all'utente (attore). -\subsection{Configurazione utente} -La configurazione permette all'utente di selezionare le diverse componenti del prodotto al primo avvio dell'applicazione. Al primo avvio viene infatti visualizzata una schermata di selezione della configurazione che impedisce all'utente di utilizzare l'applicazione se non viene compilata.\\ Si elencano qui le diverse componenti da selezionare. -\subsubsection{Selezione della configurazione} -Questa funzionalità richiede all'utente di selezionare la configurazione che desidera tramite la schermata iniziale. Per farlo è sufficiente selezionare con un clic tutte le componenti desiderate (scorrendo verticalmente con il mouse ed orizzontalmente con le frecce ni vari menù) e per finire premere il bottone 'Confirm configuration' nel fondo della pagina.\\ Le varie azioni obbligatorie da operare sono: -\begin{itemize} - \item \textbf{Selezione del modello LLM}: Un LLM (\textit{Large Language Model}) è un modello di intelligenza artificiale che utilizza tecniche di \textit{machine learning} per comprendere e generare linguaggio umano. È quindi possibile selezionare il modello che interagirà con l'utente tramite il chatbot, ed è possibile scegliere tra i modelli di \textit{Huggingface} e \textit{OpenAI}; - \item \textbf{Selezione del vector store}: Un database vettoriale è un tipo di database che indicizza e memorizza embeddings vettoriali per un recupero rapido e una ricerca di similarità. È possibile scegliere tra quelli proposti da \textit{Pinecone} o \textit{ChromaDB}; - \item \textbf{Selezione del sistema di archiviazione}: È possibile la selezione del sistema di archiviazione dei documenti (al momento è possibile solo la scelta del sistema di \textit{Amazon Web Services}); - \item \textbf{Selezione del modello di embeddings}: Il modello di embeddings da selezionare si occupa della trasformazione dei documenti in embeddings. È possibile selezionare i modelli di \textit{Huggingface} oppure \textit{OpenAI}. -\end{itemize} - -Le altre funzionalità che si possono operare sulla configurazione utente si elencano in seguito. -\subsubsection{Visualizzazione configurazione corrente} -Per visualizzare che vector database, modello di embeddings, sistema di archiviazione e modello LLM sono attualmente configurati nell'applicazione è necessario: -\begin{itemize} - \item Premere dalla dashboard il simbolo delle impostazioni, posto in basso a sinistra della pagina e accompagnato dalla scritta 'Settings'; - \item Visualizzare la configurazione corrente sotto il rispettivo titolo 'Current configuration', scorrendo con le frecce poste a destra e sinistra del menù slider con i vari elementi della configurazione attuale. -\end{itemize} - -\subsubsection{Cambiamento del modello LLM selezionato} -È possibile per l'utente cambiare il modello LLM che risponde alle domande poste al chatbot, in questo modo: -\begin{itemize} - \item Dalla dashboard premere il simbolo delle impostazioni, posto in basso a sinistra della pagina e accompagnato dalla scritta 'Settings'; - \item Selezionare dal menù che si apre automaticamente in alto alla sinistra della pagina la sezione 'Configuration' (quando vengono aperte le informazioni si apre di default); - \item Selezionare dal menù che compare sotto al titolo 'LLM Models' il modello LLM desiderato; - \item Premere il bottone con su scritto 'Confirm configuration'. -\end{itemize} - -\subsection{Gestione dei documenti} -In questa sezione si illustrano le possibili azioni operabili sui documenti. -\subsubsection{Visualizzazione lista dei documenti} -\begin{itemize} - \item \textbf{Visualizzazione lista documenti recenti}: Nella parte inferiore della dashboard è resa disponibile la lista dei documenti più recentemente visualizzati. - \begin{itemize} - \item Per visualizzare la lista dei documenti più recentemente caricati, selezionare l'opzione 'Recently updated' che figura sotto al titolo della sezione ('Recent documents'); - \item Per visualizzare la lista dei documenti più recentemente visualizzati, selezionare l'opzione 'Recently viewed' che figura sotto al titolo della sezione ('Recent documents') e alla destra dell'opzione precedentemente descritta. - \end{itemize} - \item \textbf{Visualizzazione lista di tutti i documenti}: Per visualizzare la lista di tutti i documenti presenti nel sistema di archiviazione è necessario: - \begin{itemize} - \item Selezionare l'opzione 'Documents' dal menù in alto a sinistra della dashboard; - \item Visualizzare la parte inferiore della pagina, sotto il titolo 'List of documents'. Alla destra di ogni documento della lista si visualizzano titolo, dimensioni, stato, tipo e data di caricamento. - \end{itemize} -\end{itemize} - -\subsubsection{Visualizzazione tabella di archiviazione} -\begin{itemize} - -\item \textbf{Visualizzazione delle colonne}: Come accennato in precedenza nella lista dei documenti vengono visualizzate delle informazioni (titolo, dimensioni, stato, tipo e data di caricamento) per ogni documento presente nel sistema di archiviazione.\\ Nel caso in cui si vogliano visualizzare meno informazioni riguardo i documenti, quindi modificare il numero di colonne nella tabella delle informazioni, è necessario: -\begin{itemize} - \item Visualizzare lista di tutti i documenti come indicato in 2.2.1.; - \item Fare clic sul bottone 'View' in alto a destra nella lista dei documenti; - \item Spuntare dall'elenco che compare automaticamente il titolo delle colonne che si intende rimuovere dalla tabella di visualizzazione della lista (non è possibile rimuovere la colonna del titolo dei documenti), che verranno rimosse in automatico; - \item Se successivamente si vuole ripristinare una colonna eliminata, è sufficiente ripetere l'operazione e fare un altro clic sul suo titolo perchè vengano automaticamente ripristinate. -\end{itemize} -In alternativa per compiere la stessa azione è possibile anche: -\begin{itemize} - \item Visualizzare lista di tutti i documenti come indicato in 2.2.1.; - \item Fare un clic in corrispondenza del titolo della colonna che non si vuole più visualizzare; - \item Selezionare l'opzione 'Hide' dal menù che comparirà automaticamente. -\end{itemize} - -\item \textbf{Scorrimento orizzontale}: Se il numero di documenti presenti nel sistema di archiviazione è elevato, la tabella viene rappresentata su più pagine. Per passare da una pagina all'altra è necessario: -\begin{itemize} - \item Visualizzare lista di tutti i documenti come indicato in 2.2.1.; - \item Scorrere la tabella fino all'ultima riga; - \item Selezionare il pulsante raffigurante '>' per andare avanti di una pagina, e quello raffigurante '<' per tornare indietro di una pagina; - \item Selezionare il pulsante raffigurante '>>' per visualizzare l'ultima pagina della tabella, e quello raffigurante '<<' per visualizzarne la prima pagina; - \item Quando ci si trova nella prima o nell'ultima pagina le azioni per andare avanti (nel caso dell'ultima pagina) o indietro (nel caso della prima pagina) sono bloccate poichè ci si trova già all'estremo. -\end{itemize} -\item \textbf{Numero di righe}: È possibile modificare il numero di righe che si vuole compaiano in ogni pagina della tabella in questo modo: -\begin{itemize} - \item Visualizzare lista di tutti i documenti come indicato in 2.2.1.; - \item Scorrere la tabella fino all'ultima riga; - \item Selezionare il bottone in basso a destra che indica il numero di righe per pagina presenti al momento, al fianco della scritta 'Rows per page'; - \item Selezionare il numero di righe che si vuole visualizzare dall'elenco che compare automaticamente. -\end{itemize} -\item \textbf{Ordinamento}: Per ordinare in ordine crescente o decrescente in base ad un determinato parametro gli elementi della tabella è necessario: -\begin{itemize} - \item Visualizzare lista di tutti i documenti come indicato in 2.2.1.; - \item Fare clic sul titolo del parametro di ordinamento desiderato (deve essere uno dei titoli delle colonne della tabella); - \item Selezionare dal menù che si aprirà automaticamente l'opzione 'Asc' se si desidera un ordinamento ascendente rispetto a tale parametro, o 'Desc' se si desidera un ordinamento discendente rispetto a tale parametro. -\end{itemize} -\item \textbf{Selezione degli elementi}: Per selezionare gli elementi della tabella è necessario: -\begin{itemize} - \item Visualizzare la parte sinistra della tabella e spuntare il quadrato che compare alla sinistra del titolo dell'elemento desiderato; - \item Se si vogliono selezionare tutti gli elementi della tabella, fare clic sul quadrato vuoto alla sinistra della colonna 'Title', in alto alla tabella. -\end{itemize} -\end{itemize} -\subsubsection{Visualizzazione contenuto documenti} -Per visualizzare il contenuto di un documento è necessario: -\begin{itemize} - \item Visualizzare lista dei documenti come indicato in 2.2.1.; - \item Selezionare con due clic il documento desiderato dalla lista, che si aprirà automaticamente. -\end{itemize} -È anche possibile visualizzare il contenuto di un documento dalla dashboard, in questo modo: -\begin{itemize} - \item Nella parte inferiore della dashboard sono presenti i documenti recenti. Selezionare con un clic il documento desiderato da tale lista; - \item Compariranno informazioni aggiuntive sul documento in questione. Selezionare l'opzione 'View content' per aprire il documento, oppure 'Close' per chiudere il pop up. -\end{itemize} -\subsubsection{Rimozione dal sistema di archiviazione} -Per eliminare un documento dal sistema di archiviazione è necessario: -\begin{itemize} - \item Selezionare dal menù in alto a sinistra nella dashboard la sezione 'Documents'; - \item Visualizzare la parte inferiore della pagina, sotto il titolo 'List of documents', ed individuare il documento che si intende rimuovere dal sistema di archiviazione; - \item Premere il pulsante dei tre puntini verticali situato all'estrema destra della riga del rispettivo documento; - \item Fare clic sul bottone 'Delete'; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} -Per eliminare più documenti dal sistema di archiviazione è necessario: -\begin{itemize} - \item Selezionare dal menù in alto a sinistra nella dashboard la sezione 'Documents'; - \item Visualizzare la parte inferiore della pagina, sotto il titolo 'List of documents', e selezionare spuntando con un clic la casella a sinistra nella riga di ogni documento che si intende rimuovere dal sistema di archiviazione; - \item Premere il pulsante rosso con l'icona di un cestino che compare automaticamente alla selezione; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} - -\subsubsection{Caricamento e rimozione dall'area di staging} -Per caricare uno o più documenti nell'area di staging è necessario: -\begin{itemize} - \item Cliccare il bottone 'Carica documento' presente in alto a sinistra nella dashboard, che aprirà automaticamente la pagina 'Documents'.\\ - In alternativa, selezionare l'opzione 'Documents' nel menù in alto a sinistra della dashboard; - \item Trascinare nell'apposito spazio (all'interno del rettangolo tratteggiato con scritto all'interno 'Click to upload or drag and drop') il documento (o i documenti) da caricare oppure fare un clic all'interno dell'area e selezionarli dalla lista dei documenti personali che si aprirà automaticamente; - \item Se si sbaglia ad inserire un documento, premere l'icona del cestino che compare a destra del titolo del documento nell'area di staging, che verrà rimosso; - \item Se si vogliono aggiungere ulteriori documenti, l'area rettangolare tratteggiata per l'upload resterà comunque disponibile sulla destra della pagina; - \item Se si cambia idea e non è più necessario fare l'upload del documento (o dei documenti) inseriti nell'area di staging, selezionare il bottone 'Cancel upload' che si trova sotto all'area di staging; - \item Se nell'area di staging è già presente un documento (o più documenti) con lo stesso nome e formato di quello (o quelli) selezionato/i, viene visualizzato un pop up di errore in basso a destra, dato che non è possibile inserire due documenti uguali nell'area di staging.\\ Se i due documenti dovessero avere stesso nome e formato ma dovessero essere diversi, si prega di rinominare il secondo documento in questione e caricarlo nuovamente nell'area di staging; - \item Se si prova ad inserire nell'area di staging un documento con un formato non leggibile dall'applicazione viene visualizzato un pop up di errore in basso a destra. - \end{itemize} - - -\subsubsection{Upload nel sistema di archiviazione e nel vector database dall'area di staging} -Per poter fare l’upload nel sistema di archiviazione e nel vector database dei documenti caricati nell’area di staging è necessario: -\begin{itemize} - \item Caricare nell'area di staging uno o più documenti da inserire nel sistema, seguendo le istruzioni del punto 2.2.5; - \item Per eseguire l'upload del documento (o dei documenti) selezionare il pulsante 'Upload documents' che si trova sotto all'area di staging; - \item Se nel sistema di archiviazione è già presente un documento (o più documenti) con lo stesso nome e formato di quello (o quelli) di cui si sta facendo l'upload comparirà un avviso in centro alla pagina che segnala che sono presenti documenti duplicati. \\L'avviso permetterà di decidere quali documenti sovrascrivere e quali lasciare invariati, tramite un elenco in cui si devono spuntare i nomi dei documenti che si vuole sovrascrivere; - \item Una volta selezionati i documenti da sovrascrivere, premere 'Submit' per confermare o 'Cancel' per annullare l'azione. - - -\end{itemize} -\subsubsection{Occultamento dal sistema} -Per occultare un documento presenti nel sistema di archiviazione è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Trovare il documento che si desidera occultare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente; - \item Selezionare l'opzione 'Conceal' dall'elenco che compare automaticamente; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Conceal' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} -Per occultare più documenti presenti nel sistema di archiviazione è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Trovare i documenti che si desidera occultare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento da occultare, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Enabled', altrimenti non sarà possibile proseguire; - \item Selezionare l'opzione 'Conceal' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Conceal' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} -\subsubsection{Riabilitazione dal sistema} -Per riabilitare un documento occultato nel sistema di archiviazione è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Trovare il documento che si desidera riabilitare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente; - \item Selezionare l'opzione 'Enable' dall'elenco che compare automaticamente; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Enable' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} - -Per riabilitare più documenti presenti nel sistema di archiviazione è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Trovare i documenti che si desidera riabilitare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento da riabilitare, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Concealed', altrimenti non sarà possibile proseguire; - \item Selezionare l'opzione 'Enable' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Enable' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} - -\subsubsection{Incorporazione (Embed) da lista dei documenti} -Per incorporare nel sistema un documento è necessario: -\begin{itemize} - \item Aprire la lista di tutti i documenti secondo i passaggi della sezione 2.2.1; - \item Trovare il documento che si desidera incorporare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente; - \item Selezionare l'opzione 'Embed' dall'elenco che compare automaticamente; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Embed' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} -Per incorporare più documenti presenti nel sistema di archiviazione è necessario: -\begin{itemize} - \item Aprire la lista di tutti i documenti secondo i passaggi della sezione 2.2.1; - \item Trovare i documenti che si desidera incorporare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Not Embedded', altrimenti non sarà possibile proseguire; - \item Selezionare l'opzione 'Embed' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Embed' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} - -\subsubsection{Ricerca nel sistema} -Per cercare un documento presente nel sistema di archiviazione in base al suo titolo è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Fare clic sulla barra di ricerca (con scritto all'interno 'Filter by title') situata in alto a sinistra della sezione 'List of documents'; - \item Digitare il titolo del documento ricercato. -\end{itemize} -Per cercare un documento presente nel sistema di archiviazione in base al suo stato è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Fare clic sul bottone 'Status', affiancato da un'icona raffigurante il simbolo '+', situato a destra della barra di ricerca per titolo, in alto a sinistra nella lista dei documenti; - \item Selezionare dall'elenco che compare automaticamente lo stato del documento che si sta cercando, o digitare il nome dello stato desiderato nella barra di ricerca che compare sopra l'elenco. -\end{itemize} -Per cercare un documento presente nel sistema di archiviazione in base al suo formato è necessario: -\begin{itemize} - \item Aprire la lista dei documenti nel sistema di archiviazione secondo i passaggi della sezione 2.2.1; - \item Fare clic sul bottone 'Type', affiancato da un'icona raffigurante il simbolo '+', situato a destra della barra di ricerca per titolo e di quella per stato, in alto a sinistra nella lista dei documenti; - \item Selezionare dall'elenco che compare automaticamente il formato del documento che si sta cercando, o digitare il nome del formato desiderato nella barra di ricerca che compare sopra l'elenco. -\end{itemize} -È inoltre possibile combinare tutte le funzioni di ricerca tra loro, quindi per esempio si può effettuare la ricerca di un documento inserendone titolo, stato e formato ricercati. \\ Per annullare le selezioni dei filtri di ricerca è sufficiente cliccare sul pulsante 'Reset' (affiancato dal simbolo 'X') che compare automaticamente dopo la selezione di un filtro di ricerca, situato a destra del pulsante di ricerca per formato. -\subsection{Gestione delle chat} -In questa sezione si illustrano le possibili azioni operabili sulle chat dell'applicazione. -\subsubsection{Visualizzazione} -Le azioni possibili di visualizzazione delle chat sono le seguenti: -\begin{itemize} - \item \textbf{Visualizzazione chat più recente}: È possibile visualizzare la chat più recente nella parte in alto a sinistra della dasboard. Selezionando il pulsante 'Espandi' in alto a destra della chat, sarà disponibile a schermo intero; - \item \textbf{Visualizzazione lista chat più recenti}: Per visualizzare le chat più recenti è sufficiente visualizzare la parte destra della dashboard dell'applicazione, sotto il titolo 'Recently visited chats', dove è possibile visualizzare le singole chat presenti in lista automaticamente con il rispettivo titolo in ordine cronologico. Vengono visualizzati inoltre il timestamp dell'ultimo messaggio presente per ogni chat (nella rispettiva riga in alto a destra), la preview dell'ultimo messaggio presente della chat (appena sotto al titolo) e la preview dell'ultimo mittente di una chat.\\ - Facendo un clic sul riquadro di una chat recente dalla lista è possibile aprire tale chat. - \item \textbf{Visualizzazione lista chat}: Se si comincia una conversazione con il chatbot o se si seleziona l'opzione 'Chatbot' dal menù in alto a sinistra della dashboard, la lista delle chat dell'applicazione è resa disponibile nella parte sinistra della pagina. Nella lista vengono visualizzati il timestamp dell'ultimo messaggio presente per ogni chat (nella rispettiva riga in alto a destra), la preview dell'ultimo messaggio presente della chat (appena sotto al titolo) e la preview dell'ultimo mittente di una chat. -\end{itemize} - -\subsubsection{Creazione, eliminazione, rinominazione} -Per creare una nuova chat è necessario: -\begin{itemize} - \item Selezionare il bottone 'Nuova chat' in alto a sinistra nella dashboard; - \item In alternativa, selezionare dal menù in alto a sinistra l'opzione 'Chatbot' e selezionare il bottone blu con il simbolo '+' in alto a sinistra nella pagina che varrà aperta (pagina 'Chatbot'), a destra del titolo 'Chat list'. -\end{itemize} -Per eliminare una chat è necessario: -\begin{itemize} - \item Selezionare dal menù in alto a sinistra della dashboard l'opzione 'Chatbot'; - \item Selezionare con un clic la chat che si vuole eliminare dalla lista delle chat sulla sinistra della pagina. Se non si trova, è possibile ricercare la chat desiderata secondo le istruzioni del paragrafo 2.2.3 ('Ricerca'); - \item Selezionare il pulsante rosso in alto a destra della chat, con raffigurato il simbolo del cestino (che si sarà aperta automaticamente dopo l'azione precedente); - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} -Per eliminare più chat è necessario: -\begin{itemize} - \item Selezionare dal menù in alto a sinistra della dashboard l'opzione 'Chatbot'; - \item Selezionare con un clic il bottone alla destra della barra di ricerca appena sotto il titolo 'Chat list', che raffigura il simbolo della selezione; - \item Selezionare le chat che si desidera eliminare. Se si sbaglia la selezione, selezionare il bottone che compare in alto a destra raffigurante una freccia che punta all'indietro per annullare la selezione; - \item Una volta selezionate le chat da eliminare, premere il pulsante rosso che compare in alto a destra, raffigurante due fogli con il simbolo 'X'; - \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. -\end{itemize} -Per rinominare una chat è necessario: -\begin{itemize} - \item Selezionare dal menù in alto a sinistra della dashboard l'opzione 'Chatbot'; - \item Selezionare con un clic la chat che si vuole rinominare dalla lista delle chat sulla sinistra della pagina. Se non si trova, è possibile ricercare la chat desiderata secondo le istruzioni del paragrafo 2.2.3 ('Ricerca'); - \item Selezionare il pulsante in alto a destra della chat, con raffigurato il simbolo di una matita che scive; - \item Inserire il nuovo titolo della chat; - \item Premere invio. -\end{itemize} - -\subsubsection{Ricerca} -Per cercare una chat o il contenuto di essa all'interno della lista delle chat è necessario: -\begin{itemize} - \item Recarsi nella sezione 'Chatbot' nel menù in alto a sinistra della dashboard; - \item Fare clic sull'apposita barra di ricerca con sopra la dicitura 'Cerca una chat' (e con all'interno la dicitura 'Cerca') situata nella parte sinistra della pagina, nella sezione 'Lista chat'; - \item Digitare il titolo o il contenuto che si desidera cercare; - \item Premere invio. -\end{itemize} -%\subsubsection{Visualizzazione contenuto e messaggi} -%Per visualizzare il contenuto ed i singoli messaggi di una chat è necessario: -%\begin{itemize} - % \item Fare clic sulla chat che si intende leggere dalla lista delle chat. È possibile farlo sia dalla dashboard, selezionando la chat dalla lista delle ultime chat in alto a destra, o aprendo la pagina 'Chatbot' dal menù in alto a sinistra della dashboard e selezionandola dalla lista delle chat a sinistra nella pagina. -%\end{itemize} -%La chat desiderata verrà automaticamente aperta per la lettura. Ne vengono quindi visualizzati il contenuto testuale e l'orario dei singoli messaggi (in basso a sinistra rispetto ai messaggi). -%\subsubsection{Domande suggerite} -%Se la chat è vuota vengono visualizzate (DOVE?) di default delle domande suggerite che possono essere poste al chatbot. Per selezionare una domanda è sufficiente selezionarla con un clic e confermarne l'invio selezionando l'opzione ... -\subsubsection{Inserimento, invio e copia} -Per inserire un messaggio nell'area di testo di una chat è necessario: -\begin{itemize} - \item Recarsi nella sezione 'Chatbot' dal menù in alto a sinistra nella dashboard; - \item Digitare il testo del messaggio da inserire nell'apposito spazio in basso alla chat, nella barra con su scritto 'Type your message...'; - \item Se si sbaglia ad inserire il testo del messaggio è possibile cancellarlo selezionando il bottone arancione raffigurante una gomma che compare automaticamente a destra della barra di inserimento testuale dopo l'inserimento del primo carattere; - \item Una volta scritto un messaggio, per inserirlo nella chat (quindi per inviarlo) si deve fare clic sul bottone a destra della casella per l'inserimento testuale, raffigurante un aeroplanino. -\end{itemize} -Per poi copiare un messaggio è necessario fare clic sull'apposita icona con il simbolo di copia posta in alto al fianco di ogni messaggio della chat. -\subsubsection{Visualizzazione di documento da chat} -Quando il chatbot fornisce una risposta contenente uno o più documenti, è possibile visualizzarli facendo clic sul bottone 'Vedi' alla destra del rispettivo documento inviato dal chatbot. -\subsubsection{Modalità vocale} -È possibile utilizzare la modalità vocale, quindi inserire un messaggio in una chat tramite comando vocale, in questo modo: -\begin{itemize} - \item Recarsi nella pagina 'Chatbot' dal menù in alto a sinistra della dashboard; - \item Fare clic sul bottone del microfono a sinistra della casella di inserimento testuale; - \item Scandire ad alta voce il testo del messaggio che si desidera inserire; - \item Selezionando il bottone rosso con il simbolo delle due barre in verticale è possibile mettere in pausa la registrazione per poi riprenderla selezionando il pulsante raffigurante una freccia; - \item Quando finito, premere il bottone rosso con il quadrato a sinistra della casella di inserimento testuale; - \item Se si desidera eliminare il messaggio selezionare il pulsante rosso raffigurante il cestino; - \item Se si desidera inviare il messaggio fare clic sul bottone a destra della casella per l'inserimento testuale, raffigurante un aeroplanino. -\end{itemize} -Per ascoltare un messaggio tramite audio è necessario ... - -\subsection{Altre funzionalità} -\subsubsection{Cambio del tema di sfondo} -L'interfaccia dell'applicazione è disponibile in tema chiaro o scuro. Per cambiare tema è necessario: -\begin{itemize} - \item Dalla dashboard premere il simbolo delle impostazioni, posto in basso a sinistra della pagina e accompagnato dalla scritta 'Settings'; - \item Dal menù delle impostazioni, in alto a sinistra della pagina che si sarà aperta automaticamente, selezionare la voce 'Appearence'; - \item Selezionare il tema di sfondo desiderato; - \item Premere il bottone in basso con su scritto 'Update preferences'. Comparirà successivamente un pop up in basso a destra per segnalare il successo dell'operazione. -\end{itemize} -\subsubsection{Adattamento delle dimensioni} -Per modificare le dimensioni delle varie sezioni presenti nelle diverse pagine è necessario: -\begin{itemize} - \item Aprire la pagina desiderata dal menù a sinistra; - \item Posizionarsi con il mouse sulla linea che divide le sezioni della pagina; - \item Premere e trascinare l'icona dei sei puntini presente sulla linea in corrispondenza della metà della sua altezza, fino alla dimensione desiderata. -\end{itemize} - - - +\documentclass[10pt, a4paper]{article} + +\input{parameters} + +\usepackage{style} +\usepackage{headerfooter} + +\title{\titolo} +\author{SWEetCode} + +\begin{document} + +% PRIMA PAGINA +\include{firstpage} + +% REGISTRO DELLE VERSIONI +\include{registroversioni} +\newpage + +% INDICE +\tableofcontents +\newpage + +\listoffigures +\newpage +% INIZIO PAGINE +\section{Introduzione} +\subsection{Obiettivo del documento} +Lo scopo del documento è l'illustrazione delle funzionalità del prodotto \textit{Knowledge Management AI}. Il documento include: +\begin{itemize} + \item Come configurare prodotto; + \item Descrizione dell'interfaccia utente del prodotto e le possibili interazioni con essa da parte degli utenti. +\end{itemize} +Non viene descritta l'installazione del prodotto poichè nel contesto di questo progetto le figure di utente e di installatore/manutentore sono distinte, quindi non sarà l'utente a provvedere all'installazione dei software necessari all'uso dell'applicazione. + + +\subsection{Riferimenti} +\subsubsection{Riferimenti normativi} +\begin{itemize} + \item \textit{Regolamento del progetto didattico}: \\ + \url{https://www.math.unipd.it/~tullio/IS-1/2023/Dispense/PD2.pdf}\\ + (Ultimo accesso: 2024-03-14); + \item \textit{Standard ISO/IEC 9126}:\\ + \url{https://it.wikipedia.org/wiki/ISO/IEC_9126}\\ + (Ultimo accesso: 2024-03-14). + \end{itemize} +\subsubsection{Riferimenti informativi} +\begin{itemize} + \item \textit{(Analisi dei requisiti v3.0.0(0))}; + \item \textit{Capitolato C1}: \textit{Knowledge Management AI}: \\ \url{https://www.math.unipd.it/~tullio/IS-1/2023/Progetto/C1.pdf}\\ + (Ultimo accesso: 2024-02-08); + + \end{itemize} + +\newpage + + +\section{Istruzioni per l'utente} +Questa sezione comprende le istruzioni per l'uso del prodotto delle funzionalità disponibili all'utente (attore). +\subsection{Configurazione utente} +La configurazione permette all'utente di selezionare le diverse componenti del prodotto al primo avvio dell'applicazione. Al primo avvio viene infatti visualizzata una schermata di selezione della configurazione che impedisce all'utente di utilizzare l'applicazione se non viene compilata.\\ Si elencano qui le diverse componenti da selezionare. +\subsubsection{Selezione della configurazione iniziale} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/configuration1.png}} + \caption{Inizializzazione configurazione del sistema (LLM e vector store) (continua)} + \label{img:configuration1} +\end{figure} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/configuration2.png}} + \caption{Inizializzazione configurazione del sistema (document store e modello di embedding)} + \label{img:configuration2} +\end{figure} + +Questa funzionalità richiede all'utente di selezionare la configurazione che desidera tramite la schermata iniziale. Per farlo è sufficiente selezionare con un clic tutte le componenti desiderate (scorrendo verticalmente con il mouse ed orizzontalmente con le frecce nei vari menù) e per finire premere il bottone 'Confirm configuration' nel fondo della pagina.\\ Le varie azioni obbligatorie da operare sono: +\begin{itemize} + \item \textbf{Selezione del modello LLM}: Un LLM (\textit{Large Language Model}) è un modello di intelligenza artificiale che utilizza tecniche di \textit{machine learning} per comprendere e generare linguaggio umano. È quindi possibile selezionare il modello che interagirà con l'utente tramite il chatbot, ed è possibile scegliere tra i modelli di \textit{Huggingface} e \textit{OpenAI}; + \item \textbf{Selezione del vector store}: Un database vettoriale è un tipo di database che indicizza e memorizza embeddings vettoriali per un recupero rapido e una ricerca di similarità. È possibile scegliere tra quelli proposti da \textit{Pinecone} o \textit{ChromaDB}; + \item \textbf{Selezione del sistema di archiviazione}: È possibile la selezione del sistema di archiviazione dei documenti (al momento è possibile solo la scelta del sistema di \textit{Amazon Web Services}); + \item \textbf{Selezione del modello di embeddings}: Il modello di embeddings da selezionare si occupa della trasformazione dei documenti in embeddings. È possibile selezionare i modelli di \textit{Huggingface} oppure \textit{OpenAI}. +\end{itemize} + +Le altre funzionalità che si possono operare sulla configurazione utente sono la visualizzazione della configurazione corrente e il cambio del modello LLM configurato. +Queste sono visibili nella seguente immagine: + + +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/settings1.png}} + \caption{Configurazione corrente e cambio modello LLM} + \label{img:settings1} +\end{figure} +\subsubsection{Visualizzazione configurazione corrente} +Per visualizzare quale vector store, modello di embeddings, sistema di archiviazione e modello LLM sono attualmente configurati nell'applicazione è necessario: +\begin{itemize} + \item Premere dalla dashboard il simbolo delle impostazioni, posto in basso a sinistra della pagina e accompagnato dalla scritta 'Settings'; + \item Visualizzare la configurazione corrente sotto il rispettivo titolo 'Current configuration', scorrendo con le frecce poste a destra e sinistra del menù slider con i vari elementi della configurazione attuale. +\end{itemize} + +\subsubsection{Cambiamento del modello LLM selezionato} +È possibile per l'utente cambiare il modello LLM che risponde alle domande poste al chatbot, in questo modo: +\begin{itemize} + \item Dalla dashboard premere il simbolo delle impostazioni, posto in basso a sinistra della pagina e accompagnato dalla scritta 'Settings'; + \item Selezionare dal menù che si apre automaticamente in alto alla sinistra della pagina la sezione 'Configuration' (quando vengono aperte le informazioni si apre di default); + \item Selezionare dal menù che compare sotto al titolo 'LLM Models' il modello LLM desiderato; + \item Premere il bottone con su scritto 'Confirm configuration'. +\end{itemize} + +\subsection{Gestione dei documenti} +In questa sezione si illustrano le possibili azioni operabili sui documenti. +\subsubsection{Visualizzazione lista dei documenti} +\label{sec:visDocsList} +\subsubsubsection{Visualizzazione lista documenti recenti nella pagina Dashboard} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/dashboard-vis-docs.png}} + \caption{Dashboard - documenti recenti} + \label{img:dashRecentDocs} +\end{figure} +Nella parte inferiore della dashboard è resa disponibile la lista dei documenti più recentemente visualizzati. + \begin{itemize} + \item Per visualizzare la lista dei documenti più recentemente caricati, selezionare l'opzione 'Recently updated' che figura sotto al titolo della sezione ('Recent documents'); + \item Per visualizzare la lista dei documenti più recentemente visualizzati, selezionare l'opzione 'Recently viewed' che figura sotto al titolo della sezione ('Recent documents') e alla destra dell'opzione precedentemente descritta. + \end{itemize} + \subsubsubsection{Visualizzazione lista di tutti i documenti} + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/documentvisDocs.png}} + \caption{Documents - documenti in archivio} + \label{img:docssaved} + \end{figure} + Per visualizzare la lista di tutti i documenti presenti nel sistema di archiviazione è necessario: + \begin{itemize} + \item Selezionare l'opzione 'Documents' dal menù della side bar; + \item Visualizzare la parte inferiore della pagina, sotto il titolo 'List of documents'. Alla destra di ogni documento della lista si visualizzano titolo, dimensioni, stato, tipo e data di caricamento. + \end{itemize} + +\subsubsection{Visualizzazione tabella di archiviazione} + + +\subsubsubsection{Visualizzazione delle colonne} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/togglecolumns.png}} + \caption{Documents - selezione colonne} + \label{img:selDocsColumns} +\end{figure} +Come accennato in precedenza nella lista dei documenti vengono visualizzate delle informazioni (titolo, dimensioni, stato, tipo e data di caricamento) per ogni documento presente nel sistema di archiviazione.\\ Nel caso in cui si vogliano visualizzare meno informazioni riguardo i documenti, quindi modificare il numero di colonne nella tabella delle informazioni, è necessario: +\begin{itemize} + \item Visualizzare lista di tutti i documenti: vedi \vedi{sec:visDocsList}; + \item Fare clic sul bottone 'View' in alto a destra nella lista dei documenti; + \item Spuntare dall'elenco che compare automaticamente il titolo delle colonne che si intende rimuovere dalla tabella di visualizzazione della lista (non è possibile rimuovere la colonna del titolo dei documenti), che verranno rimosse in automatico; + \item Se successivamente si vuole ripristinare una colonna eliminata, è sufficiente ripetere l'operazione e fare un altro clic sul suo titolo perchè vengano automaticamente ripristinate. +\end{itemize} +In alternativa per compiere la stessa azione è possibile anche: +\begin{itemize} + \item Visualizzare lista di tutti i documenti: vedi \vedi{sec:visDocsList}; + \item Fare un clic in corrispondenza del titolo della colonna che non si vuole più visualizzare; + \item Selezionare l'opzione 'Hide' dal menù che comparirà automaticamente. +\end{itemize} + +\subsubsubsection{Scorrimento orizzontale} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/navpages.png}} + \caption{Documents - navigazione delle pagine pagine} + \label{img:navpages} +\end{figure} +Se il numero di documenti presenti nel sistema di archiviazione è elevato, la tabella viene rappresentata su più pagine. Per passare da una pagina all'altra è necessario: +\begin{itemize} + \item Visualizzare la lista di tutti i documenti: vedi \vedi{sec:visDocsList}.; + \item Scorrere la tabella fino all'ultima riga; + \item Selezionare il pulsante raffigurante '>' per andare avanti di una pagina, e quello raffigurante '<' per tornare indietro di una pagina; + \item Selezionare il pulsante raffigurante '>>' per visualizzare l'ultima pagina della tabella, e quello raffigurante '<<' per visualizzarne la prima pagina; + \item Quando ci si trova nella prima o nell'ultima pagina le azioni per andare avanti (nel caso dell'ultima pagina) o indietro (nel caso della prima pagina) sono bloccate poichè ci si trova già all'estremo. +\end{itemize} + +\subsubsubsection{Numero di righe} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/numeropagine.png}} + \caption{Documents - righe per pagina} + \label{img:rowspercol} +\end{figure} +È possibile modificare il numero di righe che si vuole compaiano in ogni pagina della tabella in questo modo: +\begin{itemize} + \item Visualizzare lista di tutti i documenti: vedi \vedi{sec:visDocsList}; + \item Scorrere la tabella fino all'ultima riga; + \item Selezionare il bottone in basso a destra che indica il numero di righe per pagina presenti al momento, al fianco della scritta 'Rows per page'; + \item Selezionare il numero di righe che si vuole visualizzare dall'elenco che compare automaticamente. +\end{itemize} + +\subsubsubsection{Ordinamento} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/ordinamentodocs.png}} + \caption{Documents - ordinamento secondo la colonna} + \label{img:ordDocsColumns} +\end{figure} +Per ordinare in ordine crescente o decrescente in base ad un determinato parametro gli elementi della tabella è necessario: +\begin{itemize} + \item Visualizzare lista di tutti i documenti: vedi \vedi{sec:visDocsList}; + \item Fare clic sul titolo del parametro di ordinamento desiderato (deve essere uno dei titoli delle colonne della tabella); + \item Selezionare dal menù che si aprirà automaticamente l'opzione 'Asc' se si desidera un ordinamento ascendente rispetto a tale parametro, o 'Desc' se si desidera un ordinamento discendente rispetto a tale parametro. +\end{itemize} + \subsubsubsection{Selezione degli elementi} + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/documentmanagSelect.png}} + \caption{Documents - selezione documento} + \label{img:selDocs} +\end{figure} + Per selezionare gli elementi della tabella è necessario: +\begin{itemize} + \item Visualizzare la parte sinistra della tabella e spuntare il quadrato che compare alla sinistra del titolo dell'elemento desiderato; + \item Se si vogliono selezionare tutti gli elementi della tabella, fare clic sul quadrato vuoto alla sinistra della colonna 'Title', in alto alla tabella. +\end{itemize} + + + + +\subsubsection{Visualizzazione contenuto documenti} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/visualizzacontenutodocument.png}} + \caption{Documents - visualizza contenuto documento} + \label{img:visDoc} +\end{figure} +Per visualizzare il contenuto di un documento è necessario: +\begin{itemize} + \item Visualizzare lista dei documenti: vedi \vedi{sec:visDocsList}; + \item Selezionare con due clic il documento desiderato dalla lista, che si aprirà automaticamente. +\end{itemize} +È anche possibile visualizzare il contenuto di un documento dalla dashboard, in questo modo: +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/dettaglidocumento.png}} + \caption{Dashboard - visualizza contenuto documento} + \label{img:visDash} +\end{figure} +\begin{itemize} + \item Nella parte inferiore della dashboard sono presenti i documenti recenti. Selezionare con un clic il documento desiderato da tale lista; + \item Compariranno informazioni aggiuntive sul documento in questione. Selezionare l'opzione 'View content' per aprire il documento, oppure 'Close' per chiudere il pop up. +\end{itemize} + +\subsubsection{Rimozione dal sistema di archiviazione} + +Per eliminare un documento dal sistema di archiviazione: +\begin{itemize} + \item Selezionare dal menù in alto a sinistra nella dashboard la sezione 'Documents'; + \item Visualizzare la parte inferiore della pagina, sotto il titolo 'List of documents', ed individuare il documento che si intende rimuovere dal sistema di archiviazione; + \item Premere il pulsante dei tre puntini verticali situato all'estrema destra della riga del rispettivo documento; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/deldocumentsList.png}} + \caption{Documents - elimina documento} + \label{img:delDoc} + \end{figure} + \item Fare clic sul bottone 'Delete'; + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=7cm]{img/Screen/deletedocsopopup.png}} + \caption{Documents - conferma eliminazione} + \label{img:confirmdeldoc} + \end{figure} +\end{itemize} +Per eliminare più documenti dal sistema di archiviazione: + +\begin{itemize} + \item Selezionare dal menù in alto a sinistra nella dashboard la sezione 'Documents'; + \item Visualizzare la parte inferiore della pagina, sotto il titolo 'List of documents', e selezionare spuntando con un clic la casella a sinistra nella riga di ogni documento che si intende rimuovere dal sistema di archiviazione; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/delMultipleDocs.png}} + \caption{Documents - elimina più documenti} + \label{img:delMultDoc} + \end{figure} + \item Premere il pulsante rosso con l'icona di un cestino che compare automaticamente alla selezione; + \item Come per l'eliminazione di un solo documento, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. +\end{itemize} + +\subsubsection{Caricamento e rimozione dall'area di staging} +Per caricare uno o più documenti nell'area di staging: +\begin{itemize} + \item Cliccare il bottone 'Carica documento' presente in alto a sinistra nella dashboard, che aprirà automaticamente la pagina 'Documents'.\\ + In alternativa, selezionare l'opzione 'Documents' nel menù in alto a sinistra della dashboard; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/dashstagedoc.png}} + \caption{Dashboard - carica un documento} + \label{img:dashStageDoc} + \end{figure} + \item Trascinare nell'apposito spazio (all'interno del rettangolo tratteggiato con scritto all'interno 'Click to upload or drag and drop') il documento (o i documenti) da caricare oppure fare un clic all'interno dell'area e selezionarli dalla lista dei documenti personali che si aprirà automaticamente; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/stagingarea.png}} + \caption{Documents - staging area} + \label{img:docsStageArea} + \end{figure} + \item Se si sbaglia ad inserire un documento, premere l'icona del cestino che compare a destra del titolo del documento nell'area di staging, che verrà rimosso; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/stagingareadel.png}} + \caption{Documents - cancel staging} + \label{img:docsStageAreadel} + \end{figure} + \item Se si cambia idea e non è più necessario fare l'upload del documento (o dei documenti) inseriti nell'area di staging, selezionare il bottone 'Cancel upload' che si trova sotto all'area di staging; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/cancelupload.png}} + \caption{Documents - cancel upload} + \label{img:docsStageAreacancel} + \end{figure} + \item Se nell'area di staging è già presente un documento (o più documenti) con lo stesso nome e formato di quello (o quelli) selezionato/i, viene visualizzato un pop up di errore in basso a destra, dato che non è possibile inserire due documenti uguali nell'area di staging.\\ Se i due documenti dovessero avere stesso nome e formato ma dovessero essere diversi, si prega di rinominare il secondo documento in questione e caricarlo nuovamente nell'area di staging; + + \item Se si prova ad inserire nell'area di staging un documento con un formato non leggibile dall'applicazione viene visualizzato un pop up di errore in basso a destra. + \end{itemize} + + +\subsubsection{Upload nel sistema di archiviazione e nel vector database dall'area di staging} +Per poter fare l’upload nel sistema di archiviazione e nel vector database dei documenti caricati nell’area di staging è necessario: +\begin{itemize} + \item Caricare nell'area di staging uno o più documenti da inserire nel sistema, seguendo le istruzioni del punto 2.2.5; + \item Per eseguire l'upload del documento (o dei documenti) selezionare il pulsante 'Upload documents' che si trova sotto all'area di staging; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/uploadDocs.png}} + \caption{Documents - upload documenti} + \label{img:docsupload} + \end{figure} + \item Se nel sistema di archiviazione è già presente un documento (o più documenti) con lo stesso nome e formato di quello (o quelli) di cui si sta facendo l'upload comparirà un avviso in centro alla pagina che segnala che sono presenti documenti duplicati. \\L'avviso permetterà di decidere quali documenti sovrascrivere e quali lasciare invariati, tramite un elenco in cui si devono spuntare i nomi dei documenti che si vuole sovrascrivere; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=8cm]{img/Screen/substitutedocuments.png}} + \caption{Documents - sostituisci documenti caricati} + \label{img:docsStageSubstitute} + \end{figure} + \item Una volta selezionati i documenti da sovrascrivere, premere 'Submit' per confermare o 'Cancel' per annullare l'azione. +\end{itemize} + +\subsubsection{Occultamento dal sistema} +\label{sec:concealDocs} +Per occultare un documento presenti nel sistema di archiviazione è necessario: +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Trovare il documento che si desidera occultare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente; + \item Selezionare l'opzione 'Conceal' dall'elenco che compare automaticamente; + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Conceal' per confermare o l'opzione 'Abort' per annullare l'azione. + + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=8cm]{img/Screen/concealdocuments.png}} + \caption{Documents - conferma occultamento} + \label{img:confirmConceal} + \end{figure} +\end{itemize} +Per occultare più documenti presenti nel sistema di archiviazione è necessario: +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Trovare i documenti che si desidera occultare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento da occultare, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Enabled', altrimenti non sarà possibile proseguire; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/concealselected.png}} + \caption{Documents - occulta selezionati} + \label{img:confirmConcealSel} + \end{figure} + + \item Selezionare l'opzione 'Conceal' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti; + \item Come per il singolo documento prima, apparirà un pop up di conferma: selezionare l'opzione 'Conceal' per confermare o l'opzione 'Abort' per annullare l'azione. +\end{itemize} + + +\subsubsection{Riabilitazione dal sistema} +Per riabilitare un documento occultato nel sistema di archiviazione il procedimento è simile a quello dell' occultamento (vedi \vedi{sec:concealDocs}): +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Trovare il documento che si desidera riabilitare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente; + \item Selezionare l'opzione 'Enable' dall'elenco che compare automaticamente; + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Enable' per confermare o l'opzione 'Abort' per annullare l'azione, simile al pop up di conferma occultamento. +\end{itemize} + +Per riabilitare più documenti presenti nel sistema di archiviazione è necessario: +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Trovare i documenti che si desidera riabilitare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento da riabilitare, per operare la selezione dei documenti, similmente al processo di selezione dei documenti per occultarli. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Concealed', altrimenti non sarà possibile proseguire; + \item Selezionare l'opzione 'Enable' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti; + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Enable' per confermare o l'opzione 'Abort' per annullare l'azione, simile al pop up di conferma occultamento documenti selezionati. +\end{itemize} + +\subsubsection{Incorporazione (Embed) da lista dei documenti} +Per incorporare nel sistema un documento il procedimento è simile a quello dell' occultamento (vedi \vedi{sec:concealDocs}): +\begin{itemize} + \item Aprire la lista di tutti i documenti: vedi \vedi{sec:visDocsList}; + \item Trovare il documento che si desidera incorporare e fare clic sul bottone raffigurante i tre puntini in verticale nella riga corrispondente; + \item Selezionare l'opzione 'Embed' dall'elenco che compare automaticamente; + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Embed' per confermare o l'opzione 'Abort' per annullare l'azione. +\end{itemize} +Per incorporare più documenti presenti nel sistema di archiviazione è necessario: +\begin{itemize} + \item Aprire la lista di tutti i documenti: vedi \vedi{sec:visDocsList}; + \item Trovare i documenti che si desidera incorporare e fare clic sul bottone raffigurante un quadrato a sinistra di ogni documento, per operare la selezione dei documenti. Attenzione: i documenti selezionati devono essere esclusivamente di stato 'Not Embedded', altrimenti non sarà possibile proseguire; + \item Selezionare l'opzione 'Embed' facendo clic sul bottone che compare automaticamente in alto a destra rispetto alla lista dei documenti; + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Embed' per confermare o l'opzione 'Abort' per annullare l'azione. +\end{itemize} + +\subsubsection{Ricerca nel sistema} +Per cercare un documento presente nel sistema di archiviazione in base al suo titolo è necessario: +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Fare clic sulla barra di ricerca (con scritto all'interno 'Filter by title') situata in alto a sinistra della sezione 'List of documents'; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/documentssearch.png}} + \caption{Documents - cerca per titolo} + \label{img:searchDocs} + \end{figure} + \item Digitare il titolo del documento ricercato. +\end{itemize} +Per cercare un documento presente nel sistema di archiviazione in base al suo stato è necessario: +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Fare clic sul bottone 'Status', affiancato da un'icona raffigurante il simbolo '+', situato a destra della barra di ricerca per titolo, in alto a sinistra nella lista dei documenti; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/documentsfilter.png}} + \caption{Documents - cerca per filtro} + \label{img:filterDocs} + \end{figure} + \item Selezionare dall'elenco che compare automaticamente lo stato del documento che si sta cercando, o digitare il nome dello stato desiderato nella barra di ricerca che compare sopra l'elenco. +\end{itemize} +Per cercare un documento presente nel sistema di archiviazione in base al suo formato il procedimento è simile a quello della ricerca per Status descritto sopra: +\begin{itemize} + \item Aprire la lista dei documenti nel sistema di archiviazione: vedi \vedi{sec:visDocsList}; + \item Fare clic sul bottone 'Type', affiancato da un'icona raffigurante il simbolo '+', situato a destra della barra di ricerca per titolo e di quella per stato, in alto a sinistra nella lista dei documenti; + \item Selezionare dall'elenco che compare automaticamente il formato del documento che si sta cercando, o digitare il nome del formato desiderato nella barra di ricerca che compare sopra l'elenco. +\end{itemize} +È inoltre possibile combinare tutte le funzioni di ricerca tra loro, quindi per esempio si può effettuare la ricerca di un documento inserendone titolo, stato e formato ricercati. \\ Per annullare le selezioni dei filtri di ricerca è sufficiente cliccare sul pulsante 'Reset' (affiancato dal simbolo 'X') che compare automaticamente dopo la selezione di un filtro di ricerca, situato a destra del pulsante di ricerca per formato. + + + +\subsection{Gestione delle chat} +In questa sezione si illustrano le possibili azioni operabili sulle chat dell'applicazione. +\subsubsection{Visualizzazione} +Le azioni possibili di visualizzazione delle chat sono le seguenti: + \subsubsubsection{Visualizzazione chat più recente (Dashboard)} + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/recentchatdash.png}} + \caption{Dashboard - chat più recente} + \label{img:dashrecentchat} + \end{figure} + È possibile visualizzare la chat più recente nella parte in alto a sinistra della dasboard. Selezionando il pulsante 'Espandi' in alto a destra della chat, sarà disponibile a schermo intero; + + + \subsubsubsection{Visualizzazione lista delle chat più recenti (Dashboard)} + + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/recentlistdash.png}} + \caption{Dashboard - lista delle chat più recenti} + \end{figure} + Per visualizzare le chat più recenti è sufficiente visualizzare la parte destra della dashboard dell'applicazione, sotto il titolo 'Recently visited chats', dove è possibile visualizzare le singole chat presenti in lista automaticamente con il rispettivo titolo in ordine cronologico. Vengono visualizzati inoltre il timestamp dell'ultimo messaggio presente per ogni chat (nella rispettiva riga in alto a destra), la preview dell'ultimo messaggio presente della chat (appena sotto al titolo) e la preview dell'ultimo mittente di una chat.\\ + Facendo un clic sul riquadro di una chat recente dalla lista è possibile aprire tale chat. + + \subsubsubsection{Visualizzazione lista chat (Chatbot)} + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/chatbotlist.png}} + \caption{Chatbot - lista delle chat} + \end{figure} + Se si comincia una conversazione con il chatbot o se si seleziona l'opzione 'Chatbot' dal menù in alto a sinistra della dashboard, la lista delle chat dell'applicazione è resa disponibile nella parte sinistra della pagina. Nella lista vengono visualizzati i timestamp dell'ultimo messaggio presente per ogni chat (nella rispettiva riga in alto a destra), la preview dell'ultimo messaggio presente della chat (appena sotto al titolo) e la preview dell'ultimo mittente di una chat. + + +\subsubsection{Creazione, eliminazione, Ridenominazione} +\subsubsubsection{Creazione chat } +Per creare una nuova chat è necessario: +\begin{itemize} + \item Selezionare il bottone 'Nuova chat' in alto a sinistra nella dashboard; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/dashNewChat.png}} + \caption{Dashboard - nuova chat} + \end{figure} + \item In alternativa, selezionare dal menù in alto a sinistra l'opzione 'Chatbot' e selezionare il bottone blu con il simbolo '+' in alto a sinistra nella pagina che varrà aperta (pagina 'Chatbot'), a destra del titolo 'Chat list'. + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/nuovachatchatbot.png}} + \caption{Chatbot - nuova chat} + \end{figure} +\end{itemize} +\subsubsubsection{Eliminazione chat } +Per eliminare una chat è necessario: +\begin{itemize} + \item Selezionare dal menù in alto a sinistra della dashboard l'opzione 'Chatbot'; + \item Selezionare con un clic la chat che si vuole eliminare dalla lista delle chat sulla sinistra della pagina. Se non si trova, è possibile ricercare la chat desiderata secondo le istruzioni sezione \vedi{sec:searchchat}; + + \item Selezionare il pulsante rosso in alto a destra della chat, con raffigurato il simbolo del cestino (che si sarà aperta automaticamente dopo l'azione precedente); + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=15cm]{img/Screen/delchatselected.png}} + \caption{Chatbot - eliminazione chat corrente} + \end{figure} + \item In seguito a tale azione, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=8cm]{img/Screen/deletechat.png}} + \caption{Chatbot - conferma eliminazione chat} + \end{figure} +\end{itemize} +Per eliminare più chat è necessario: +\begin{itemize} + \item Selezionare dal menù in alto a sinistra della dashboard l'opzione 'Chatbot'; + \item Selezionare con un clic il bottone alla destra della barra di ricerca appena sotto il titolo 'Chat list', che raffigura il simbolo della selezione; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/selectchats.png}} + \caption{Chatbot - selezione chat} + \end{figure} + \item Selezionare le chat che si desidera eliminare. Se si sbaglia la selezione, selezionare il bottone che compare in alto a destra raffigurante una freccia che punta all'indietro per annullare la selezione; + + \item Una volta selezionate le chat da eliminare, premere il pulsante rosso che compare in alto a destra, raffigurante due fogli con il simbolo 'X'; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/eliminazionechat.png}} + \caption{Chatbot - eliminazione chat} + \end{figure} + \item In seguito a tale azione, come per l'eliminazione singola, apparirà un pop up di conferma: selezionare l'opzione 'Delete' per confermare o l'opzione 'Abort' per annullare l'azione. +\end{itemize} + +\subsubsubsection{Ridenominazione di una chat} +Per rinominare una chat è necessario: +\begin{itemize} + \item Selezionare dal menù in alto a sinistra della dashboard l'opzione 'Chatbot'; + \item Selezionare con un clic la chat che si vuole rinominare dalla lista delle chat sulla sinistra della pagina. Se non si trova, è possibile ricercare la chat desiderata secondo le istruzioni della sezione \vedi{sec:searchchat}; + \item Selezionare il pulsante in alto a destra della chat, con raffigurato il simbolo di una matita che scive; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=15cm]{img/Screen/rinominamatita.png}} + \caption{Chatbot - rinomina chat} + \end{figure} + \item Inserire il nuovo titolo della chat; + + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/rinominachat.png}} + \caption{Chatbot - inserimento titolo chat} + \end{figure} + \item Premere invio. +\end{itemize} + +\subsubsection{Ricerca} +\label{sec:searchchat} +Per cercare una chat o il contenuto di essa all'interno della lista delle chat è necessario: +\begin{itemize} + \item Recarsi nella sezione 'Chatbot' nel menù in alto a sinistra della dashboard; + \item Fare clic sull'apposita barra di ricerca con sopra la dicitura 'Cerca una chat' (e con all'interno la dicitura 'Cerca') situata nella parte sinistra della pagina, nella sezione 'Lista chat'; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=11cm]{img/Screen/ricercachat.png}} + \caption{Chatbot - ricerca chat} + \end{figure} + \item Digitare il titolo o il contenuto che si desidera cercare; + \item Premere invio. +\end{itemize} +%\subsubsection{Visualizzazione contenuto e messaggi} +%Per visualizzare il contenuto ed i singoli messaggi di una chat è necessario: +%\begin{itemize} + % \item Fare clic sulla chat che si intende leggere dalla lista delle chat. È possibile farlo sia dalla dashboard, selezionando la chat dalla lista delle ultime chat in alto a destra, o aprendo la pagina 'Chatbot' dal menù in alto a sinistra della dashboard e selezionandola dalla lista delle chat a sinistra nella pagina. +%\end{itemize} +%La chat desiderata verrà automaticamente aperta per la lettura. Ne vengono quindi visualizzati il contenuto testuale e l'orario dei singoli messaggi (in basso a sinistra rispetto ai messaggi). +%\subsubsection{Domande suggerite} +%Se la chat è vuota vengono visualizzate (DOVE?) di default delle domande suggerite che possono essere poste al chatbot. Per selezionare una domanda è sufficiente selezionarla con un clic e confermarne l'invio selezionando l'opzione ... +\subsubsection{Inserimento, invio e copia} +Per inserire un messaggio nell'area di testo di una chat è necessario: +\begin{itemize} + \item Recarsi nella sezione 'Chatbot' dal menù in alto a sinistra nella dashboard; + \item Digitare il testo del messaggio da inserire nell'apposito spazio in basso alla chat, nella barra con su scritto 'Type your message...'; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=11cm]{img/Screen/typemessage.png}} + \caption{Chatbot - digitare un messaggio} + \end{figure} + \item Se si sbaglia ad inserire il testo del messaggio è possibile cancellarlo selezionando il bottone arancione raffigurante una gomma che compare automaticamente a destra della barra di inserimento testuale dopo l'inserimento del primo carattere; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=11cm]{img/Screen/deletetext.png}} + \caption{Chatbot - cancellare il testo di un messaggio} + \end{figure} + \item Una volta scritto un messaggio, per inserirlo nella chat (quindi per inviarlo) si deve fare clic sul bottone a destra della casella per l'inserimento testuale, raffigurante un aeroplanino. + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=11cm]{img/Screen/sendtext.png}} + \caption{Chatbot - invia un messaggio} + \end{figure} +\end{itemize} +Per poi copiare un messaggio è necessario fare clic sull'apposita icona con il simbolo di copia posta in alto al fianco di ogni messaggio della chat. + + + + + + + +\subsubsection{Visualizzazione di documento da chat} +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/chathistory.png}} + \caption{Chatbot - visualizza riferimenti} +\end{figure} +Quando il chatbot fornisce una risposta contenente uno o più documenti, è possibile visualizzarli facendo clic sul bottone 'Vedi' alla destra del rispettivo documento inviato dal chatbot. + + +\subsubsection{Modalità vocale} +È possibile utilizzare la modalità vocale, quindi inserire un messaggio in una chat tramite comando vocale, in questo modo: +\begin{itemize} + \item Recarsi nella pagina 'Chatbot' dal menù in alto a sinistra della dashboard; + \item Fare clic sul bottone del microfono a sinistra della casella di inserimento testuale; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/startvoc.png}} + \caption{Chatbot - registra messaggio vocale} + \end{figure} + \item Scandire ad alta voce il testo del messaggio che si desidera inserire; + \item Selezionando il bottone rosso con il simbolo delle due barre in verticale è possibile mettere in pausa la registrazione per poi riprenderla selezionando il pulsante raffigurante una freccia; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/modvocale.png}} + \caption{Chatbot - pausa registrazione} + \end{figure} + \item Quando finito, premere il bottone rosso con il quadrato a sinistra della casella di inserimento testuale; + + \item Se si desidera eliminare il messaggio selezionare il pulsante rosso raffigurante il cestino; + \item Se si desidera inviare il messaggio fare clic sul bottone a destra della casella per l'inserimento testuale, raffigurante un aeroplanino. +\end{itemize} + + +\subsection{Altre funzionalità} +\subsubsection{Cambio del tema di sfondo} +L'interfaccia dell'applicazione è disponibile in tema chiaro o scuro.\\ +\begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/settings2.png}} + \caption{Settings - scelta del tema} +\end{figure} + Per cambiare tema è necessario: +\begin{itemize} + \item Dalla dashboard premere il simbolo delle impostazioni, posto in basso a sinistra della pagina e accompagnato dalla scritta 'Settings'; + \item Dal menù delle impostazioni, in alto a sinistra della pagina che si sarà aperta automaticamente, selezionare la voce 'Appearence'; + \item Selezionare il tema di sfondo desiderato; + \item Premere il bottone in basso con su scritto 'Update preferences'. Comparirà successivamente un pop up in basso a destra per segnalare il successo dell'operazione. +\end{itemize} +\subsubsection{Adattamento delle dimensioni} +Per modificare le dimensioni delle varie sezioni presenti nelle diverse pagine è necessario: +\begin{itemize} + \item Aprire la pagina desiderata dal menù a sinistra; + \item Posizionarsi con il mouse sulla linea che divide le sezioni della pagina; + \begin{figure}[H] + \centering + \frame{ + \includegraphics[width=16cm]{img/Screen/modpagechatbot.png}} + \caption{Chatbot - modifica proporzioni pagina} + \end{figure} + \item Premere e trascinare l'icona dei sei puntini presente sulla linea in corrispondenza della metà della sua altezza, fino alla dimensione desiderata. +\end{itemize} + + + \end{document} \ No newline at end of file diff --git a/SorgentiTex/Manuale utente/parameters.tex b/SorgentiTex/Manuale utente/parameters.tex index ac0d380d..5303987f 100644 --- a/SorgentiTex/Manuale utente/parameters.tex +++ b/SorgentiTex/Manuale utente/parameters.tex @@ -1,19 +1,19 @@ -% Parametri che modificano il file main.tex -% Le uniche parti da cambiare su main.tex sono: -% - tabella versioni -% - testo file - -\def\titolo{Manuale \\ utente} % \\ per andare a capo -\def\titoloHeader{Manuale utente} % mettere stesso titolo senza andare a capo -\def\data{} -% \def\versione{v0.0.1} - -% \def\listaComponenti{ -% Bresolin G., -% Campese M., -% Ciriolo I., -% Dugo A., -% Feltrin E., -% Michelon R., -% Orlandi G. +% Parametri che modificano il file main.tex +% Le uniche parti da cambiare su main.tex sono: +% - tabella versioni +% - testo file + +\def\titolo{Manuale \\ utente} % \\ per andare a capo +\def\titoloHeader{Manuale utente} % mettere stesso titolo senza andare a capo +\def\data{} +% \def\versione{v0.0.1} + +% \def\listaComponenti{ +% Bresolin G., +% Campese M., +% Ciriolo I., +% Dugo A., +% Feltrin E., +% Michelon R., +% Orlandi G. % } \ No newline at end of file diff --git a/SorgentiTex/Manuale utente/registroversioni.tex b/SorgentiTex/Manuale utente/registroversioni.tex index f3ac133c..3da33eb6 100644 --- a/SorgentiTex/Manuale utente/registroversioni.tex +++ b/SorgentiTex/Manuale utente/registroversioni.tex @@ -17,6 +17,8 @@ \section*{Registro delle versioni} \endlastfoot +\hline +v2.27.8(2) & $2024-04-10$ & \quantities{Campese M.} & Michelon R. & Aggiornamento immagini.\\ \hline v2.27.6(1) & $2024-03-28$ & \quantities{Dugo A.} & Bresolin G. & Visualizzazione tabella dei documenti.\\ \hline diff --git a/SorgentiTex/Manuale utente/style.sty b/SorgentiTex/Manuale utente/style.sty index 92ffb36e..645fdde4 100644 --- a/SorgentiTex/Manuale utente/style.sty +++ b/SorgentiTex/Manuale utente/style.sty @@ -1,60 +1,71 @@ -% PACKAGES ======================================================================== - -\usepackage[italian]{babel} -\usepackage[a4paper,top=3cm,bottom=3cm,left=3cm,right=3cm,marginparwidth=1.75cm]{geometry} -\usepackage[dvipsnames, table]{xcolor} -\usepackage{amsmath} -\usepackage{graphicx} -\usepackage[colorlinks=true, allcolors=blue]{hyperref} -\usepackage{tikz} -\usetikzlibrary{shapes, backgrounds, mindmap, trees, positioning} -\usepackage[inkscapeformat=png]{svg} -\usepackage{lastpage} -\usepackage{moresize} -\usepackage{paracol} -\usepackage{enumitem} -\usepackage{nicematrix} -\usepackage{tabularx} -\usepackage{xltabular} -\usepackage{parskip} -\usepackage{fontspec} -\usepackage{float} -\usepackage{setspace} -\usepackage{titlesec} -\usepackage{fancyhdr} -\usepackage{fontawesome} -\usepackage{ifthen} -\usepackage{forloop} -\hypersetup{ - colorlinks=true, % Imposta i collegamenti come testo colorato anziché riquadri intorno al testo - linkcolor=black, % Colore dei link alle sezioni - filecolor=black, % Colore dei link ai file - urlcolor=black, % Colore dei link agli URL -} - -% GRAPHIC STYLE ======================================================================== - -\definecolor{primarycolor}{RGB}{248, 182, 143} -\definecolor{secondarycolor}{RGB}{57, 57, 58} -\definecolor{colorlogo}{RGB}{23, 22, 20} -\definecolor{lightcol}{RGB}{245,245,245} - -\linespread{1.15} - -\setmainfont{Poppins}[ - Path=./Poppins/, - Extension = .ttf, - UprightFont=*-Regular, - BoldFont=*-Bold, - ItalicFont=*-Italic, - BoldItalicFont=*-BoldItalic - ] - -% \quantities{el1 \\ el2} -\newcommand{\quantities}[1]{% - \begin{tabular}{@{}c@{}}\strut#1\strut\end{tabular}% -} - -\setlist[itemize]{label=\color{primarycolor}\textbullet} - +% PACKAGES ======================================================================== + +\usepackage[italian]{babel} +\usepackage[a4paper,top=3cm,bottom=3cm,left=3cm,right=3cm,marginparwidth=1.75cm]{geometry} +\usepackage[dvipsnames, table]{xcolor} +\usepackage{amsmath} +\usepackage{graphicx} +\usepackage[colorlinks=true, allcolors=blue]{hyperref} +\usepackage{tikz} +\usetikzlibrary{shapes, backgrounds, mindmap, trees, positioning} +\usepackage[inkscapeformat=png]{svg} +\usepackage{lastpage} +\usepackage{moresize} +\usepackage{paracol} +\usepackage{enumitem} +\usepackage{nicematrix} +\usepackage{tabularx} +\usepackage{xltabular} +\usepackage{parskip} +\usepackage{fontspec} +\usepackage{float} +\usepackage{setspace} +\usepackage{titlesec} +\usepackage{fancyhdr} +\usepackage{fontawesome} +\usepackage{ifthen} +\usepackage{forloop} +\hypersetup{ + colorlinks=true, % Imposta i collegamenti come testo colorato anziché riquadri intorno al testo + linkcolor=black, % Colore dei link alle sezioni + filecolor=black, % Colore dei link ai file + urlcolor=black, % Colore dei link agli URL +} + +% GRAPHIC STYLE ======================================================================== + +\definecolor{primarycolor}{RGB}{248, 182, 143} +\definecolor{secondarycolor}{RGB}{57, 57, 58} +\definecolor{colorlogo}{RGB}{23, 22, 20} +\definecolor{lightcol}{RGB}{245,245,245} + +\linespread{1.15} + +\setmainfont{Poppins}[ + Path=./Poppins/, + Extension = .ttf, + UprightFont=*-Regular, + BoldFont=*-Bold, + ItalicFont=*-Italic, + BoldItalicFont=*-BoldItalic + ] + + \setcounter{secnumdepth}{5} +\setcounter{tocdepth}{5} + +\makeatletter +\newcommand\subsubsubsection{\@startsection{paragraph}{4}{\z@}{-2.5ex\@plus -1ex \@minus -.25ex}{1.25ex \@plus .25ex}{\normalfont\normalsize\bfseries}} +\newcommand\subsubsubsubsection{\@startsection{subparagraph}{5}{\z@}{-2.5ex\@plus -1ex \@minus -.25ex}{1.25ex \@plus .25ex}{\normalfont\normalsize\bfseries}} +\makeatother +% \quantities{el1 \\ el2} +\newcommand{\quantities}[1]{% + \begin{tabular}{@{}c@{}}\strut#1\strut\end{tabular}% +} + +\newcommand{\vedi}[1]{% + (\S \ref{#1}) +} + +\setlist[itemize]{label=\color{primarycolor}\textbullet} + \setlength{\parindent}{0pt} \ No newline at end of file