From f5da5d0d5489481ddb18dcb6088059884efeb024 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Mon, 2 Sep 2024 15:24:22 +0200 Subject: initial commit (WIP repo scaffolding) --- .editorconfig | 11 ++++++ .gitignore | 33 ++++++++++++++++++ contributing.md | 13 ++++++++ license | 21 ++++++++++++ makefile | 0 meta.tex | 10 ++++++ plan.tex | 9 +++++ projdoc.cls | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.md | 7 ++++ sources.bib | 0 style.md | 30 +++++++++++++++++ 11 files changed, 236 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 contributing.md create mode 100644 license create mode 100644 makefile create mode 100644 meta.tex create mode 100644 plan.tex create mode 100644 projdoc.cls create mode 100644 readme.md create mode 100644 sources.bib create mode 100644 style.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..1bd7da9 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,11 @@ +root = true + +[*] +indent_style = tab +end_of_line = lf +insert_final_newline = true + +[*.{md,yml}] +indent_style = space +indent_size = 2 + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f087c7f --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +# latex files +*.aux +*.bbl +*.bcf +*.blg +*.fdb_latexmk +*.fls +*.log +*.out +*.run.xml +*.synctex.gz +*.toc +*.synctex(busy) +*.lof +*.lot +*.glo +*.gls +*.glg +*.ist +*.acn +*.pytxcode +*.glstex +*.cb +*.cb2 +*.d +*.nav +*.snm + +# output files +*.pdf +!img/*.pdf +img/*.puml.pdf + diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..891b104 --- /dev/null +++ b/contributing.md @@ -0,0 +1,13 @@ +# Code style + +- Indent using tabs +- Wrap long lines at column 80 +- Diacritical marks should be represented in ASCII using LaTeX syntax instead + of using UTF-8 (i.e. `fa\c{c}ade` instead of `façade`) +- Images should be placed in the [img/](./img/) folder + + + diff --git a/license b/license new file mode 100644 index 0000000..5fe3518 --- /dev/null +++ b/license @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Loek Le Blansch + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/makefile b/makefile new file mode 100644 index 0000000..e69de29 diff --git a/meta.tex b/meta.tex new file mode 100644 index 0000000..9c12a3e --- /dev/null +++ b/meta.tex @@ -0,0 +1,10 @@ +\organization{Avans University of Applied Sciences} +\project{PROJECT NAME} +\version{0.0} +\author{% + Loek Le Blansch\and% + Wouter Boerenkamps\and% + Jaro Rutjes\and% + Max Smits\and% + Niels Stunnebrink% +} diff --git a/plan.tex b/plan.tex new file mode 100644 index 0000000..eb6c4e4 --- /dev/null +++ b/plan.tex @@ -0,0 +1,9 @@ +\documentclass{projdoc} +\include{meta.tex} + +\title{Project Plan} + +\begin{document} +hoi +\end{document} + diff --git a/projdoc.cls b/projdoc.cls new file mode 100644 index 0000000..c1865ec --- /dev/null +++ b/projdoc.cls @@ -0,0 +1,102 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesClass{school-assignment}[2024-01-20 class school-assignment] + +% based on article +\LoadClass{article} + +% default word page setup +\PassOptionsToPackage{margin=1in}{geometry} +\PassOptionsToPackage{a4paper}{geometry} +% confusing to acrobat/firefox users +\PassOptionsToPackage{hidelinks}{hyperref} +\PassOptionsToPackage{english}{babel} + +% frequently used packages +\RequirePackage{geometry} +\RequirePackage{float} +\RequirePackage{babel} +\RequirePackage{siunitx} +\RequirePackage{csquotes} +\RequirePackage{parskip} +\RequirePackage{fontspec} +\RequirePackage{tabularx} +\RequirePackage{booktabs} +\RequirePackage{needspace} +\RequirePackage{hyperref} +\RequirePackage{microtype} +\RequirePackage{smartref} + +% font style +\setmainfont{TeX Gyre Schola} +\setmonofont[Scale=0.85]{JetBrainsMono Nerd Font} + +% fix fonts w/ siunitx +\sisetup{detect-all = true} + +% no indented paragraphs, just skip +\parindent=0mm +\bigskipamount=7mm +\medskipamount=4mm + +% \maketitle format +\makeatletter +\let\@project\relax +\def\project#1{\def\@project{#1}} +\let\@organization\relax +\def\organization#1{\def\@organization{#1}} +\let\@version\relax +\def\version#1{\def\@version{#1}} +\def\@maketitle{ + \centering + \vspace*{2in} + { + { + \bfseries\Huge + \strut\@title\strut + }\\% no parskip + { + \Large + \strut\@project\strut + } + } + + \vspace{1in} + + { + { + \def\and{\par} + \parskip=0.5ex + \strut\@author\strut + } + + \vspace{2em} + + {\strut\@organization\strut} + } + + \vfill + \flushright + + { + { + \strut{}Version \@version\strut + } + + { + \strut\@date\strut + } + } + + \vspace*{2in} +} +\makeatother + +% always start with title page +\AtBeginDocument{ + \clearpage + \begin{titlepage} + \maketitle + \thispagestyle{empty} + \end{titlepage} +} + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..ecc8229 --- /dev/null +++ b/readme.md @@ -0,0 +1,7 @@ +# Docs + +Project documentation in LaTeX format + +Please see [style.md](./style.md) for writing style and +[contributing.md](./contributing.md) for coding and git standards. + diff --git a/sources.bib b/sources.bib new file mode 100644 index 0000000..e69de29 diff --git a/style.md b/style.md new file mode 100644 index 0000000..83410e2 --- /dev/null +++ b/style.md @@ -0,0 +1,30 @@ +# Spelling + +All documentation is written in U.S. English + +# Grammar + +## Comma And + +**In lists**, the last element is mentioned using the word 'and', *without* a +comma. + +**When joining independent clauses**, keep a comma before the word 'and'. +Usually, this comma can be left out for short clauses, but we keep them in for +consistency. + +**Good examples:** + +> The first, second and last items. +> +> Action X was performed, and this had Y impact. + +# Figures + +Non-raster figures are preferred over rasterized figures (where applicable). +Please note that LaTeX does not support SVG images, and these need to be +converted to PDF (e.g. using `svg2pdf` on linux). + +Raster images should only be used when the source is already in a raster format +(e.g. for photos) or when otherwise impractical. + -- cgit v1.2.3