Merge pull request #200 from GruppOne/aggiornamento-glossario

Aggiornamento glossario

Author: erclu

.github/workflows/latex.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   chktex:
     name: Lint LaTeX files
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
 
     steps:
       - uses: actions/checkout@v2
@@ -17,3 +17,39 @@ jobs:
         uses: docker://gruppone/chktex-action:v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  glossary:
+    name: Ensure glossary is up to date
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          path: project-docs
+
+      - name: checkout make-glossary repository in a subfolder
+        uses: actions/checkout@v2
+        with:
+          repository: GruppOne/make-glossary
+          path: make-glossary
+
+      - uses: actions/setup-python@v1
+        with:
+          python-version: "3.x"
+
+      - run: python ../make-glossary/make-glossary/make-json.py
+        working-directory: project-docs
+
+      - run: python ../make-glossary/make-glossary/make-tex.py
+        working-directory: project-docs
+
+      - name: check if git status is clean
+        run: |
+          if [[ $(git status -s) ]]; then
+              echo "glossary is not up to date"
+              exit 1
+          else
+              echo "everything ok"
+              exit 0
+          fi
+        working-directory: project-docs

.vscode/settings.json

@@ -1,4 +1,10 @@
 {
+  "[json]": {
+    "editor.defaultFormatter": "vscode.json-language-features",
+    "editor.insertSpaces": true,
+    "editor.tabSize": 2,
+    "editor.formatOnSave": true
+  },
   "[latex]": {
     "editor.formatOnSave": false,
     "editor.formatOnPaste": false,

commons/glossario.json

@@ -1,4 +1,4 @@
-\setVersione{0.1.5}
+\setVersione{0.2.3}
 
 \thispagestyle{empty}
 \pagenumbering{gobble}
@@ -74,7 +74,7 @@ \section*{Registro delle modifiche}%
 \pagestyle{usual}
 \pagenumbering{arabic}
 
-\newcommand{\scopoDelProdotto}{
+\newcommand{\scopoDelProdottoEGlossario}{
 \subsection{Scopo del prodotto}%
 \label{sub:scopo_del_prodotto}
 L'obiettivo del progetto è sviluppare un'applicazione mobile distribuita, seguendo il modello client/server.
@@ -83,4 +83,10 @@ \subsection{Scopo del prodotto}%
 In caso di utenti anonimi l'analisi riguarda solo una stima del numero totale di persone presenti in un dato momento.
 In caso di utenti autenticati deve inoltre essere possibile effettuare query di monitoraggio specifiche.
 In merito all'ottimizzazione della geolocalizzazione, è richiesto un report che esponga le scelte progettuali, le rispettive motivazioni e i test eseguiti per garantire la rilevazione sufficiente precisa della posizione, considerando le limitazioni dello smartphone.
+
+\subsection{Glossario}%
+\label{sub:glossario}
+
+L'uso di vocaboli tecnici e facilmente fraintendibili rende necessaria la realizzazione di un glossario che definirà i termini dai significati più travisabili presenti in ogni documento.
+Per garantirne l'inequivocabilità, le parole che possono assumere un significato ambiguo sono evidenziate (ad es., \glossario{way of working}) e riportate nel documento \textit{Glossario (versione \versione)} accompagnate da una breve definizione.
 }

commons/template.tex

@@ -6,11 +6,7 @@ \subsection{Scopo del documento}%
 Il presente \glossario{documento} ha lo scopo di descrivere in maniera dettagliata i \glossario{requisiti} impliciti ed espliciti individuati per il \glossario{prodotto}.
 Tali requisiti sono stati identificati dall'analisi del \glossario{capitolato} C5 ed i successivi incontri con il \glossario{proponente}, \textit{Imola Informatica}.
 
-\scopoDelProdotto{}
-
-\subsection{Glossario}%
-\label{sub:glossario}
-Al fine di rendere il documento più chiaro possibile, i termini che possono assumere un significato ambiguo sono evidenziati (i.e., \glossario{client}) e riportati in \textit{Glossario (versione \versione)} accompagnati da una definizione.
+\scopoDelProdottoEGlossario{}
 
 \subsection{Riferimenti}%
 \label{sub:riferimenti}

esterni/analisi-dei-requisiti/components/introduzione.tex

@@ -14,12 +14,8 @@ \subsection{Scopo del documento}%
 \end{itemize}
 % sub:scopo_del_documento (end)
 
-\scopoDelProdotto{}
+\scopoDelProdottoEGlossario{}
 
-\subsection{Glossario}%
-\label{sub:glossario}
-Al fine di rendere il documento più chiaro possibile, i termini che possono assumere un significato ambiguo sono evidenziati (i.e., \glossario{server}) e riportati nel \textit{Glossario} accompagnati da una definizione dettagliata.
-% sub:glossario (end)
 \subsection{Riferimenti}%
 \label{sub:riferimenti}
 \subsubsection{Normativi}%

esterni/glossario/glossario.json

@@ -10,12 +10,8 @@ \subsection{Scopo del documento}%
 
 % sub:scopo_del_documento (end)
 
-\scopoDelProdotto{}
+\scopoDelProdottoEGlossario{}
 
-\subsection{Glossario}%
-\label{sub:glossario}
-Al fine di rendere il documento più chiaro possibile, i termini che possono assumere un significato ambiguo sono evidenziati (i.e., \glossario{client}) e riportati in \textit{Glossario1.0.0.pdf} accompagnati da una definizione.
-% sub:glossario (end)
 \subsection{Riferimenti}%
 \label{sub:riferimenti}
 \subsubsection{Normativi}%

esterni/glossario/glossario.tex

@@ -9,22 +9,18 @@ \subsection{Scopo del documento}%
 Si vogliono definire le regole e le norme a cui ogni membro del gruppo deve attenersi al fine di ottenere un efficace way of working nel corso di ogni attività di processo.
 Il documento verrà aggiornato nel corso del tempo, pertanto è ancora incompleto.
 
-\subsection{Glossario}%
-\label{sub:glossario}
+\scopoDelProdottoEGlossario{}
 
-L'uso di vocaboli tecnici e facilmente fraintendibili rende necessaria la realizzazione di un glossario che definirà i termini dai significati più travisabili presenti in ogni documento.
-Per garantirne l'inequivocabilità, le parole che possono assumere un significato ambiguo sono evidenziate (ad es., \glossario{way of working}) e riportate nel documento \textit{Glossario (versione \versione)} accompagnate da una breve definizione.
+% \subsection{IDE/Code Editor}%
+% \label{sub:ide_code_editor}
 
-\subsection{IDE/Code Editor}%
-\label{sub:ide_code_editor}
+% Lasciamo la scelta degli strumenti da utilizzare a ciascun membro del team, a cui viene quindi assegnata la responsabilità di configurarli coerentemente con quanto descritto nel presente documento.
 
-Lasciamo la scelta degli strumenti da utilizzare a ciascun membro del team, a cui viene quindi assegnata la responsabilità di configurarli coerentemente con quanto descritto nel presente documento.
+% In ogni caso, lo strumento utilizzato dalla maggioranza dei membri del team, perlomeno nel periodo iniziale, è Visual Studio Code (vscode), quindi la sua configurazione, contenuta nella cartella \verb|/.vscode/|, verrà inclusa nel sistema di versionamento scelto.
 
-In ogni caso, lo strumento utilizzato dalla maggioranza dei membri del team, perlomeno nel periodo iniziale è Visual Studio Code (vscode), quindi la sua configurazione, contenuta nella cartella \verb|/.vscode/|, verrà inclusa nel sistema di versionamento scelto.
+% Qualora si rivelasse insufficiente a coprire i nostri bisogni, soprattutto durante le attività di codifica, valuteremo la necessità di passare a un IDE completo.
 
-Qualora si rivelasse insufficiente a coprire i nostri bisogni, soprattutto durante le attività di codifica, valuteremo la necessità di passare a un IDE completo.
-
-Per semplificare eventuali transizioni, ci impegniamo a mantenere le configurazioni degli strumenti utilizzati in file esterni tipicamente contenuti nella radice delle cartelle di progetto e adeguatamente versionati.
+% Per semplificare eventuali transizioni, ci impegniamo a mantenere le configurazioni degli strumenti utilizzati in file esterni tipicamente contenuti nella radice delle cartelle di progetto e adeguatamente versionati.
 
 \subsection{Riferimenti}%
 \label{sub:riferimenti}