wip: simple template

7 files changed, 368 insertions, 0 deletions

diff --git a/docs/Simple/LICENSE b/docs/Simple/LICENSE
new file mode 100644
index 0000000..9f5c70f
--- /dev/null
+++ b/docs/Simple/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ruoho Ruotsi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docs/Simple/Makefile b/docs/Simple/Makefile
new file mode 100644
index 0000000..e55adc9
--- /dev/null
+++ b/docs/Simple/Makefile
@@ -0,0 +1,15 @@
+main.pdf: main.tex
+	pdflatex main.tex
+	bibtex main
+	pdflatex main.tex
+
+
+.PHONY: clean
+clean:
+	rm -f main.pdf
+	rm -f main.aux
+	rm -f main.log
+	rm -f main.bbl
+	rm -f main.blg
+	rm -f main.out
+
diff --git a/docs/Simple/README.md b/docs/Simple/README.md
new file mode 100644
index 0000000..3a56517
--- /dev/null
+++ b/docs/Simple/README.md
@@ -0,0 +1,2 @@
+# latex-template-arxiv-preprint
+A simple LaTeX template for Technical Reports, arXiv preprints & 2-column Conference papers
diff --git a/docs/Simple/figure.pdf b/docs/Simple/figure.pdf
new file mode 100644
index 0000000..b21876a
--- /dev/null
+++ b/docs/Simple/figure.pdf
diff --git a/docs/Simple/main.tex b/docs/Simple/main.tex
new file mode 100644
index 0000000..7237262
--- /dev/null
+++ b/docs/Simple/main.tex
@@ -0,0 +1,185 @@
+\documentclass[10pt,twocolumn]{article} 
+\usepackage{simpleConference}
+\usepackage{times}
+\usepackage{graphicx}
+\usepackage{amssymb}
+\usepackage{url,hyperref}
+
+\begin{document}
+
+\title{\LaTeX\ Template for a Simple, Two-Column Paper}
+
+\author{Iroro Orife \\
+\\
+Technical Report \\
+Seattle, Washington, USA \\
+\today
+\\
+\\
+iroro@alumni.cmu.edu  \\
+}
+
+\maketitle
+\thispagestyle{empty}
+
+\begin{abstract}
+The material in this template is an edited \& \LaTeX\--ified version of the recommendations here: \url{http://cs.stanford.edu/people/widom/paper-writing.html} The objective would be to help us writers, stay on topic and focused for each section of a report.
+
+For the abstract state the problem, your approach and solution, and the main contributions of the paper. Include little if any background and motivation. Be factual but comprehensive. The material in the abstract should not be repeated later word for word in the paper. 
+\end{abstract}
+
+
+\section{Introduction}
+The Introduction is crucially important. By the time a referee has finished the Introduction, he's probably made an initial decision about whether to accept or reject the paper. He'll read the rest of the paper looking for evidence to support his decision. A casual reader will continue on if the Introduction captivated him, and will set the paper aside otherwise. 
+Here is the Stanford InfoLab's patented five-point structure for Introductions. Unless there's a good argument against it, the Introduction should consist of five paragraphs answering the following five questions:
+
+\begin{description}
+  \item[$\bullet$]  What is the problem?
+  \item[$\bullet$]  Why is it interesting and important?
+  \item[$\bullet$]  Why is it hard? Why do naive approaches fail?
+  \item[$\bullet$]  Why hasn't it been solved before? What's wrong with previous proposed solutions? How does mine differ?
+  \item[$\bullet$]  What are the key components of my approach and results? Also include any specific limitations.
+\end{description}
+  
+Then have a final paragraph or subsection: ``Summary of Contributions". It should list the major contributions in bullet form, mentioning in which sections they can be found. This material doubles as an outline of the rest of the paper, saving space and eliminating redundancy.
+
+\section{Related Work}
+
+The perennial question: Should related work be covered near the beginning of the paper or near the end?
+
+\begin{description}
+  \item[$\bullet$]  Beginning, if it can be short yet detailed enough, or if it's critical to take a strong defensive stance about previous work right away. In this case Related Work can be either a subsection at the end of the Introduction, or its own Section 2.
+  \item[$\bullet$]  End, if it can be summarized quickly early on (in the Introduction or Preliminaries), or if sufficient comparisons require the technical content of the paper. In this case Related Work should appear just before the Conclusions, possibly in a more general section ``Discussion and Related Work".
+\end{description}
+
+\section{The Body}
+
+\textbf{Guideline 1:} A clear new important technical contribution should have been articulated by the time the reader finishes page 3 i.e., a quarter of the way through the paper.
+
+\textbf{Guideline 2:} Every section of the paper should tell a story. Don't, however, fall into the common trap of telling the entire story of how you arrived at your results. Just tell the story of the results themselves. The story should be linear, keeping the reader engaged at every step and looking forward to the next step. There should be no significant interruptions -- those can go in the Appendix.
+\\
+\\
+Aside from these guidelines, which apply to every paper, the structure of the body varies a lot depending on content. Important components are:
+
+\begin{description}
+  \item[$\bullet$]  Running Example: When possible, use a running example throughout the paper. It can be introduced either as a subsection at the end of the Introduction, or its own Section 2 or 3 (depending on Related Work).
+  \item[$\bullet$]  Preliminaries: This section, which follows the Introduction and possibly Related Work and/or Running Example, sets up notation and terminology that is not part of the technical contribution. One important function of this section is to delineate material that's not original but is needed for the paper. Be concise -- remember Guideline 1.
+    \item[$\bullet$] Content: The meat of the paper includes algorithms, system descriptions, new language constructs, analyses, etc. Whenever possible use a ``top-down" description: readers should be able to see where the material is going, and they should be able to skip ahead and still get the idea.
+\end{description}
+
+
+\section{Performance Experiments}
+
+We could have an entire treatise on this topic alone and I am surely not the expert. Here are some random thoughts:
+
+\begin{description}
+  \item[$\bullet$]  Many conferences expect experiments.
+  \item[$\bullet$]  It's easy to do ``hokey" or meaningless experiments, and many papers do.
+  \item[$\bullet$]  It's easy to craft experiments to show your work in its best light, and most papers do.
+    \item[$\bullet$]  What should performance experiments measure? Possibilities:  
+    \begin{description}
+  	  \item[$\bullet$] Pure running time
+      \item[$\bullet$] Sensitivity to important parameters
+      \item[$\bullet$] Scalability in various aspects: data size, problem complexity, ...
+  \end{description}
+    \item[$\bullet$]  What should performance experiments show? Possibilities:
+        \begin{description}
+  	  \item[$\bullet$] Absolute performance i.e., it's acceptable/usable
+      \item[$\bullet$] Relative performance to naive approaches
+      \item[$\bullet$] Relative performance to previous approaches
+      \item[$\bullet$] Relative performance among different proposed approaches
+  \end{description}
+  \item[$\bullet$] 
+\end{description}
+
+
+\section{The Conclusions}
+
+In general a short summarizing paragraph will do, and under no circumstances should the paragraph simply repeat material from the Abstract or Introduction. In some cases it's possible to now make the original claims more concrete, e.g., by referring to quantitative performance results.
+
+\section{Future Work}
+
+This material is important -- part of the value of a paper is showing how the work sets new research directions. I like bullet lists here. A couple of things to keep in mind:
+\begin{description}
+  \item[$\bullet$]  If you're actively engaged in follow-up work, say so. E.g.: ``We are currently extending the algorithm to... blah blah, and preliminary results are encouraging." This statement serves to mark your territory.
+\item[$\bullet$]  Conversely, be aware that some researchers look to Future Work sections for research topics. My opinion is that there's nothing wrong with that -- consider it a compliment.
+\end{description}
+
+\section{The Acknowledgements}
+
+Don't forget them or you'll have people with hurt feelings. Acknowledge anyone who contributed in any way: through discussions, feedback on drafts, implementation, etc. If in doubt about whether to include someone, include them.
+
+
+\section{Citations}
+
+Spend the effort to make all citations complete and consistent. Do not just copy random inconsistent BibTex (or other) entries from the web and call it a day. Check over your final bibliography carefully and make sure every entry looks right.
+
+\section{Appendix A}
+This is a simple sample of a document created using \LaTeX
+   (specifically pdflatex) that includes a figure from the Vergil visual editor for Ptolemy II
+   that was created by printing to the Acrobat Distiller to get a PDF file.
+   It also illustrates a simple two-column conference paper style,
+   and use of bibtex to handle bibligraphies.
+
+This is a sample document for use with pdflatex, which is
+a program that is included with the Miktex distribution
+that directly produces PDF files from \LaTeX sources.
+To run \LaTeX on this file, you need the following files:
+\begin{enumerate}
+\item templatePDF.tex (this file)
+\item figure.pdf (the figure file)
+\item simpleConference.sty (style file)
+\item refs.bib (bibiliography file)
+\end{enumerate}
+\noindent
+To create a PDF file, execute the following commands:
+\begin{enumerate}
+\item pdflatex mainTemplatePDF
+\item bibtex mainTemplatePDF
+\item pdflatex mainTemplatePDF
+\item pdflatex mainTemplatePDF
+\end{enumerate}
+\noindent
+Yes (strangely) it is necessary to run pdflatex three times.
+The result will be a PDF file (plus several other files that \LaTeX
+produces).  You will need a mechanism, of course, for executing
+commands on the command line. If you are using Windows, I recommend
+installing Cygwin and using its bash shell.
+
+\section{Appendix B: How to Include Vergil Diagrams as Figures}
+
+\begin{figure}[!b]
+  \begin{center}
+    \includegraphics[width=3.5in]{figure.pdf}
+  \end{center}
+
+  \caption{\small Figure caption. To get a figure to span two
+      columns, use the environment figure* rather than figure.}
+  \label{fig-label}
+\end{figure}
+
+
+Suppose you wish to include a figure, like that in figure \ref{fig-label}.
+The simplest mechanism is to install Adobe Acrobat, which includes
+a ``printer'' called ``Acrobat Distiller.'' Printing to this printer
+creates a PDF file, which can be included in a document as shown
+here.  To include Ptolemy II models \cite{PtolemyVol1:04},
+just print to the distiller from within Vergil and reference
+the PDF file in your \LaTeX document.
+
+There is a bit more work to do, however.
+The file that is produced by the distiller represents
+a complete page, not the individual figure.
+You can open it in using Acrobat (version 5.0 or later),
+and select Document $\rightarrow$ Crop Pages from the menu.
+In the resulting dialog, check ``Remove White Margins.''
+Save the modified PDF file in a file and then reference
+it in the \LaTeX file as shown in this example.
+
+An alternative is to generate EPS (encapsulated postscript),
+but the process is much more complex and fragile.
+I recommend using pdflatex and Adobe Acrobat.
+
+\bibliographystyle{abbrv}
+\bibliography{refs}
+\end{document}
diff --git a/docs/Simple/refs.bib b/docs/Simple/refs.bib
new file mode 100644
index 0000000..b2328b0
--- /dev/null
+++ b/docs/Simple/refs.bib
@@ -0,0 +1,9 @@
+@techreport{PtolemyVol1:04,
+   Author = {Brooks, C. and Lee, E. A. and Liu, X. and Neuendorffer, S. and Zhao, Y. and Zheng, H.},
+   Title = {Heterogeneous Concurrent Modeling and Design in Java},
+   Institution = {University of California},
+   Number = {Technical Memorandum UCB/ERL M04/27},
+   Month= {July 29},
+   URL ={http://ptolemy.eecs.berkeley.edu/publications/papers/04/ptIIDesignIntro/},
+   Year = {2004}
+}
\ No newline at end of file
diff --git a/docs/Simple/simpleConference.sty b/docs/Simple/simpleConference.sty
new file mode 100644
index 0000000..acdbd33
--- /dev/null
+++ b/docs/Simple/simpleConference.sty
@@ -0,0 +1,136 @@
+% --------------------------------------------------------------- 
+% Style file for simple, two column conference papers.
+% Based on latex8.sty by Paolo.Ienne@di.epfl.ch 
+% --------------------------------------------------------------- 
+% Use with LaTeX2e as:
+%   \documentclass[times,10pt,twocolumn]{article} 
+%   \usepackage{simpleConference}
+%   \usepackage{times}
+% --------------------------------------------------------------- 
+% specify references as
+%   \bibliographystyle{simpleConference}
+%   \bibliography{...your files...}
+%
+% use Section{} and SubSection{} instead of standard section{} 
+%    and subsection{} to obtain headings in the form 
+%    "1.3. My heading"
+% ---------------------------------------------------------------
+% ten point helvetica bold required for captions
+% in some sites the name of the helvetica bold font may differ, 
+% change the name here:
+\font\tenhv  = phvb at 10pt
+
+% eleven point times bold required for second-order headings 
+\font\elvbf  = ptmb scaled 1100
+
+% set dimensions of columns, gap between columns, and paragraph indent 
+\setlength{\textheight}{8.875in}
+\setlength{\textwidth}{6.875in}
+\setlength{\columnsep}{0.3125in}
+\setlength{\topmargin}{0in}
+\setlength{\headheight}{0in}
+\setlength{\headsep}{0in}
+\setlength{\parindent}{1pc}
+\setlength{\oddsidemargin}{-.304in}
+\setlength{\evensidemargin}{-.304in}
+
+% memento from size10.clo
+% \normalsize{\@setfontsize\normalsize\@xpt\@xiipt} 
+% \small{\@setfontsize\small\@ixpt{11}}
+% \footnotesize{\@setfontsize\footnotesize\@viiipt{9.5}} 
+% \scriptsize{\@setfontsize\scriptsize\@viipt\@viiipt}
+% \tiny{\@setfontsize\tiny\@vpt\@vipt}
+% \large{\@setfontsize\large\@xiipt{14}} 
+% \Large{\@setfontsize\Large\@xivpt{18}} 
+% \LARGE{\@setfontsize\LARGE\@xviipt{22}} 
+% \huge{\@setfontsize\huge\@xxpt{25}}
+% \Huge{\@setfontsize\Huge\@xxvpt{30}}
+
+\def\@maketitle
+   {
+   \newpage
+   \null
+   \vskip .375in 
+   \begin{center}
+      {\Large \bf \@title \par} 
+      % additional two empty lines at the end of the title 
+      \vspace*{24pt} 
+      {
+      \large 
+      \lineskip .5em
+      \begin{tabular}[t]{c}
+         \@author 
+      \end{tabular}
+      \par
+      } 
+      % additional small space at the end of the author name 
+      \vskip .5em 
+      {
+       \large 
+      \begin{tabular}[t]{c}
+         \@affiliation 
+      \end{tabular}
+      \par 
+      \ifx \@empty \@email
+      \else
+         \begin{tabular}{r@{~}l}
+            E-mail: & {\tt \@email}
+         \end{tabular}
+         \par
+      \fi
+      }
+      % additional empty line at the end of the title block 
+      \vspace*{12pt} 
+   \end{center}
+   } 
+
+\def\abstract
+   {%
+   \centerline{\large\bf Abstract}%
+   \vspace*{12pt}%
+%  \it%  %%%% iroro - commenting out italicized abstract
+   }
+
+\def\endabstract
+   {
+   % additional empty line at the end of the abstract 
+   \vspace*{12pt} 
+   }
+
+\def\affiliation#1{\gdef\@affiliation{#1}} \gdef\@affiliation{}
+
+\def\email#1{\gdef\@email{#1}}
+\gdef\@email{}
+
+\newlength{\@ctmp}
+\newlength{\@figindent}
+\setlength{\@figindent}{1pc}
+
+\long\def\@makecaption#1#2{
+   \vskip 10pt
+   \setbox\@tempboxa\hbox{\tenhv\noindent #1.~#2} 
+   \setlength{\@ctmp}{\hsize}
+   \addtolength{\@ctmp}{-\@figindent}\addtolength{\@ctmp}{-\@figindent} 
+   % IF longer than one indented paragraph line
+   \ifdim \wd\@tempboxa >\@ctmp
+      % THEN set as an indented paragraph
+      \begin{list}{}{\leftmargin\@figindent \rightmargin\leftmargin} 
+         \item[]\tenhv #1.~#2\par
+      \end{list}
+   \else
+      % ELSE center
+      \hbox to\hsize{\hfil\box\@tempboxa\hfil} 
+   \fi}
+
+% correct heading spacing and type
+\def\section{\@startsection {section}{1}{\z@}
+   {14pt plus 2pt minus 2pt}{14pt plus 2pt minus 2pt} {\large\bf}} 
+\def\subsection{\@startsection {subsection}{2}{\z@}
+   {13pt plus 2pt minus 2pt}{13pt plus 2pt minus 2pt} {\elvbf}}
+
+% add the period after section numbers 
+\newcommand{\Section}[1]{\section{\hskip -1em.~#1}} 
+\newcommand{\SubSection}[1]{\subsection{\hskip -1em.~#1}}
+
+% end of file latex8.sty
+% ---------------------------------------------------------------