Skip to content

Commit a13000e

Browse files
TheCedarPrinceTheCedarPrince
committed
Proceedings template files
1 parent 4c0822c commit a13000e

18 files changed

+3266
-0
lines changed

‎License.txt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 George Kour
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.

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
2+
## Description:
3+
4+
The project hosts an aesthetic and simple LaTeX style suitable for "preprint" publications such as arXiv, techrXhiv and biorXiv, etc.
5+
It is based on the [**nips_2018.sty**](https://media.nips.cc/Conferences/NIPS2018/Styles/nips_2018.sty) style.
6+
7+
This styling maintains the esthetic of NeurIPS but adding and changing features to make it (IMO) even better and more suitable for preprints.
8+
The result looks fairly different from NeurIPS style so that readers won't get confused to think that the preprint was published in NeurIPS.
9+
10+
### Why NeurIPS?
11+
Because the NeurIPS styling is a comfortable single column format that is very esthetic and convenient for reading.
12+
13+
## Usage:
14+
1. Use Document class **article**.
15+
2. Copy **arxiv.sty** to the folder containing your tex file.
16+
3. add `\usepackage{arxiv}` after `\documentclass{article}`.
17+
4. The only packages used in the style file are **geometry** and **fancyheader**. Do not reimport them.
18+
19+
See **template.tex**
20+
21+
## Project files:
22+
1. **arxiv.sty** - the style file.
23+
2. **template.tex** - a sample template that uses the **arxiv style**.
24+
3. **references.bib** - the bibliography source file for template.tex.
25+
4. **template.pdf** - a sample output of the template file that demonstrated the design provided by the arxiv style.
26+
27+
28+
## Handling References when submitting to arXiv.org
29+
The most convenient way to manage references is using an external BibTeX file and pointing to it from the main file.
30+
However, this requires running the [bibtex](http://www.bibtex.org/) tool to "compile" the `.bib` file and create `.bbl` file containing "bibitems" that can be directly inserted in the main tex file.
31+
However, unfortunately the arXiv Tex environment ([Tex Live](https://www.tug.org/texlive/)) do not do that.
32+
So easiest way when submitting to arXiv is to create a single self-contained .tex file that contains the references.
33+
This can be done by running the BibTeX command on your machine and insert the content of the generated `.bbl` file into the `.tex` file and commenting out the `\bibliography{references}` that point to the external references file.
34+
35+
Below are the commands that should be run in the project folder:
36+
1. Run `$ latex template`
37+
2. Run `$ bibtex template`
38+
3. A `template.bbl` file will be generated (make sure it is there)
39+
4. Copy the `template.bbl` file content to `template.tex` into the `\begin{thebibliography}` command.
40+
5. Comment out the `\bibliography{references}` command in `template.tex`.
41+
6. You ready to submit to arXiv.org.
42+
43+
44+
## General Notes:
45+
1. For help, comments, praises, bug reporting or change requests, you can contact the author at: kourgeorge/at/gmail.com.
46+
2. You can use, redistribute and do whatever with this project, however, the author takes no responsibility on whatever usage of this project.
47+
3. If you start another project based on this project, it would be nice to mention/link to this project.
48+
4. You are very welcome to contribute to this project.
49+
5. A good looking 2 column template can be found in https://github.com/brenhinkeller/preprint-template.tex.

‎arxiv.sty‎

Lines changed: 262 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
\NeedsTeXFormat{LaTeX2e}
2+
3+
\ProcessOptions\relax
4+
5+
% fonts
6+
\renewcommand{\rmdefault}{ptm}
7+
\renewcommand{\sfdefault}{phv}
8+
9+
% set page geometry
10+
\usepackage[verbose=true,letterpaper]{geometry}
11+
\AtBeginDocument{
12+
\newgeometry{
13+
textheight=9in,
14+
textwidth=6.5in,
15+
top=1in,
16+
headheight=14pt,
17+
headsep=25pt,
18+
footskip=30pt
19+
}
20+
}
21+
22+
\widowpenalty=10000
23+
\clubpenalty=10000
24+
\flushbottom
25+
\sloppy
26+
27+
28+
29+
\newcommand{\headeright}{A Preprint}
30+
\newcommand{\undertitle}{A Preprint}
31+
\newcommand{\shorttitle}{\@title}
32+
33+
\usepackage{fancyhdr}
34+
\fancyhf{}
35+
\pagestyle{fancy}
36+
\renewcommand{\headrulewidth}{0.4pt}
37+
\fancyheadoffset{0pt}
38+
\rhead{\scshape \footnotesize \headeright}
39+
\chead{\shorttitle}
40+
\cfoot{\thepage}
41+
42+
43+
%Handling Keywords
44+
\def\keywordname{{\bfseries \emph{Keywords}}}%
45+
\def\keywords#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm
46+
\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$
47+
}\noindent\keywordname\enspace\ignorespaces#1\par}}
48+
49+
% font sizes with reduced leading
50+
\renewcommand{\normalsize}{%
51+
\@setfontsize\normalsize\@xpt\@xipt
52+
\abovedisplayskip 7\p@ \@plus 2\p@ \@minus 5\p@
53+
\abovedisplayshortskip \z@ \@plus 3\p@
54+
\belowdisplayskip \abovedisplayskip
55+
\belowdisplayshortskip 4\p@ \@plus 3\p@ \@minus 3\p@
56+
}
57+
\normalsize
58+
\renewcommand{\small}{%
59+
\@setfontsize\small\@ixpt\@xpt
60+
\abovedisplayskip 6\p@ \@plus 1.5\p@ \@minus 4\p@
61+
\abovedisplayshortskip \z@ \@plus 2\p@
62+
\belowdisplayskip \abovedisplayskip
63+
\belowdisplayshortskip 3\p@ \@plus 2\p@ \@minus 2\p@
64+
}
65+
\renewcommand{\footnotesize}{\@setfontsize\footnotesize\@ixpt\@xpt}
66+
\renewcommand{\scriptsize}{\@setfontsize\scriptsize\@viipt\@viiipt}
67+
\renewcommand{\tiny}{\@setfontsize\tiny\@vipt\@viipt}
68+
\renewcommand{\large}{\@setfontsize\large\@xiipt{14}}
69+
\renewcommand{\Large}{\@setfontsize\Large\@xivpt{16}}
70+
\renewcommand{\LARGE}{\@setfontsize\LARGE\@xviipt{20}}
71+
\renewcommand{\huge}{\@setfontsize\huge\@xxpt{23}}
72+
\renewcommand{\Huge}{\@setfontsize\Huge\@xxvpt{28}}
73+
74+
% sections with less space
75+
\providecommand{\section}{}
76+
\renewcommand{\section}{%
77+
\@startsection{section}{1}{\z@}%
78+
{-2.0ex \@plus -0.5ex \@minus -0.2ex}%
79+
{ 1.5ex \@plus 0.3ex \@minus 0.2ex}%
80+
{\large\bf\raggedright}%
81+
}
82+
\providecommand{\subsection}{}
83+
\renewcommand{\subsection}{%
84+
\@startsection{subsection}{2}{\z@}%
85+
{-1.8ex \@plus -0.5ex \@minus -0.2ex}%
86+
{ 0.8ex \@plus 0.2ex}%
87+
{\normalsize\bf\raggedright}%
88+
}
89+
\providecommand{\subsubsection}{}
90+
\renewcommand{\subsubsection}{%
91+
\@startsection{subsubsection}{3}{\z@}%
92+
{-1.5ex \@plus -0.5ex \@minus -0.2ex}%
93+
{ 0.5ex \@plus 0.2ex}%
94+
{\normalsize\bf\raggedright}%
95+
}
96+
\providecommand{\paragraph}{}
97+
\renewcommand{\paragraph}{%
98+
\@startsection{paragraph}{4}{\z@}%
99+
{1.5ex \@plus 0.5ex \@minus 0.2ex}%
100+
{-1em}%
101+
{\normalsize\bf}%
102+
}
103+
\providecommand{\subparagraph}{}
104+
\renewcommand{\subparagraph}{%
105+
\@startsection{subparagraph}{5}{\z@}%
106+
{1.5ex \@plus 0.5ex \@minus 0.2ex}%
107+
{-1em}%
108+
{\normalsize\bf}%
109+
}
110+
\providecommand{\subsubsubsection}{}
111+
\renewcommand{\subsubsubsection}{%
112+
\vskip5pt{\noindent\normalsize\rm\raggedright}%
113+
}
114+
115+
% float placement
116+
\renewcommand{\topfraction }{0.85}
117+
\renewcommand{\bottomfraction }{0.4}
118+
\renewcommand{\textfraction }{0.1}
119+
\renewcommand{\floatpagefraction}{0.7}
120+
121+
\newlength{\@abovecaptionskip}\setlength{\@abovecaptionskip}{7\p@}
122+
\newlength{\@belowcaptionskip}\setlength{\@belowcaptionskip}{\z@}
123+
124+
\setlength{\abovecaptionskip}{\@abovecaptionskip}
125+
\setlength{\belowcaptionskip}{\@belowcaptionskip}
126+
127+
% swap above/belowcaptionskip lengths for tables
128+
\renewenvironment{table}
129+
{\setlength{\abovecaptionskip}{\@belowcaptionskip}%
130+
\setlength{\belowcaptionskip}{\@abovecaptionskip}%
131+
\@float{table}}
132+
{\end@float}
133+
134+
% footnote formatting
135+
\setlength{\footnotesep }{6.65\p@}
136+
\setlength{\skip\footins}{9\p@ \@plus 4\p@ \@minus 2\p@}
137+
\renewcommand{\footnoterule}{\kern-3\p@ \hrule width 12pc \kern 2.6\p@}
138+
\setcounter{footnote}{0}
139+
140+
% paragraph formatting
141+
\setlength{\parindent}{\z@}
142+
\setlength{\parskip }{5.5\p@}
143+
144+
% list formatting
145+
\setlength{\topsep }{4\p@ \@plus 1\p@ \@minus 2\p@}
146+
\setlength{\partopsep }{1\p@ \@plus 0.5\p@ \@minus 0.5\p@}
147+
\setlength{\itemsep }{2\p@ \@plus 1\p@ \@minus 0.5\p@}
148+
\setlength{\parsep }{2\p@ \@plus 1\p@ \@minus 0.5\p@}
149+
\setlength{\leftmargin }{3pc}
150+
\setlength{\leftmargini }{\leftmargin}
151+
\setlength{\leftmarginii }{2em}
152+
\setlength{\leftmarginiii}{1.5em}
153+
\setlength{\leftmarginiv }{1.0em}
154+
\setlength{\leftmarginv }{0.5em}
155+
\def\@listi {\leftmargin\leftmargini}
156+
\def\@listii {\leftmargin\leftmarginii
157+
\labelwidth\leftmarginii
158+
\advance\labelwidth-\labelsep
159+
\topsep 2\p@ \@plus 1\p@ \@minus 0.5\p@
160+
\parsep 1\p@ \@plus 0.5\p@ \@minus 0.5\p@
161+
\itemsep \parsep}
162+
\def\@listiii{\leftmargin\leftmarginiii
163+
\labelwidth\leftmarginiii
164+
\advance\labelwidth-\labelsep
165+
\topsep 1\p@ \@plus 0.5\p@ \@minus 0.5\p@
166+
\parsep \z@
167+
\partopsep 0.5\p@ \@plus 0\p@ \@minus 0.5\p@
168+
\itemsep \topsep}
169+
\def\@listiv {\leftmargin\leftmarginiv
170+
\labelwidth\leftmarginiv
171+
\advance\labelwidth-\labelsep}
172+
\def\@listv {\leftmargin\leftmarginv
173+
\labelwidth\leftmarginv
174+
\advance\labelwidth-\labelsep}
175+
\def\@listvi {\leftmargin\leftmarginvi
176+
\labelwidth\leftmarginvi
177+
\advance\labelwidth-\labelsep}
178+
179+
% create title
180+
\providecommand{\maketitle}{}
181+
\renewcommand{\maketitle}{%
182+
\par
183+
\begingroup
184+
\renewcommand{\thefootnote}{\fnsymbol{footnote}}
185+
% for perfect author name centering
186+
%\renewcommand{\@makefnmark}{\hbox to \z@{$^{\@thefnmark}$\hss}}
187+
% The footnote-mark was overlapping the footnote-text,
188+
% added the following to fix this problem (MK)
189+
\long\def\@makefntext##1{%
190+
\parindent 1em\noindent
191+
\hbox to 1.8em{\hss $\m@th ^{\@thefnmark}$}##1
192+
}
193+
\thispagestyle{empty}
194+
\@maketitle
195+
\@thanks
196+
%\@notice
197+
\endgroup
198+
\let\maketitle\relax
199+
\let\thanks\relax
200+
}
201+
202+
% rules for title box at top of first page
203+
\newcommand{\@toptitlebar}{
204+
\hrule height 2\p@
205+
\vskip 0.25in
206+
\vskip -\parskip%
207+
}
208+
\newcommand{\@bottomtitlebar}{
209+
\vskip 0.29in
210+
\vskip -\parskip
211+
\hrule height 2\p@
212+
\vskip 0.09in%
213+
}
214+
215+
% create title (includes both anonymized and non-anonymized versions)
216+
\providecommand{\@maketitle}{}
217+
\renewcommand{\@maketitle}{%
218+
\vbox{%
219+
\hsize\textwidth
220+
\linewidth\hsize
221+
\vskip 0.1in
222+
\@toptitlebar
223+
\centering
224+
{\LARGE\sc \@title\par}
225+
\@bottomtitlebar
226+
\textsc{\undertitle}\\
227+
\vskip 0.1in
228+
\def\And{%
229+
\end{tabular}\hfil\linebreak[0]\hfil%
230+
\begin{tabular}[t]{c}\bf\rule{\z@}{24\p@}\ignorespaces%
231+
}
232+
\def\AND{%
233+
\end{tabular}\hfil\linebreak[4]\hfil%
234+
\begin{tabular}[t]{c}\bf\rule{\z@}{24\p@}\ignorespaces%
235+
}
236+
\begin{tabular}[t]{c}\bf\rule{\z@}{24\p@}\@author\end{tabular}%
237+
\vskip 0.4in \@minus 0.1in \center{\@date} \vskip 0.2in
238+
}
239+
}
240+
241+
% add conference notice to bottom of first page
242+
\newcommand{\ftype@noticebox}{8}
243+
\newcommand{\@notice}{%
244+
% give a bit of extra room back to authors on first page
245+
\enlargethispage{2\baselineskip}%
246+
\@float{noticebox}[b]%
247+
\footnotesize\@noticestring%
248+
\end@float%
249+
}
250+
251+
% abstract styling
252+
\renewenvironment{abstract}
253+
{
254+
\centerline
255+
{\large \bfseries \scshape Abstract}
256+
\begin{quote}
257+
}
258+
{
259+
\end{quote}
260+
}
261+
262+
\endinput

‎bib.tex‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
% **************GENERATED FILE, DO NOT EDIT**************
2+
3+
\bibliographystyle{juliacon}
4+
\bibliography{ref.bib}

‎header.tex‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
% **************GENERATED FILE, DO NOT EDIT**************
2+
3+
\title{My JuliaCon proceeding}
4+
5+
\author[1]{1st author}
6+
\author[1, 2]{2nd author}
7+
\author[2]{3rd author}
8+
\affil[1]{University}
9+
\affil[2]{National Lab}
10+
11+
\keywords{Julia, Optimization, Game theory, Compiler}
12+
13+
\hypersetup{
14+
pdftitle = {My JuliaCon proceeding},
15+
pdfsubject = {JuliaCon 2022 Proceedings},
16+
pdfauthor = {1st author, 2nd author, 3rd author},
17+
pdfkeywords = {Julia, Optimization, Game theory, Compiler},
18+
}
19+

0 commit comments

Comments
 (0)