Skip to content

Kern3lP4nic/GloMaker

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

GloMaker

Con questo strumento è possibile automatizzare il processo di aggiornamento del glossario, inerente alla documentazione del progetto del corso di SWE.

Per il suo corretto funzionamento è necessario aver installato nella macchina Java 8.

Lo script viene eseguito da console, e deve essere posizionato all'interno della cartella insieme al file contenente tutti termini del glossario e alla directory contenente i documenti da esaminare. Una volta compilato javac Main.java ed eseguito java Main, il programma chiederà all'utente di selezionare il file principale del glossario contenente SOLAMENTE i termini con le loro definizioni, e successivamente la directory dove cercare ricorsivamente nuovi termini da aggiungere al glossario.

I termini nel glossario devono essere definiti in questo modo

\newglossaryentry{wordName}{
    name=wordName,
    description={wordDefinition}
}

mentre i termini che vengono cercati ricorsivamente in altri file devono essere definiti in questo modo

\gl{wordName}

Lo script riscriverà interamente il glossario ad ogni sua esecuzione, quindi assicurarsi di eseguire una copia di backup per evitare danni o perdite.

ChangeLog

v0.0.1

  • Versione primitiva dello script.

Bug List

  • Lo script non funziona correttamente se nella descrizione del termine è presente la parentesi grafa }

About

Tool utile per automatizzare l'aggiornamento del glossario inerente alla documentazione del progetto di SWE

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Java 100.0%