├── paper.pdf ├── collage-4.jpg ├── latex ├── figures │ ├── template-image.tex │ ├── template-pdf.tex │ ├── template-tikz.tex │ ├── template-algo.tex │ └── template-graph.tex ├── paper.xmpdata ├── mt-protrusion.cfg ├── sections │ ├── endpage.tex │ └── body.tex ├── citations.bib ├── paper.tex ├── configuration.tex └── humanize.cls ├── makefile ├── README.md ├── .gitignore └── LICENSE.md /paper.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ShenZhouHong/latex-essay/HEAD/paper.pdf -------------------------------------------------------------------------------- /collage-4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ShenZhouHong/latex-essay/HEAD/collage-4.jpg -------------------------------------------------------------------------------- /latex/figures/template-image.tex: -------------------------------------------------------------------------------- 1 | % Template for inserting an image as a figure 2 | \begin{figure}[H] 3 | \centering 4 | \includegraphics[width=\textwidth]{img-name-without-extension} 5 | \caption{Image Caption here} 6 | \label{fig:label} 7 | \end{figure} 8 | -------------------------------------------------------------------------------- /latex/figures/template-pdf.tex: -------------------------------------------------------------------------------- 1 | % Template for including a PDF page as a figure 2 | \begin{figure}[H] 3 | \centering 4 | \fbox{ 5 | \includegraphics[ 6 | page=1, 7 | width=0.5\textwidth, 8 | angle=0 9 | ]{path/to/pdf.pdf} 10 | } 11 | \caption{PDF Caption Here} 12 | \label{fig:pdf} 13 | \end{figure} 14 | -------------------------------------------------------------------------------- /latex/paper.xmpdata: -------------------------------------------------------------------------------- 1 | \Author{Shen Zhou Hong} 2 | \Title{ 3 | Default PDF Document Title (For PDF/A Compatibility) 4 | } 5 | \Language{English} 6 | \Keywords{keyword1\sep keyword2\sep keyword3} 7 | \Publisher{Self-Published} 8 | \Subject{ 9 | Description of the PDF's subject 10 | } 11 | \Date{2022-11-23} 12 | \PublicationType{pamphlet} 13 | \Source{https://github.com/ShenZhouHong/latex-essay} 14 | \URLlink{https://github.com/ShenZhouHong/latex-essay} 15 | -------------------------------------------------------------------------------- /latex/mt-protrusion.cfg: -------------------------------------------------------------------------------- 1 | % Custom protrusion rules to allow hanging punctuation 2 | 3 | \LoadMicrotypeFile{ptm} 4 | \SetProtrusion[ 5 | name = hangingpunct, 6 | load = ptm-T1 7 | ]{ 8 | encoding = TU, 9 | }{ 10 | {.} = { , 1000}, 11 | {,} = { , 1000}, 12 | {«} = {1000, }, 13 | {»} = { , 1000}, 14 | {(} = { 0 , }, 15 | {)} = { , 0 }, 16 | {-} = { , 500 }, 17 | % Double Quotes 18 | \textquotedblleft 19 | = {1000, }, 20 | \textquotedblright 21 | = { , 1000}, 22 | \quotedblbase 23 | = {1000, }, 24 | % Single Quotes 25 | \textquoteleft 26 | = {1000, }, 27 | \textquoteright 28 | = { , 1000}, 29 | \quotesinglbase 30 | = {1000, } 31 | } -------------------------------------------------------------------------------- /latex/figures/template-tikz.tex: -------------------------------------------------------------------------------- 1 | % Template for an lambert quadrilateral, using tkz-euclide 2 | \begin{figure}[H] 3 | \centering 4 | \begin{tikzpicture} 5 | % External vertices 6 | \tkzDefPoint(0,0){A} 7 | \tkzDefPoint(8,0){B} 8 | \tkzDefPoint(0,4){C} 9 | \tkzDefPoint(8,4){D} 10 | \tkzDrawPoints(A,B,C,D) 11 | \tkzDrawPolygon(A,B,D,C) 12 | \tkzLabelPoints[above](C,D) 13 | \tkzLabelPoints[below](A,B) 14 | 15 | % Mark Angles 16 | \tkzMarkAngle[size=0.4, mark=none](A,C,D) 17 | \tkzMarkRightAngle[size=0.4, mark=none](C,D,B) 18 | \tkzMarkRightAngle[size=0.4](C,A,B) 19 | \tkzMarkRightAngle[size=0.4](A,B,D) 20 | \end{tikzpicture} 21 | \caption{Lambert quadrilateral} 22 | \label{lambert-1} 23 | \end{figure} 24 | -------------------------------------------------------------------------------- /latex/sections/endpage.tex: -------------------------------------------------------------------------------- 1 | % Uncomment for bibliography using biblatex (see paper.tex) 2 | % \section*{Bibliography} 3 | % % Print every citation in citations.bib, even if unused by \autocite 4 | % \nocite{*} 5 | % \printbibliography[heading=none] 6 | 7 | \section*{Technical Notes} 8 | This essay is typeset using \LaTeX, an Open Source document typesetting language 9 | by Donald Knuth, and version-controlled via Git. The git repository containing notes, source code, and revision history is available upon request. 10 | 11 | % Optional: Include github URL here 12 | % \url{https://github.com/ShenZhouHong/} 13 | 14 | \noindent 15 | This essay is written using the EssayTemplate, an open source \LaTeX\ essay 16 | template designed for the Humanities by Shen Zhou Hong. It is available at: 17 | 18 | \url{https://github.com/ShenZhouHong/EssayTemplate} 19 | 20 | \vfill 21 | \begin{center} 22 | This \LaTeX\ essay is also available in Microsoft Word, OpenOffice, HTML, and \mbox{plain text} upon request. 23 | \end{center} 24 | -------------------------------------------------------------------------------- /latex/sections/body.tex: -------------------------------------------------------------------------------- 1 | \section{Introduction} 2 | 3 | \lipsum[1][1-4] 4 | 5 | \lipsum[2][1-4] 6 | 7 | 8 | \begin{itemize} 9 | \item \textbf{Ææa pestifero gaudia pater pasci Politen inlaesos.} 10 | \item \enquote{Te mihi Actaea celebrare tamen consistere paretque.} 11 | \item Quo magna summoque ignibus \emph{terra est ossibus.} 12 | \end{itemize} 13 | 14 | \subsection{First Example Subheading} 15 | 16 | \lipsum[3][1-3] 17 | 18 | \blockquote{% 19 | \lipsum[1] 20 | } 21 | 22 | \lipsum[4][1-6] 23 | 24 | \begin{enumerate} 25 | \item Alveus metior celebrare. 26 | \item Oscula eget summoque. 27 | \item \enquote{Quo magna summoque,} ignibus terra est ossibus 28 | \end{enumerate} 29 | 30 | \subsubsection{First Example Sub-Sub-Headings} 31 | 32 | \lipsum[5][1-4] 33 | 34 | \subsubsection{Second Example Sub-Sub-Headings} 35 | 36 | \lipsum[6][1-6] 37 | 38 | \subsubsection*{Third Example Sub-Sub-Headings (Without Numbering)} 39 | 40 | \lipsum[7][1-6] 41 | 42 | \subsection{Second Example Sub-Headings} 43 | 44 | \lipsum[8][1-6] 45 | 46 | \subsection{Third Example Sub-Headings} 47 | 48 | \lipsum[9][1-6] 49 | 50 | \section{Second Example Heading} 51 | 52 | \lipsum[10] 53 | -------------------------------------------------------------------------------- /latex/citations.bib: -------------------------------------------------------------------------------- 1 | @book{hackett, 2 | title = {Critique of Pure Reason}, 3 | author = {Immanuel Kant and Werner S. Pluhar and Patricia Kitcher and James W. Ellington}, 4 | publisher = {Hackett Publishing Company, Inc.}, 5 | year = {1996}, 6 | series = {}, 7 | edition = {Paperback}, 8 | volume = {}, 9 | } 10 | 11 | @book{penguin, 12 | title = {Critique of pure reason}, 13 | author = {Immanuel Kant and Marcus Weigelt and Friedrich Max Müller}, 14 | publisher = {Penguin Books}, 15 | year = {2007}, 16 | series = {Penguin classics}, 17 | edition = {}, 18 | volume = {}, 19 | } 20 | 21 | @book{german, 22 | title = {Kritik Der Reinen Vernunft}, 23 | author = {Immanuel Kant and J. Timmermann and H. Klemme}, 24 | publisher = {Koch, Neff \& Oetinger \& Co}, 25 | year = {1956}, 26 | series = {Philosophische Bibliothek}, 27 | edition = {Nach der 1. und 2. Originalausg}, 28 | volume = {}, 29 | } 30 | 31 | @book{prolegomena, 32 | title = {Prolegomena to Any Future Metaphysics: That Will Be Able to Come Forward as Science: With Selections from the Critique of Pure Reason}, 33 | author = {Immanuel Kant and Gary Hatfield}, 34 | publisher = {Cambridge University Press}, 35 | year = {2004}, 36 | series = {Cambridge Texts in the History of Philosophy}, 37 | edition = {}, 38 | volume = {}, 39 | } 40 | -------------------------------------------------------------------------------- /latex/paper.tex: -------------------------------------------------------------------------------- 1 | % LaTeX Generic essay template 2 | % Copyright (C) 2017 Shen Zhou Hong 3 | % 4 | % This program is free software: you can redistribute it and/or modify 5 | % it under the terms of the GNU General Public License as published by 6 | % the Free Software Foundation, either version 3 of the License, or 7 | % (at your option) any later version. 8 | % 9 | % This program is distributed in the hope that it will be useful, 10 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | % GNU General Public License for more details. 13 | % 14 | % You should have received a copy of the GNU General Public License 15 | % along with this program. If not, see . 16 | 17 | % For more information on documentclass configuration, see: 18 | % https://texblog.org/2013/02/13/latex-documentclass-options-illustrated/#formula 19 | \documentclass[ 20 | protrudelabels, 21 | onehalfspacing, 22 | extraligatures, 23 | notitlepage, 24 | english, 25 | widemargins 26 | ]{humanize} 27 | 28 | \input{configuration.tex} 29 | 30 | % Document Title, Author, and Date 31 | \title{ 32 | \LaTeX\ Essay Template 33 | } 34 | \author{ 35 | Shen Zhou Hong \and Institution 36 | } 37 | \date{\today} 38 | 39 | % Document Begins 40 | \begin{document} 41 | \maketitle 42 | \tableofcontents 43 | 44 | \include{sections/body.tex} 45 | 46 | \include{sections/endpage.tex} 47 | 48 | \end{document} 49 | -------------------------------------------------------------------------------- /makefile: -------------------------------------------------------------------------------- 1 | # List of named documents to build. Add one for every seperate LaTeX document root 2 | TARGETS := paper.pdf 3 | 4 | # Specify LaTeX source directory & destination directory for compiled PDFs 5 | SRC_DIR = latex/ 6 | DEST_DIR = ./ 7 | 8 | # Autodiscover dependencies for target PDFs. 9 | TEX_FILES := $(shell find $(SRC_DIR) -type f -name '*.tex') 10 | CLS_FILES := $(shell find $(SRC_DIR) -type f -name '*.cls') 11 | XMP_FILES := $(shell find $(SRC_DIR) -type f -name '*.xmpdata') 12 | IMG_FILES := $(shell find $(SRC_DIR) -type f \( -name '*.jpg' -o -name '*.jpeg' -o -name '*.png' \)) 13 | DEPENDS := $(TEX_FILES) $(CLS_FILES) $(XMP_FILES) $(IMG_FILES) 14 | 15 | # Set creation & mod. date of PDF to epoch of latest git commit for reproducible builds. 16 | COMMIT_EPOCH = $(shell git log -1 --pretty=%ct) 17 | 18 | # Build all targets 19 | all: $(TARGETS) 20 | 21 | # For every PDF target, build it's corresponding TeX file with dependencies 22 | %.pdf: $(addprefix $(SRC_DIR), %.tex) $(DEPENDS) 23 | SOURCE_DATE_EPOCH=$(COMMIT_EPOCH) latexmk -pdf -lualatex -silent -cd -use-make $< 24 | mv -u -v $(addprefix $(SRC_DIR), $@) $(DEST_DIR)$@ 25 | sha256sum $(DEST_DIR)$@ 26 | 27 | # Delete LaTeX compilation auxiliary files. 28 | clean: 29 | latexmk -cd -quiet -c $(addprefix $(SRC_DIR), $(basename $(TARGETS))) 30 | 31 | # Delete LaTeX compilation auxiliary files AND output PDFs (if they exist) 32 | delete: clean 33 | @if [ -n "$(wildcard $(addprefix $(DEST_DIR), $(TARGETS)))" ]; then \ 34 | rm -v $(addprefix $(DEST_DIR), $(TARGETS)); \ 35 | fi -------------------------------------------------------------------------------- /latex/figures/template-algo.tex: -------------------------------------------------------------------------------- 1 | % Templates for typesetting algorithms and pseudocode 2 | \begin{algorithm} 3 | \caption{Euclid’s algorithm} 4 | \label{euclid} 5 | \begin{algorithmic}[1] 6 | \Function{Euclid}{$a,b$} 7 | \Comment{The g.c.d. of a and b} 8 | \State $r\gets a\bmod b$ 9 | \While{$r\not=0$}\Comment{We have the answer if r is 0} 10 | \State $a\gets b$ 11 | \State $b\gets r$ 12 | \State $r\gets a\bmod b$ 13 | \EndWhile 14 | \label{euclidendwhile} 15 | \State \textbf{return} $b$\Comment{The gcd is b} 16 | \EndFunction 17 | \end{algorithmic} 18 | \end{algorithm} 19 | 20 | % Blank template 21 | \begin{algorithm} 22 | \begin{algorithmic}[0] 23 | \Function{CheckColumn}{puzzle, j} 24 | \State \ldots\ 25 | \EndFunction 26 | \end{algorithmic} 27 | \end{algorithm} 28 | 29 | % Blank minted template (for formatting python source code) 30 | \begin{listing}[h] 31 | \begin{minted}[baselinestretch=1.0, frame=lines, mathescape, fontfamily=helvetica]{python} 32 | def CheckColumn(puzzle, j): 33 | return False 34 | \end{minted} 35 | \end{listing} 36 | 37 | % side-by-side template 38 | \begin{algorithm} 39 | \centering 40 | \begin{minipage}{0.50\textwidth} 41 | \centering 42 | \begin{algorithmic}[0] 43 | % pseudocode goes here 44 | \end{algorithmic} 45 | \end{minipage}\hfill 46 | \begin{minipage}{0.50\textwidth} 47 | \centering 48 | \begin{minted}[baselinestretch=1.0, frame=lines, mathescape, fontfamily=helvetica]{python} 49 | # python goes here 50 | \end{minted} 51 | \end{minipage} 52 | \end{algorithm} 53 | -------------------------------------------------------------------------------- /latex/figures/template-graph.tex: -------------------------------------------------------------------------------- 1 | % Template for a TiKZ/PGFPlot Graph 2 | \begin{figure}[H] 3 | \begin{tikzpicture}[trim axis left] 4 | % All the graphing elements are inside axis environment 5 | \begin{axis}[ 6 | width=\textwidth, 7 | height=7cm, 8 | scale only axis, 9 | title={Graph Title Here}, 10 | xlabel={Graph X-Axis Label}, 11 | ylabel={Graph Y-Axis Label}, 12 | xmin=0, xmax=350, 13 | ymin=0, ymax=10, 14 | grid=both, 15 | minor tick num=1, 16 | grid style=dotted, 17 | legend pos=south east, 18 | x tick label style={ 19 | /pgf/number format/fixed, 20 | /pgf/number format/fixed zerofill, 21 | /pgf/number format/precision=2 22 | }, 23 | y tick label style={ 24 | /pgf/number format/fixed, 25 | /pgf/number format/fixed zerofill, 26 | /pgf/number format/precision=2 27 | }, 28 | ] 29 | 30 | % CSV Data Table Plot Example 31 | \addplot[ 32 | only marks, 33 | color=blue, 34 | mark=*, 35 | ] 36 | table[ 37 | col sep=comma, 38 | header=false, 39 | x index=0, 40 | y index=1 41 | ]{table-data-filepath.csv}; 42 | \addlegendentry{Plot Entry Legend Label 1} 43 | 44 | % Equation Plot Example 45 | \addplot[ 46 | color=blue, 47 | no marks, 48 | solid, 49 | thick, 50 | domain=0:90 51 | ] 52 | { 53 | 9.10 * cos(x)^2 54 | }; 55 | \addlegendentry{Plot Entry Legend Label 2} 56 | \end{axis} 57 | \end{tikzpicture} 58 | \caption{Graph Caption Here} 59 | \label{graph:label-here} 60 | \end{figure} 61 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Shen's LaTeX Essay Template 2 | This is my LaTeX Essay Template. It is a best-in-class LuaLaTeX template for writing essays, dissertations, documents, and papers in the academic humanities. It includes a custom LaTeX `documentclass` called `humanize`, which is based off the `article` class, and contains all of the custom styling and configuration. 3 | 4 | ![Example of documents created using this template](./collage-4.jpg) 5 | 6 | ## Features 7 | This template uses a number of advanced LaTeX features. 8 | 9 | * Complete **PDF/A-3u Compatibility**, for Archival Grade Documents. 10 | * **Fully Reproducible Builds** for PDF Compilation, using Makefile. 11 | * **Custom Microtype Protrusion** Settings for Hanging Punctuation. 12 | * **Typography Tweaks**, Adjustments, and Custom Headers and Footers. 13 | * **BibLaTeX Integration** for Citation Management 14 | 15 | ## Quickstart 16 | This git repository is set as a template. Simply clone the template, and begin. The root document is located at `./latex/paper.tex`. The `documentclass`, `\Title`, `\Author`, and `\Date` fields can be modified there. 17 | 18 | 19 | To compile the document, simply run `make`: 20 | 21 | ``` 22 | make 23 | ``` 24 | 25 | ## Documentation 26 | This template is broadly organized into two directories. `sections` contain the body of the text. `figures` contains additional templates for figures, diagrams, and graphs. 27 | 28 | ``` 29 | . 30 | ├── collage-4.jpg 31 | ├── latex 32 | │ ├── figures 33 | │ │ └── template-*.tex 34 | │ ├── humanize.cls 35 | │ ├── betterprotrusionboundary.lua 36 | │ ├── configuration.tex 37 | │ ├── mt-protrusion.cfg 38 | │ ├── citations.bib 39 | │ ├── paper.pdf 40 | │ ├── paper.tex 41 | │ ├── paper.xmpdata 42 | │ ├── makefile 43 | │ └── sections 44 | │ ├── body.tex 45 | │ └── endpage.tex 46 | ├── LICENSE.md 47 | ├── makefile 48 | └── README.md 49 | 50 | ``` 51 | 52 | The body of the text is meant to be included in the `./latex/sections` directory. Begin writing in `./latex/sections/body.tex`, and add additional sections within that directory (e.g. `./latex/sections/introduction.tex`). 53 | 54 | Metadata for the PDF must be configured in the `./latex/paper.xmpdata` file. This file is read by the `pdfx` package, and information within is used to generate a valid, standard-conformant PDF/A-3u document. 55 | 56 | The header, footer, and additional packages can be configured in `./latex/configurations.tex`. Biblatex, as well as a set of commonly used packages for mathematics and sciences are included as comments. 57 | 58 | ## Dependencies 59 | This template depends on the following programs: 60 | 61 | * GNU Make: Used for the makefile for compiling the PDF document 62 | * Latexmk: Tool used with Make to run LaTeX for the correct number of runs. 63 | * LuaLaTeX: The default typesetting engine used. 64 | * Microtype version >= `3.0`. This template uses advanced protrusion features only available in recent versions of microtype. 65 | 66 | ## Related documentation 67 | For an overview of how to populate biblatex `citations.bib` files, visit the 68 | biblatex-mla manual at CTAN. 69 | 70 | * https://www.ctan.org/pkg/biblatex-mla 71 | 72 | ## GPLv3 License 73 | The raw template itself is licensed under the terms of the GPL (version 3). A 74 | full copy of the license is attached in `LICENSE.md`. Naturally, any works 75 | that you create using this template (i.e. any actual essays you write using 76 | it) will be your own intellectual property. -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Core latex/pdflatex auxiliary files: 2 | *.aux 3 | *.lof 4 | *.log 5 | *.lot 6 | *.fls 7 | *.out 8 | *.toc 9 | *.fmt 10 | *.fot 11 | *.cb 12 | *.cb2 13 | 14 | ## Intermediate documents: 15 | *.dvi 16 | *.xdv 17 | *-converted-to.* 18 | # these rules might exclude image files for figures etc. 19 | # *.ps 20 | # *.eps 21 | # *.pdf 22 | 23 | ## Generated if empty string is given at "Please type another file name for output:" 24 | .pdf 25 | 26 | ## Bibliography auxiliary files (bibtex/biblatex/biber): 27 | *.bbl 28 | *.bcf 29 | *.blg 30 | *-blx.aux 31 | *-blx.bib 32 | *.run.xml 33 | 34 | ## Build tool auxiliary files: 35 | *.fdb_latexmk 36 | *.synctex 37 | *.synctex(busy) 38 | *.synctex.gz 39 | *.synctex.gz(busy) 40 | *.pdfsync 41 | 42 | ## Auxiliary and intermediate files from other packages: 43 | # algorithms 44 | *.alg 45 | *.loa 46 | 47 | # achemso 48 | acs-*.bib 49 | 50 | # amsthm 51 | *.thm 52 | 53 | # beamer 54 | *.nav 55 | *.pre 56 | *.snm 57 | *.vrb 58 | 59 | # changes 60 | *.soc 61 | 62 | # cprotect 63 | *.cpt 64 | 65 | # elsarticle (documentclass of Elsevier journals) 66 | *.spl 67 | 68 | # endnotes 69 | *.ent 70 | 71 | # fixme 72 | *.lox 73 | 74 | # feynmf/feynmp 75 | *.mf 76 | *.mp 77 | *.t[1-9] 78 | *.t[1-9][0-9] 79 | *.tfm 80 | 81 | #(r)(e)ledmac/(r)(e)ledpar 82 | *.end 83 | *.?end 84 | *.[1-9] 85 | *.[1-9][0-9] 86 | *.[1-9][0-9][0-9] 87 | *.[1-9]R 88 | *.[1-9][0-9]R 89 | *.[1-9][0-9][0-9]R 90 | *.eledsec[1-9] 91 | *.eledsec[1-9]R 92 | *.eledsec[1-9][0-9] 93 | *.eledsec[1-9][0-9]R 94 | *.eledsec[1-9][0-9][0-9] 95 | *.eledsec[1-9][0-9][0-9]R 96 | 97 | # glossaries 98 | *.acn 99 | *.acr 100 | *.glg 101 | *.glo 102 | *.gls 103 | *.glsdefs 104 | 105 | # gnuplottex 106 | *-gnuplottex-* 107 | 108 | # gregoriotex 109 | *.gaux 110 | *.gtex 111 | 112 | # hyperref 113 | *.brf 114 | 115 | # knitr 116 | *-concordance.tex 117 | # TODO Comment the next line if you want to keep your tikz graphics files 118 | *.tikz 119 | *-tikzDictionary 120 | 121 | # listings 122 | *.lol 123 | 124 | # makeidx 125 | *.idx 126 | *.ilg 127 | *.ind 128 | *.ist 129 | 130 | # minitoc 131 | *.maf 132 | *.mlf 133 | *.mlt 134 | *.mtc[0-9]* 135 | *.slf[0-9]* 136 | *.slt[0-9]* 137 | *.stc[0-9]* 138 | 139 | # minted 140 | _minted* 141 | *.pyg 142 | 143 | # morewrites 144 | *.mw 145 | 146 | # nomencl 147 | *.nlo 148 | 149 | # pax 150 | *.pax 151 | 152 | # pdfpcnotes 153 | *.pdfpc 154 | 155 | # sagetex 156 | *.sagetex.sage 157 | *.sagetex.py 158 | *.sagetex.scmd 159 | 160 | # scrwfile 161 | *.wrt 162 | 163 | # sympy 164 | *.sout 165 | *.sympy 166 | sympy-plots-for-*.tex/ 167 | 168 | # pdfcomment 169 | *.upa 170 | *.upb 171 | 172 | # pythontex 173 | *.pytxcode 174 | pythontex-files-*/ 175 | 176 | # thmtools 177 | *.loe 178 | 179 | # TikZ & PGF 180 | *.dpth 181 | *.md5 182 | *.auxlock 183 | 184 | # todonotes 185 | *.tdo 186 | 187 | # easy-todo 188 | *.lod 189 | 190 | # xindy 191 | *.xdy 192 | 193 | # xypic precompiled matrices 194 | *.xyc 195 | 196 | # endfloat 197 | *.ttt 198 | *.fff 199 | 200 | # Latexian 201 | TSWLatexianTemp* 202 | 203 | ## Editors: 204 | # WinEdt 205 | *.bak 206 | *.sav 207 | 208 | # Texpad 209 | .texpadtmp 210 | 211 | # Kile 212 | *.backup 213 | 214 | # KBibTeX 215 | *~[0-9]* 216 | 217 | # auto folder when using emacs and auctex 218 | /auto/* 219 | 220 | # expex forward references with \gathertags 221 | *-tags.tex 222 | 223 | # MacOS DS_Store file 224 | .DS_Store 225 | 226 | # XML Document Metadata (Generated during make) 227 | *.xmpi 228 | -------------------------------------------------------------------------------- /latex/configuration.tex: -------------------------------------------------------------------------------- 1 | % Lorem Ipsum placeholder for template 2 | \usepackage{lipsum} % For lorem lipsum placeholder text 3 | 4 | % Configuration for 'fancy' headers and footers 5 | \usepackage{fancyhdr} % For fancy headings 6 | \usepackage{lastpage} % Gives us \lastpage 7 | % Settings used by \usepackage{fancyhdr} 8 | \fancypagestyle{plain}{ 9 | % Clear all definitions from the fancy pagestyle 10 | \fancyhf{} 11 | \renewcommand{\headrulewidth}{0pt} 12 | \renewcommand{\footrulewidth}{0pt} 13 | 14 | % Ensure page numbers are the form page n of m. 15 | \fancyfoot[C]{Page~\thepage~of~\pageref*{LastPage}} 16 | } 17 | \fancypagestyle{fancy}{ 18 | % Fancy Header Formatting 19 | \renewcommand{\headrulewidth}{0.4pt} 20 | \fancyhead[L]{LaTeX Template} 21 | \fancyhead[C]{} 22 | \fancyhead[R]{Humanize} 23 | 24 | % Fancy Footer Formatting 25 | \renewcommand{\footrulewidth}{0pt} 26 | \fancyfoot[L]{} 27 | \fancyfoot[C]{Page~\thepage~of~\pageref*{LastPage}} 28 | \fancyfoot[R]{} 29 | } 30 | % Update the plain heading format so that the first page includes page n of m 31 | % Set the document header-footer pagestyle to fancy, from above 32 | \pagestyle{fancy} 33 | 34 | % Mathematical typesetting packages 35 | % \usepackage{amsmath} % Needed for most math things. 36 | % \usepackage{amssymb} % Additional mathematical symbols 37 | % \usepackage{amsthm} % For theorem and proof environments 38 | % \usepackage{tkz-euclide} % Used for planar geometry (Euclidean) 39 | 40 | % Scientific graphics and plotting 41 | % \usepackage{tikz} % Used for graphical illustrations. 42 | % \usepackage{pgfplots} % Used for scientific graphs and charts 43 | 44 | % Packages for typesetting code and pseudocode 45 | % In order to use minted, you must edit your makefile to -use-shell-escape! 46 | % \usepackage{minted} % Code highlighting: \begin{minted}{python} 47 | % \usepackage{algorithm} % Float environment for pseudocode 48 | % \usepackage{algpseudocode} % Typesetting library for pseudocode 49 | 50 | % Optional LaTeX packages for additional functionality 51 | % \usepackage[noframe]{showframe} % Debug option to show margin frames. 52 | % \usepackage{float} % For arranging floats 53 | % \usepackage{graphicx} % Required for embedding images 54 | % \usepackage{booktabs} % For prettier tables 55 | % \usepackage{tabularx} % Auto scale tables to \textwidth 56 | % \usepackage{geometry} % Sets more "reasonable" margin-sizes 57 | % \usepackage{xeCJK} % For typesetting CJK characters 58 | % \usepackage[l2tabu, orthodox]{nag} % Verbose warnings for typesetting 59 | 60 | % % Custom geometry for larger margin notes with assymetric body layout 61 | % \newgeometry{ 62 | % % Preserve the LaTeX default \textwidth and \textheight 63 | % textwidth =\textwidth, 64 | % textheight=\textheight, 65 | % % Include the margin notes space when doing body calculations 66 | % includemp=true, 67 | % % Increase margin notes width and seperation 68 | % marginparwidth=4cm, 69 | % marginparsep=0.5cm, 70 | % % Center doucment body vertically and horizontally 71 | % hcentering=true, 72 | % vcentering=true, 73 | % % Minor tweaks to header and footer seperation 74 | % headsep =0.5cm, 75 | % footskip =1cm, 76 | % } 77 | % 78 | % % Make sure that the header and footer overhang into the marginnotes area 79 | % % We must call this everytime we update the page geometry, otherwise the 80 | % % values WILL be stale! 81 | % \setlength{\headwidth}{\textwidth} 82 | % \addtolength{\headwidth}{\marginparsep} 83 | % \addtolength{\headwidth}{\marginparwidth} 84 | 85 | % The biblatex package should go last! 86 | % \usepackage[style=ieee]{biblatex} 87 | % \addbibresource{citations.bib} 88 | 89 | % Any additional user configuration goes below 90 | -------------------------------------------------------------------------------- /latex/humanize.cls: -------------------------------------------------------------------------------- 1 | % Humanize: An Opinionated LaTeX Template for the Humanities 2 | \NeedsTeXFormat{LaTeX2e}[2021/11/15] 3 | \ProvidesClass{humanize}[2021/11/15 v1.00 Humanize Custom LaTeX Report Class] 4 | 5 | % Options made available used by \RequirePackage{setspace} 6 | \DeclareOption{singlespacing}{% 7 | \AtEndOfClass{\singlespacing} 8 | \ClassInfo{humanize}{Line spacing set to 1.0} 9 | } 10 | \DeclareOption{onehalfspacing}{% 11 | \AtEndOfClass{\onehalfspacing} 12 | \ClassInfo{humanize}{Line spacing set to 1.5} 13 | } 14 | \DeclareOption{doublespacing}{% 15 | \AtEndOfClass{\doublespacing} 16 | \ClassInfo{humanize}{Line spacing set to 2.0} 17 | } 18 | 19 | % Options for left-margin protruded number labels 20 | \DeclareOption{protrudelabels}{% 21 | \AtEndOfClass{ 22 | % First, we implement protrusion for numerical section and subsection labels 23 | \newcommand{\marginsecnumber}[1]{% 24 | \makebox[0pt][r]{#1\hspace{6pt}}% 25 | } 26 | \titleformat{\section} 27 | {\normalfont\Large\bfseries} 28 | {\marginsecnumber\thesection} 29 | {0pt} 30 | {} 31 | \titleformat{\subsection} 32 | {\normalfont\large\bfseries} 33 | {\marginsecnumber\thesubsection} 34 | {0pt} 35 | {} 36 | \titleformat{\subsubsection} 37 | {\normalfont\normalsize\bfseries} 38 | {\marginsecnumber\thesubsubsection} 39 | {0pt} 40 | {} 41 | \titleformat{\paragraph}[runin] 42 | {\normalfont\normalsize\bfseries} 43 | {\marginsecnumber\theparagraph} 44 | {0pt} 45 | {} 46 | \titleformat{\subparagraph}[runin] 47 | {\normalfont\normalsize\bfseries} 48 | {\marginsecnumber\thesubparagraph} 49 | {0pt} 50 | {} 51 | } 52 | \AtBeginDocument{ 53 | % Check first if biblatex is loaded with ieee-style citations 54 | \IfPackageLoadedWithOptionsTF{biblatex}{style=ieee}{% 55 | % If so, we define a new ieee bib environment style w/ protrusion 56 | \defbibenvironment{ieee-protrusion} 57 | {\list 58 | {\printtext[labelnumberwidth]{% 59 | \printfield{labelprefix}% 60 | \printfield{labelnumber}}} 61 | {\setlength{\labelwidth}{\labelnumberwidth}% 62 | % Where we set the \leftmargin length to minus \labelsep 63 | \setlength{\leftmargin}{-\labelsep}% 64 | \setlength{\labelsep}{\biblabelsep}% 65 | % And then add an additional 0.5em for alignment 66 | \addtolength{\leftmargin}{0.5em}% 67 | \setlength{\itemsep}{\bibitemsep}% 68 | \setlength{\parsep}{\bibparsep}}% 69 | \renewcommand*{\makelabel}[1]{\hss##1}} 70 | {\endlist} 71 | {\item} 72 | % Now we declare the default \printbibliography env to be ours 73 | \DeclarePrintbibliographyDefaults{ 74 | env=ieee-protrusion, 75 | } 76 | }{} 77 | } 78 | \ClassInfo{humanize}{Label protrusions enabled} 79 | } 80 | 81 | % Next, we declare options for hanging punctuation. 82 | \DeclareOption{hangingpunct}{% 83 | \AtEndOfClass{ 84 | % This is done by passing a custom config file to microtype 85 | \LoadMicrotypeFile{protrusion} 86 | \ClassInfo{humanize}{Hanging punctuation enabled} 87 | } 88 | } 89 | \DeclareOption{nohangingpunct}{% 90 | \ClassInfo{humanize}{Hanging punctuation disabled} 91 | } 92 | 93 | % Options for additional decorative ligatures in libertinus-otf 94 | \DeclareOption{extraligatures}{% 95 | \AtEndOfClass{ 96 | \defaultfontfeatures+{ 97 | % Options are: Common, Contextual, Rare, Historic, TeX 98 | Ligatures={Common, Discretionary, Historic} 99 | } 100 | } 101 | \ClassInfo{humanize}{Historical ligatures enabled} 102 | } 103 | 104 | % Option to enable/disable the geometry package's narrower margins 105 | \DeclareOption{widemargins}{% 106 | \AtEndOfClass{ 107 | \geometry{pass} 108 | } 109 | \ClassInfo{humanize}{Enabling geometry package's larger margins} 110 | } 111 | 112 | % Pass any other undeclared options to base article documentclass 113 | \DeclareOption*{ 114 | \PassOptionsToClass{\CurrentOption}{report} 115 | } 116 | 117 | \AtBeginDocument{% 118 | % Check if biblatex is loaded. 119 | \IfPackageLoadedTF{biblatex}{ 120 | % If so select \autocite from hyperref as cite command 121 | \SetCiteCommand{\autocite} 122 | }{} 123 | % Check if pgfplots package is loaded. 124 | \IfPackageLoadedTF{pgfplots}{ 125 | % If so, disable legacy compatibility options and increase sample size 126 | \pgfplotsset{compat=1.18} 127 | \pgfplotsset{samples=300} 128 | }{} 129 | } 130 | 131 | % We first execute our default options. These can be overwritten by the user. 132 | \ExecuteOptions{ 133 | 10pt, % 10pt, 11pt, 12pt 134 | a4paper, % a4paper, letterpaper, a5paper, b5paper, executivepaper, legalpaper 135 | final, % draft 136 | onecolumn, % twocolumn 137 | oneside, % twoside 138 | notitlepage,% titlepage 139 | onehalfspacing, 140 | hangingpunct 141 | } 142 | 143 | % Now we process options belonging to the user 144 | \ProcessOptions\relax 145 | 146 | % First we load our base report class, as humanize is based upon report 147 | \LoadClass{report} 148 | 149 | % General packages in use 150 | \RequirePackage{fontspec} % LuaLaTeX font support 151 | \RequirePackage{babel} % Multiple languages and metadata support 152 | \RequirePackage{libertinus-otf} % Beautiful libertinus font 153 | \RequirePackage{microtype} % Microtypography adjustments 154 | \RequirePackage{geometry} % Adjusts for narrower page margins 155 | \RequirePackage[autopunct]{csquotes} % For more advanced quotations 156 | \RequirePackage{setspace} % Used to change line and paragraph spacing 157 | \RequirePackage[indent=3em, skip]{parskip}% For empty lines between paragraphs 158 | \RequirePackage[compact]{titlesec} % Sets section titles to be more compact 159 | \RequirePackage{titling} % In order to make the title higher on page 160 | \RequirePackage{enumitem} % Customize itemize and enumerate environments 161 | 162 | 163 | % Finally, we begin some misc. configuration 164 | 165 | % Use fontspec to enable font features 166 | \defaultfontfeatures+{ 167 | Script=Latin, 168 | Language=Default, 169 | % Swash, Alternate, WordInitial, WordFinal, LineFinal, Inner 170 | Ligatures={Common, Discretionary}, 171 | Contextuals={Alternate}, 172 | Letters = Uppercase, 173 | RawFeature=+ccmp, 174 | Kerning = {On, Uppercase}, 175 | Diacritics = {MarkToBase}, 176 | UprightFeatures = { 177 | StylisticSet={2, 5, 6} 178 | } 179 | } 180 | 181 | \setmainfont{LibertinusSerif} 182 | 183 | % Settings used by \usepackage{titling} 184 | % The following command is used to "hang" the default LaTeX title from the top 185 | % of the page (e.g. like a painting frame). The default LaTeX title sits a bit 186 | % too low, so the following command sets it higher. 187 | \setlength{\droptitle}{-2em} 188 | 189 | % Settings for csquotes 190 | \MakeOuterQuote{"} 191 | 192 | % Set indentation for quotes to be at the same level as that of \parindent 193 | \renewenvironment{quote}{% 194 | \small\list{}{\rightmargin=\parindent \leftmargin=\parindent}% 195 | \item\relax 196 | }{% 197 | \endlist 198 | } 199 | 200 | % Likewise, set the indentation for itemize and enumerate to be at the same level as that of \parindent 201 | \setlist[itemize,enumerate,description]{ 202 | leftmargin=\dimexpr\parindent-\itemindent\relax, 203 | noitemsep % Reduces intra-item spacing in these environments 204 | } 205 | 206 | % Some Final Late-Loading packages 207 | \RequirePackage[a-3u, mathxmp]{pdfx} 208 | 209 | % Settings used by \usepackage{hyperref} 210 | \hypersetup{ 211 | colorlinks=true, 212 | allcolors=blue, 213 | bookmarksopen=true 214 | } 215 | \urlstyle{sf} -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | - d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | - b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | --------------------------------------------------------------------------------