From f2c8d3fd6076a0fdd825d6ab3e17c008122680f3 Mon Sep 17 00:00:00 2001 From: Chris Vasiladiotis Date: Thu, 19 Sep 2024 15:16:54 +0100 Subject: [PATCH 1/2] Elaborate on acronyms (#52) --- paper.tex | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/paper.tex b/paper.tex index 61d9c1c..0bc9ccf 100644 --- a/paper.tex +++ b/paper.tex @@ -652,12 +652,14 @@ \subsubsection{Prefer meaningful text over citations as textual content} \subsubsection{Managing acronyms automatically} Managing acronyms manually can lead to situations where the specific term is not properly expanded upon first use or when it is introduced. The \texttt{acronym} package is useful to avoid such situations and provides full control over acronyms. -For example, assume we have defined an acronym with \texttt{\textbackslash{}newacronym\{ir\}\{IR\}\{Intermediate Representation\}}: +The expanded form of an abbreviation should be in lowercase, unless its parts are also capitalized (e.g., United Kingdom for UK). +For example, assume we have defined an acronym with \texttt{\textbackslash{}newacronym\{ir\}\{IR\}\{intermediate representation\}}: \begin{itemize} \item Upon first use of \texttt{\textbackslash{}ac\{ir\}} we get: \ac{ir}. \item On the second reference: \ac{ir}. - \item If we need to force expansion for a figure or a background section where the term is first described, we can use \texttt{\textbackslash{}acf\{ir\}} which gives: \acf{ir}. - \item We can obtain plural form using \texttt{\textbackslash{}acp\{ir\}} giving: \acp{ir}. + \item To force expansion (e.g., for the background section where the term is first described), we use \texttt{\textbackslash{}acf\{ir\}} which gives: \acf{ir}. + \item To force contraction (e.g., to save space for a figure caption), we use \texttt{\textbackslash{}acs\{ir\}} which gives: \acs{ir}. + \item To obtain plural form, we use \texttt{\textbackslash{}acp\{ir\}} giving: \acp{ir}. \end{itemize} \end{draftonly} From 0cd1348c08016aa3942195340a4351a43ca10ccc Mon Sep 17 00:00:00 2001 From: Chris Vasiladiotis Date: Wed, 2 Oct 2024 23:17:28 +0100 Subject: [PATCH 2/2] Add minor `Makefile` improvements (#51) * Fix comments * Fix phony targets * Keep it DRY * Fix typo --- Makefile | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index ad7ea9a..147737a 100644 --- a/Makefile +++ b/Makefile @@ -1,25 +1,24 @@ -# Source Latex files +# Source LaTeX files TEX_MAIN_PAPER = paper.tex TEX_MAIN_SUBMISSION = submission.tex -# Generate PDF files -PDF_PAPER = paper.pdf -PDF_SUBMISSION = submission.pdf +# Generated PDF files +PDF_PAPER := $(TEX_MAIN_PAPER:.tex=.pdf) +PDF_SUBMISSION := $(TEX_MAIN_SUBMISSION:.tex=.pdf) +# Resources IMAGES := $(wildcard images/*.jpg images/*.pdf images/*.png) -# grammar is a phony rule, it generates index.html -# from textidote -.PHONY: grammar +.PHONY: all grammar paper submission view-paper view-submission clean all: ${PDF_SUBMISSION} ${PDF_PAPER} # spelling and grammar -grammar: paper.tex +grammar: $(TEX_MAIN_PAPER) # check that textidote exists. @textidote --version # allowed to fail since it throws error if we have grammar mistakes - -textidote --check en --output html paper.tex > index.html + -textidote --check en --output html $< > index.html python3 -m http.server ${PDF_PAPER}: ${TEX_MAIN_PAPER} ${IMAGES}