Skip to content

Commit 8c1f044

Browse files
authored
Initial commit
0 parents  commit 8c1f044

15 files changed

+5162
-0
lines changed

Diff for: LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022–2024 Pascal Michaillat
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: README.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Minimalist LaTeX Template for Academic Papers
2+
3+
This repository contains a [LaTeX](https://github.com/latex3/latex2e) template to create an academic paper. The template carefully follows typographical best practices and has a minimalist design. The template is particularly well suited for research papers. It is designed so papers are comfortable to read and easy to scan, both in print and on screen.
4+
5+
## Documentation
6+
7+
The template is documented at https://pascalmichaillat.org/d2/.
8+
9+
## Illustration
10+
11+
+ The paper produced by the template can be viewed at https://pascalmichaillat.org/d2.pdf.
12+
+ The online appendix produced by the template can be viewed at https://pascalmichaillat.org/d2a.pdf.
13+
14+
## Usage
15+
16+
+ Clone the repository to your local machine.
17+
+ Start editing the LaTeX file `paper.tex` to replace the boilerplate content with the content of your paper.
18+
+ Replace the figures in the PDF file `figures.pdf` with the figures that will be included in the paper. There should be one figure per page.
19+
+ Replace the references in the BibTeX file `bibliography.bib` with the references that will be included in the paper.
20+
+ Compile `paper.tex` with pdfTeX. This will generate a PDF file of your paper named `paper.pdf`.
21+
+ The LaTeX style file `paper.sty` collects all the commands to format the paper. The file must be included in the same folder as `paper.tex`. It can be modified to alter the paper's format.
22+
+ The BibTeX style file `bibliography.bst` collects all the commands to format the bibliography. It must be included in the same folder as `paper.tex`. It can be modified to alter the bibliography's format. This style file is based on `econ.bst`, which was created by Shiro Takeda and is [available on GitHub](https://github.com/ShiroTakeda/econ-bst).
23+
+ The file `paper.pdf` is not required to use the template. It only illustrate the output of the template. It will be overridden once `paper.tex` is compiled.
24+
25+
## Online appendix
26+
27+
The repository also includes files to produce an online appendix—in case the paper's appendix must be carved out into a separate, online appendix upon publication. An online appendix can be produced as follows:
28+
29+
+ Start editing the LaTeX file `appendix.tex` to replace the boilerplate content with the content of your online appendix.
30+
+ The equation and section labels from `paper.tex` can be used in `appendix.tex`. [This requires the following](https://www.ctan.org/pkg/xr):
31+
+ The file `appendix.tex` is in the same folder as `paper.tex`.
32+
+ The file `paper.tex` is compiled first.
33+
+ The auxiliary file `paper.aux` is available when `appendix.tex` is compiled.
34+
+ Compile `appendix.tex` with pdfTeX. This will generate a PDF file of your appendix named `appendix.pdf`.
35+
+ The LaTeX style file `appendix.sty` collects additional commands to format the online appendix. It must be included in the same folder as `appendix.tex`. It can be modified to alter the format of the online appendix. It works in conjunction with `paper.sty`, which must be included in the same folder.
36+
+ The file `appendix.pdf` is not required to use the template. It only illustrate the output of the template, and will be overridden once `appendix.tex` is compiled.
37+
38+
## Submission to arXiv
39+
40+
The template is perfectly compatible with [arXiv](https://arxiv.org/). A paper based on the template can be submitted to arXiv in just three steps once it has been compiled with pdfTeX:
41+
42+
1. Adjust the preamble of the source file `paper.tex`: on line 3, replace `\bibliographystyle{bibliography}` by `\pdfoutput=1`. The `\bibliographystyle{bibliography}` command is not needed because arXiv produces the bibliography directly from the `paper.bbl` file. The `\pdfoutput=1` is required because the paper is compiled with pdfTeX.
43+
2. Collect the required files into a folder. There should be four files: the source file `paper.tex`, the bibliography file `paper.bbl`, the style file `paper.sty`, and the figure file `figures.pdf`.
44+
3. Zip the folder and upload the zipped file to arXiv.
45+
46+
The `arXiv` folder illustrates how the template should be prepared for submission to arXiv. The folder contains the four required files: `paper.tex`, `paper.bbl`, `paper.sty`, and `figures.pdf`. Furthermore, the preamble of `paper.tex` is adjusted appropriately. After being zipped, the folder could be uploaded to arXiv and would compile properly.
47+
48+
## Software
49+
50+
The template was developed, tested, and validated on a Mac with the MacTeX-2023 distribution.
51+
52+
While the template should also work on other operating systems and with other LaTeX distributions, compatibility cannot be guaranteed. Users on Windows or Linux systems, or those using different LaTeX distributions, may need to make minor adjustments. [Please report](https://github.com/pmichaillat/latex-paper/issues) any compatibility issues or bugs to help improve cross-platform support.
53+
54+
## License
55+
56+
The content of this repository is licensed under the terms of the MIT License.
57+
58+
## Real-world implementations
59+
60+
+ [Has the Recession Started?](https://arxiv.org/pdf/2408.05856v2.pdf) ([source code](https://arxiv.org/src/2408.05856))
61+
+ [Beveridgean Phillips Curve](https://arxiv.org/pdf/2401.12475v2.pdf) ([source code](https://arxiv.org/src/2401.12475v2))
62+
+ [Modeling Migration-Induced Unemployment](https://arxiv.org/pdf/2303.13319v4.pdf) ([source code](https://arxiv.org/src/2303.13319v4))
63+
+ [Critical Values Robust to P-hacking](https://arxiv.org/pdf/2005.04141v7.pdf) ([source code](https://arxiv.org/src/2005.04141v7))
64+
65+
## Related resources
66+
67+
+ [LaTeX template for academic presentations](https://github.com/pmichaillat/latex-presentation) – This template produces academic presentations following the same principles, and with a similar appearance, as this paper template.
68+
+ [LaTeX commands to write math](https://github.com/pmichaillat/latex-math) – These commands make it easy to write mathematical expressions. They can be used in combination with this paper template.

Diff for: appendix.pdf

315 KB
Binary file not shown.

Diff for: appendix.sty

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
% ---- Format table of contents ----
2+
3+
% Customize table of contents
4+
\usepackage[subfigure]{tocloft}
5+
6+
% Eliminate "Table of Contents"
7+
\renewcommand{\contentsname}{}
8+
9+
% Set font size for content
10+
\renewcommand{\cftsecfont}{\normalfont}
11+
12+
% Set font size for page numbers
13+
\renewcommand{\cftsecpagefont}{\normalfont}
14+
15+
% Set separator after labels
16+
\renewcommand{\cftsecaftersnum}{.}
17+
\renewcommand{\cftsubsecaftersnum}{.}
18+
19+
% Set spacing between dots
20+
\renewcommand{\cftdotsep}{10}
21+
22+
% Set spacing between sections
23+
\setlength{\cftbeforesecskip}{0em}
24+
25+
% ---- Format sections ----
26+
27+
% Format section headings
28+
\titleformat{\section}{\centering\large\bfseries}{Appendix~\thesection.}{1em}{}
29+
30+
% Format section labels
31+
\renewcommand{\thesection}{\Alph{section}}
32+
33+
% Insert page break after each section
34+
\newcommand{\sectionbreak}{\clearpage}
35+
36+
% ---- Format labels ----
37+
38+
% Add "A" in front of labels
39+
\renewcommand{\thetheorem}{A\arabic{theorem}}
40+
\renewcommand{\theproposition}{A\arabic{proposition}}
41+
\renewcommand{\thelemma}{A\arabic{lemma}}
42+
\renewcommand{\thecorollary}{A\arabic{corollary}}
43+
\renewcommand{\thedefinition}{A\arabic{definition}}
44+
\renewcommand{\theassumption}{A\arabic{assumption}}
45+
\renewcommand{\theremark}{A\arabic{remark}}
46+
\renewcommand{\thetable}{A\arabic{table}}
47+
\renewcommand{\thefigure}{A\arabic{figure}}
48+
\renewcommand{\theequation}{A\arabic{equation}}
49+
50+
% ---- Enable crossreferences ----
51+
52+
\usepackage{xr}

0 commit comments

Comments
 (0)