Skip to content

Commit

Permalink
Merge branch 'main' into christos/add-refcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
math-fehr authored Oct 2, 2024
2 parents 6d0bdb1 + 0cd1348 commit ed11dcf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
17 changes: 8 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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: $(TEX_MAIN_PAPER)
# check that textidote exists.
@textidote --version
@textidote --version
# allowed to fail since it throws error if we have grammar mistakes
-textidote --check en --output html $< > index.html
-textidote --check en --output html $< > index.html
python3 -m http.server

refcheck: paper
Expand Down
8 changes: 5 additions & 3 deletions paper.tex
Original file line number Diff line number Diff line change
Expand Up @@ -653,12 +653,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}
Expand Down

0 comments on commit ed11dcf

Please sign in to comment.