Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use glossaries package #180

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Use glossaries package #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a6d339
moved cls and glyphtounicode to root
Aug 3, 2018
2b3db62
global replace of Classes/PhDThesisPSnPDF.cls
Aug 3, 2018
de7690a
remove troubleshoot as problem no longer exists
Aug 3, 2018
471e67e
Use glossaries package
clbarnes Oct 16, 2018
c59850c
Merge branch 'master' into glossaries
clbarnes Nov 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,11 @@ thesis.run.xml*
*run.xml*
*.latexmkrc*
*_latexmk*

# glossary/ acronyms

*.acr
*.alg
*.acn
*.glg
*.gls
10 changes: 6 additions & 4 deletions Chapter1/chapter1.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ \section{What is loren ipsum? Title with math \texorpdfstring{$\sigma$}{[sigma]}
CIF: \hspace*{5mm}F_0^j(a) = \frac{1}{2\pi \iota} \oint_{\gamma} \frac{F_0^j(z)}{z - a} dz
\end{align}

\nomenclature[z-cif]{$CIF$}{Cauchy's Integral Formula} % first letter Z is for Acronyms
\nomenclature[z-cif]{$CIF$}{Cauchy's Integral Formula} % first letter Z is for Acronyms
\nomenclature[a-F]{$F$}{complex function} % first letter A is for Roman symbols
\nomenclature[g-p]{$\pi$}{ $\simeq 3.14\ldots$} % first letter G is for Greek Symbols
\nomenclature[g-i]{$\iota$}{unit imaginary number $\sqrt{-1}$} % first letter G is for Greek Symbols
Expand Down Expand Up @@ -76,8 +76,7 @@ \section{Where does it come from?} %Section - 1.3
\nomenclature[z-BEM]{BEM}{Boundary Element Method}
\nomenclature[z-MPM]{MPM}{Material Point Method}
\nomenclature[z-LBM]{LBM}{Lattice Boltzmann Method}
\nomenclature[z-MRT]{MRT}{Multi-Relaxation
Time}
\nomenclature[z-MRT]{MRT}{Multi-Relaxation Time}
\nomenclature[z-RVE]{RVE}{Representative Elemental Volume}
\nomenclature[z-GPU]{GPU}{Graphics Processing Unit}
\nomenclature[z-SH]{SH}{Savage Hutter}
Expand All @@ -97,4 +96,7 @@ \section{Where does it come from?} %Section - 1.3
\nomenclature[z-USL]{USL}{Update Stress Last}
\nomenclature[s-crit]{crit}{Critical state}
\nomenclature[z-DKT]{DKT}{Draft Kiss Tumble}
\nomenclature[z-PPC]{PPC}{Particles per cell}
\nomenclature[z-PPC]{PPC}{Particles per cell}

While nomenclature is all well and good, sometimes you need a real \gls{glossary}.
But to get a real understanding if what it's all about, you should just \gls{rtft}.
11 changes: 11 additions & 0 deletions Glossary/glossary.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
%!TEX root = ../thesis.tex

\usepackage[acronym,toc,nonumberlist]{glossaries}
\makeglossaries

\newglossaryentry{glossary}{
name=glossary,
description={A place to define commonly-used jargon}
}

\newacronym{rtft}{RTFT}{Read The Final Thesis}
5 changes: 4 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ fileinfo := LaTeX Makefile
author := Chris Monson
version := 2.2.1-alpha10
#
.DEFAULT_GOAL := all
.DEFAULT_GOAL := all-gls
# Note that the user-global version is imported *after* the source directory,
# so that you can use stuff like ?= to get proper override behavior.
.PHONY: Makefile GNUmakefile Makefile.ini $(HOME)/.latex-makefile/Makefile.ini
Expand Down Expand Up @@ -4241,3 +4241,6 @@ endef
hooks:
./hooks/install.sh

.PHONY: all-gls
all-gls: all
makeglossaries thesis; $(MAKE) all;
1 change: 1 addition & 0 deletions compile-thesis-windows.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ makeindex "%FILENAME%.idx"
makeindex "%FILENAME%.nlo" -s nomencl.ist -o "%FILENAME%".nls
pdflatex -interaction=nonstopmode "%FILENAME%.tex"
makeindex "%FILENAME%.nlo" -s nomencl.ist -o "%FILENAME%".nls
makeglossaries %FILENAME%
pdflatex -interaction=nonstopmode "%FILENAME%.tex"


Expand Down
1 change: 1 addition & 0 deletions compile-thesis.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ elif [ $1 = $compile ]; then
makeindex $filename.nlo -s nomencl.ist -o $filename.nls
pdflatex -interaction=nonstopmode $filename.tex
makeindex $filename.nlo -s nomencl.ist -o $filename.nls
makeglossaries $filename
pdflatex -interaction=nonstopmode $filename.tex
echo "Success!"
exit
Expand Down
Binary file modified thesis.pdf
View file
Open in desktop
Binary file not shown.
9 changes: 8 additions & 1 deletion thesis.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
% ******************************* PhD Thesis Template **************************
% Please have a look at the README.md file for info on how to use the template

\documentclass[a4paper,12pt,times,numbered,print,index]{PhDThesisPSnPDF}
\documentclass[a4paper,12pt,times,numbered,print]{PhDThesisPSnPDF}

% ******************************************************************************
% ******************************* Class Options ********************************
Expand Down Expand Up @@ -106,6 +106,8 @@
\includeonly{Chapter3/chapter3}
\fi

\input{Glossary/glossary}

% ******************************** Front Matter ********************************
\begin{document}

Expand All @@ -126,6 +128,11 @@

\listoftables

% Only one of glossary (including acronyms) and nomenclature should be used, for clarity

\printglossary[title=Glossary]
\printglossary[type=\acronymtype]

% \printnomenclature[space] space can be set as 2em between symbol and description
%\printnomenclature[3em]

Expand Down