From 3e357245467936006c9667f23aee3c0430dd4b91 Mon Sep 17 00:00:00 2001 From: Wessel Tip Date: Sat, 1 Mar 2025 00:20:37 +0100 Subject: [PATCH] chore: Update template to current used one --- .gitignore | 20 ++-- .vscode/LaTeX.code-snippets | 31 +++++ .vscode/settings.json | 112 +++++++++++++++++++ src/main.tex | 54 --------- src/references.bib | 1 - tex/doc/.gitkeep | 1 + tex/img/.gitkeep | 1 + tex/main.tex | 37 ++++++ tex/packages.tex | 27 +++++ tex/references.bib | 0 tex/sec/0 abstract.tex | 3 + tex/sec/0 dictionairy.tex | 15 +++ tex/sec/0 frontpage.tex | 5 + {src/sections => tex/sec}/1 introduction.tex | 4 - tex/tmp/.gitkeep | 1 + tex/variables.tex | 25 +++++ 16 files changed, 270 insertions(+), 67 deletions(-) create mode 100644 .vscode/LaTeX.code-snippets create mode 100644 .vscode/settings.json delete mode 100644 src/main.tex delete mode 100644 src/references.bib create mode 100644 tex/doc/.gitkeep create mode 100644 tex/img/.gitkeep create mode 100644 tex/main.tex create mode 100644 tex/packages.tex create mode 100644 tex/references.bib create mode 100644 tex/sec/0 abstract.tex create mode 100644 tex/sec/0 dictionairy.tex create mode 100644 tex/sec/0 frontpage.tex rename {src/sections => tex/sec}/1 introduction.tex (80%) create mode 100644 tex/tmp/.gitkeep create mode 100644 tex/variables.tex diff --git a/.gitignore b/.gitignore index ec6cb9f..ef0c0e8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,13 @@ +# LaTeX build files +**/tex/**/*.aux +**/tex/**/*.bbl +**/tex/**/*.blg +**/tex/**/*.fdb_latexmk +**/tex/**/*.fls +**/tex/**/*.log +**/tex/**/*.out +**/tex/**/*.toc +**/tex/**/*.synctex.* + +**/tmp/* !.gitkeep - -tmp/ -src/tmp - -node_modules/ - -obj/ -out/ \ No newline at end of file diff --git a/.vscode/LaTeX.code-snippets b/.vscode/LaTeX.code-snippets new file mode 100644 index 0000000..112bcc8 --- /dev/null +++ b/.vscode/LaTeX.code-snippets @@ -0,0 +1,31 @@ +{ + "Create Table": { + "prefix": "tbl", + "body": [ + "\\begin{table}[ht]", + " \\centering", + " \\begin{threeparttable}", + " \\begin{tabular}{p{2.5cm}|p{8.5cm}}", + " \\toprule", + " $1 & $2 \\\\\\\\", + " \\hline", + " $3 & $4 \\\\\\\\", + " \\bottomrule", + " \\end{tabular}", + " \\end{threeparttable}", + "\\end{table}" + ], + "description": "Create a table with two columns", + }, + "Create Figure": { + "prefix": "fig", + "body": [ + "\\begin{figure}[H]", + " \\includegraphics[width=1\\textwidth]{../img/$1}", + " \\caption{$2}", + " \\label{fig:$3}", + "\\end{figure}" + ], + "description": "Create a figure ", + } +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..b154284 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,112 @@ +{ + "latex-workshop.latex.autoBuild.cleanAndRetry.enabled": true, + "latex-workshop.latex.clean.subfolder.enabled": true, + "latex-workshop.latex.external.build.args": [ "--shell-escape" ], + "latex-workshop.latex.outDir": "tmp", + "latex-workshop.latex.tools": [ + { + "name": "latexmk", + "command": "latexmk", + "args": [ + "-synctex=1", + "-interaction=nonstopmode", + "-file-line-error", + "-pdf", + "-outdir=%OUTDIR%", + "%DOC%", + "--shell-escape", + ], + "env": {} + }, + { + "name": "lualatexmk", + "command": "latexmk", + "args": [ + "-synctex=1", + "-interaction=nonstopmode", + "-file-line-error", + "-lualatex", + "-outdir=%OUTDIR%", + "%DOC%" + ], + "env": {} + }, + { + "name": "xelatexmk", + "command": "latexmk", + "args": [ + "-synctex=1", + "-interaction=nonstopmode", + "-file-line-error", + "-xelatex", + "-outdir=%OUTDIR%", + "%DOC%" + ], + "env": {} + }, + { + "name": "latexmk_rconly", + "command": "latexmk", + "args": [ + "%DOC%" + ], + "env": {} + }, + { + "name": "pdflatex", + "command": "pdflatex", + "args": [ + "-synctex=1", + "-interaction=nonstopmode", + "-file-line-error", + "%DOC%" + ], + "env": {} + }, + { + "name": "bibtex", + "command": "bibtex", + "args": [ + "%DOCFILE%" + ], + "env": {} + }, + { + "name": "rnw2tex", + "command": "Rscript", + "args": [ + "-e", + "knitr::opts_knit$set(concordance = TRUE); knitr::knit('%DOCFILE_EXT%')" + ], + "env": {} + }, + { + "name": "jnw2tex", + "command": "julia", + "args": [ + "-e", + "using Weave; weave(\"%DOC_EXT%\", doctype=\"tex\")" + ], + "env": {} + }, + { + "name": "jnw2texmintex", + "command": "julia", + "args": [ + "-e", + "using Weave; weave(\"%DOC_EXT%\", doctype=\"texminted\")" + ], + "env": {} + }, + { + "name": "tectonic", + "command": "tectonic", + "args": [ + "--synctex", + "--keep-logs", + "%DOC%.tex" + ], + "env": {} + } + ] +} diff --git a/src/main.tex b/src/main.tex deleted file mode 100644 index 7d04e14..0000000 --- a/src/main.tex +++ /dev/null @@ -1,54 +0,0 @@ -\documentclass[10pt]{article} - -%/ Use case: margins -\usepackage[letterpaper, - top=2cm, - bottom=2cm, - left=2cm, - right=2cm, - marginparwidth=1.75cm]{geometry} -%/ Use case: language and spell checking -\usepackage[utf8]{inputenc} -\usepackage[english]{babel} -%/ Use case: uppercase headers -\usepackage{titlecaps} -\usepackage{sectsty} -%/ Use case: text formatting -\usepackage{url} -\usepackage[outputdir=tmp]{minted} -\usepackage[colorlinks=true, allcolors=teal]{hyperref} -\usepackage{textcomp} -\usepackage{amsmath} -%/ Use case: images -\usepackage{graphicx} -\usepackage[export]{adjustbox} -\usepackage[font=small,labelfont=bf]{caption} -%/ Use case: tables -\usepackage{booktabs} -\usepackage[flushleft]{threeparttable} -\usepackage{pgfplots} -\usepackage{pgfplotstable} - -\pgfplotsset{compat=1.18} - -\allsectionsfont{\mdseries\scshape} - -\title{\titlecap{\scshape Title}}\normalfont -\author{Wessel Tip $<$contact@wessel.gg$>$ (Student number 696770, \url{https://wessel.gg/})} -\date{Computer Engineering at InHolland (Year 1, Semester x, Month. year - Month. year)} - -\begin{document} - -\maketitle - -\begin{abstract} -\end{abstract} - -\tableofcontents - -\input{sections/1 introduction} - -\bibliographystyle{IEEEtran} -\bibliography{references.bib} - -\end{document} diff --git a/src/references.bib b/src/references.bib deleted file mode 100644 index 8b13789..0000000 --- a/src/references.bib +++ /dev/null @@ -1 +0,0 @@ - diff --git a/tex/doc/.gitkeep b/tex/doc/.gitkeep new file mode 100644 index 0000000..d47982b --- /dev/null +++ b/tex/doc/.gitkeep @@ -0,0 +1 @@ +Contains any external documents such as PDFs diff --git a/tex/img/.gitkeep b/tex/img/.gitkeep new file mode 100644 index 0000000..af2222e --- /dev/null +++ b/tex/img/.gitkeep @@ -0,0 +1 @@ +Contains any images used in the sections diff --git a/tex/main.tex b/tex/main.tex new file mode 100644 index 0000000..7e0ae74 --- /dev/null +++ b/tex/main.tex @@ -0,0 +1,37 @@ +\documentclass{IEEEconf} + +\input{packages.tex} +\input{variables.tex} + +\begin{document} +\sffamily +% Front page containing title, author and date +\pagenumbering{gobble} +\input{sec/0 frontpage.tex} +\newpage + +% Set page numbering to arabic and show the table of contents, toc should not contain page number +\pagenumbering{arabic} +\thispagestyle{empty} +\tableofcontents +\newpage + +% Enable two column layout for the rest of the document +\twocolumn + +% Dictionary containing all the terms used in the document +\input{sec/0 dictionairy.tex} +\newpage + +% Abstract of the document +\input{sec/0 abstract.tex} + +% Sections of the document +\input{sec/1 introduction.tex} + +\label{sec:referenties} +\bibliography{references} + +% Appendices +% \input{sections/8 attachments.tex} +\end{document} diff --git a/tex/packages.tex b/tex/packages.tex new file mode 100644 index 0000000..88fffdf --- /dev/null +++ b/tex/packages.tex @@ -0,0 +1,27 @@ +%/ Use case: language and spell checking +\usepackage[utf8]{inputenc} +\usepackage[english]{babel} +\usepackage{caption} +%/ Use case: uppercase headers +\usepackage{titlecaps} +\usepackage{sectsty} +%/ Use case: text formatting +\usepackage{url} +% \usepackage[newfloat,outputdir=tmp]{minted} +\usepackage[colorlinks=true, allcolors=teal]{hyperref} +\usepackage{textcomp} +\usepackage{amsmath} +\usepackage{float} +%/ Use case: images +\usepackage{graphicx} +\usepackage[export]{adjustbox} +\usepackage[font=small,labelfont=bf]{caption} +%/ Use case: tables +\usepackage{booktabs} +\usepackage[flushleft]{threeparttable} +\usepackage{pgfplots} +\usepackage{pgfplotstable} +%/ Use case: paragraph indentation +\usepackage{parskip} + +\usepackage{float} diff --git a/tex/references.bib b/tex/references.bib new file mode 100644 index 0000000..e69de29 diff --git a/tex/sec/0 abstract.tex b/tex/sec/0 abstract.tex new file mode 100644 index 0000000..2bc5ad8 --- /dev/null +++ b/tex/sec/0 abstract.tex @@ -0,0 +1,3 @@ +\begin{abstract} + +\end{abstract} diff --git a/tex/sec/0 dictionairy.tex b/tex/sec/0 dictionairy.tex new file mode 100644 index 0000000..0bc5ad8 --- /dev/null +++ b/tex/sec/0 dictionairy.tex @@ -0,0 +1,15 @@ +\onecolumn +% todo(wessel) +\section*{Dictionairy} +\begin{table}[ht] + \raggedright + \begin{threeparttable} + \begin{tabular}{p{4cm}|p{11.5cm}} + \toprule + \textbf{Term} & \textbf{Meaning} \\ + \hline + \bottomrule + \end{tabular} + \end{threeparttable} +\end{table} +\twocolumn diff --git a/tex/sec/0 frontpage.tex b/tex/sec/0 frontpage.tex new file mode 100644 index 0000000..874c52e --- /dev/null +++ b/tex/sec/0 frontpage.tex @@ -0,0 +1,5 @@ +\onecolumn +\maketitle + +% Push the content below to the bottom of the page +\vfill diff --git a/src/sections/1 introduction.tex b/tex/sec/1 introduction.tex similarity index 80% rename from src/sections/1 introduction.tex rename to tex/sec/1 introduction.tex index 744d0e4..a7da11d 100644 --- a/src/sections/1 introduction.tex +++ b/tex/sec/1 introduction.tex @@ -1,6 +1,2 @@ -\newpage - \section{Introduction} \label{sec:introduction} - - diff --git a/tex/tmp/.gitkeep b/tex/tmp/.gitkeep new file mode 100644 index 0000000..c2931ef --- /dev/null +++ b/tex/tmp/.gitkeep @@ -0,0 +1 @@ +Contains build files diff --git a/tex/variables.tex b/tex/variables.tex new file mode 100644 index 0000000..cf0b0c9 --- /dev/null +++ b/tex/variables.tex @@ -0,0 +1,25 @@ +\graphicspath{ {./img/} } +\pgfplotsset{compat=1.18} + +% Sets the default font +% \allsectionsfont{\mdseries\scshape} + +\title{\titlecap{\scshape Title}\normalfont} +\author{Wessel Tip $<$contact@wessel.gg$>$ (\url{https://wessel.gg/})} + +% Empty date +\date{\today} + +% Sets the description name of code blocks to "Source Code" +% \newenvironment{code}{\captionsetup{type=listing}}{} +% \SetupFloatingEnvironment{listing}{name=Source Code} + +% \renewcommand{\theFancyVerbLine}{\sffamily +% \textcolor[rgb]{0.5,0.5,1.0}{\scriptsize +% \oldstylenums{\arabic{FancyVerbLine}}}} + +% Sets the bibliography style to IEEE +\bibliographystyle{IEEEtran} + +% Disables the no citations error +\nocite{*}