summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex67
1 files changed, 33 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex
index 89723e9761b..9899040513a 100644
--- a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex
+++ b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex
@@ -1,10 +1,10 @@
%!TEX program = pdflatex
\documentclass[en]{elegantpaper}
-\title{ElegantPaper: An Elegant \LaTeX{} Template for Working Paper}
-\author{\href{https://ddswhu.me/}{Dongsheng Deng}}
-\institute{Elegant\LaTeX{} Program}
-\version{0.02}
+\title{ElegantPaper: An Elegant \LaTeX{} Template for Working Papers}
+\author{\href{https://ddswhu.me/}{Dongsheng Deng}\thanks{Thanks Peiyi Yao for good suggestions.}}
+\institute{\href{https://github.com/ElegantLaTeX}{Elegant\LaTeX{} Program}}
+\version{0.05}
\date{\today}
@@ -13,12 +13,14 @@
\maketitle
\begin{abstract}
- This paper illustrates the usage of the ElegantPaper template, which is designed for writing a working paper. This template is based on the standard \LaTeX{} article class. The goal of this template is to make the writing process easier and more comfortable. You can get rid of all the worries about the format. Just enjoy it, if you have any questions or suggestions, please contact me at: \email{ddswhu@outlook.com}. Looking for other templates designed by Elegant\LaTeX{} Group? Please visit: \href{https://ddswhu.me/resource/}{Elegant\LaTeX{} Resource}.
+\noindent This paper illustrates the usage of the \href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} template, which is designed for writing a working paper. This template is based on the standard \LaTeX{} article class. The goal of this template is to make the writing process easier and more comfortable. You can get rid of all the worries about the format. Just enjoy it! If you have any questions, suggestions or bug reports, you can visit \href{https://github.com/ElegantLaTeX/ElegantPaper/issues}{ElegantPaper/issues}. Looking for other templates designed by Elegant\LaTeX{} Group? Please visit: \href{https://github.com/ElegantLaTeX}{https://github.com/ElegantLaTeX}.\par
+\keywords{Elegant\LaTeX{}, Working Paper, Template}
\end{abstract}
+
\section{Introduction}
-This template is based on the standard \LaTeX{} article class, which means you can pass the arguments of article class to it (\lstinline{a4paper}, \lstinline{12pt} and etc.). It supports different engines, You can choose either \lstinline{pdflatex} or \lstinline{xelatex}.
+This template is based on the standard \LaTeX{} article class, which means you can pass the arguments of article class to it (\lstinline{a4paper}, \lstinline{12pt} and etc.). It supports different engines, You can choose either \lstinline{PDFLaTeX} or \lstinline{XeLaTeX}.
\subsection{Global Options}
I defined one option named \lstinline{lang}, this option has two alternative values, \lstinline{lang=en} (default) or \lstinline{lang=cn}. \lstinline{lang=cn} will make the caption of figure/table, abstract name, refname etc. Chinese, while \lstinline{lang=en} will keep all these stuff English, as the default article class sets. You can use this option as
@@ -29,36 +31,38 @@ I defined one option named \lstinline{lang}, this option has two alternative val
\end{lstlisting}
\subsection{Font Settings}
-\noindent\textbf{Using PDFLaTeX:} If you choose PDFLaTeX to process your paper, the default article font computer modern has changed to \lstinline{newtx} series, and the default font size is set to \lstinline{11pt}.
-
+\subsubsection[Compile with PDFLaTeX]{Compile with \lstinline{PDFLaTeX}}
+If you choose \lstinline{PDFLaTeX} to process your paper, the default article font computer modern has changed to \lstinline{newtx} series, and the default font size is set to \lstinline{11pt}. The fonts are settings with:
\begin{itemize}
\item \lstinline{newtxtext} package for text fonts, similar to times new roman font.
\item \lstinline{newtxmath} package for math fonts, close to \lstinline{times} package.
- \item \lstinline{newtxtt} package for typewriter fonts, with option \lstinline{scale=0.8}.
+ \item \lstinline{FiraMono} package for typewriter fonts, with option \lstinline{scale=0.8}.
\item \lstinline{ctex} package for Chinese fonts, with option \lstinline{scheme=plain}.
\end{itemize}
-\noindent\textbf{Using XeLaTeX:} If you choose XeLaTeX to process your paper, I use \lstinline{fontspec} package and \lstinline{xeCJK} package. I used fonts available in Windows, if you are using Linux or Mac OS, please substitute these fonts with that of your system. The font setting part
+\subsubsection[Compile with XeLaTeX]{Compile with \lstinline{XeLaTeX}}
+If you choose \lstinline{XeLaTeX} to process your paper, I use \lstinline{fontspec} package and \lstinline{xeCJK} package. I used fonts available in Windows, if you are using Linux or Mac OS, please substitute these fonts with that of your system. The font setting part
\begin{lstlisting}
\RequirePackage{fontenc}
\RequirePackage[no-math]{fontspec}
-\setmainfont{Times New Roman}
+\setmainfont{Times New Roman}[NFSSFamily=ntxtlf]
\setsansfont{Arial}
-%\setmonofont[Scale=0.8]{Courier New}
+%\setmonofont[Scale=0.9]{Courier New}
\RequirePackage{xeCJK}
\RequirePackage{xunicode}
\setCJKmainfont[BoldFont={SimHei},ItalicFont={KaiTi}]{SimSun}
\setCJKsansfont[BoldFont={SimHei},ItalicFont={KaiTi}]{KaiTi}
-\setCJKmonofont[BoldFont={SimHei},ItalicFont={KaiTi},Scale=0.8]{Microsoft YaHei}
+\setCJKmonofont[BoldFont={SimHei},ItalicFont={KaiTi},Scale=0.9]{Microsoft YaHei}
+\XeTeXlinebreaklocale "zh"
+\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
\RequirePackage{newtxmath}
-\DeclareSymbolFont{operators}{\encodingdefault}{\familydefault}{m}{n}
\end{lstlisting}
-
+\subsubsection{Other Settings}
These packages operate perfectly but are inappropriate for big operators, for example \lstinline{\sum} and \lstinline{\prod}, thus, I change these operators back to computer modern font. Equation~(\eqref{eq:binom}) shows the effects of these fonts:
\begin{equation}
-(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k \label{eq:binom}
+(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k \label{eq:binom}
\end{equation}
@@ -72,6 +76,7 @@ I don't change any default command or environment, which means you can use all t
\item \lstinline{\email}: create the hyperlink to email address.
\item \lstinline{\figref}: same usage as \lstinline{\ref}, but start with label text <\textbf{Figure n}>.
\item \lstinline{\tabref}: same usage as \lstinline{\ref}, but start with label text <\textbf{Table n}>.
+ \item \lstinline{\keywords}: create the keywords in the abstract section.
\end{enumerate}{}
\subsection{List Environments}
@@ -94,16 +99,13 @@ You can use \lstinline{itemize}, \lstinline{enumerate}, or \lstinline{descriptio
\end{minipage}
\subsection{Table}
-I strongly recommend you to use the \lstinline{booktabs} package in your paper. It adds three commands to make the table prettier, ie. \lstinline{\toprule}, \lstinline{\midrule} and \lstinline{\bottomrule}. Here is an example.
-
-
-
+I strongly recommend you to use the \lstinline{booktabs} package in your paper. It adds three commands to make the table prettier, ie. \lstinline{\toprule}, \lstinline{\midrule} and \lstinline{\bottomrule}. \tabref{tab:reg} is an example.
\begin{lstlisting}
\begin{table}[htbp]
\small
\centering
- \caption{Auto MPG and Price}
+ \caption{Auto MPG and Price \label{tab:reg}}
\begin{tabular}{lcc}
\toprule
& (1) & (2) \\
@@ -120,13 +122,12 @@ I strongly recommend you to use the \lstinline{booktabs} package in your paper.
\multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\
\multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\
\end{tabular}%
- \label{tab:reg}%
\end{table}%
\end{lstlisting}
\begin{table}[htbp]
\small
\centering
- \caption{Auto MPG and Price}
+ \caption{Auto MPG and Price \label{tab:reg}}
\begin{tabular}{lcc}
\toprule
& (1) & (2) \\
@@ -143,7 +144,6 @@ I strongly recommend you to use the \lstinline{booktabs} package in your paper.
\multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\
\multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\
\end{tabular}%
- \label{tab:reg}%
\end{table}%
@@ -155,19 +155,19 @@ To include a graphic, you can use figure environment as usual. \figref{fig:scatt
\begin{figure}[htbp]
\centering
\includegraphics[width=0.6\textwidth]{scatter.pdf}
- \caption{Scatter Plot Example\label{fig:scatter}}
+ \caption{Scatter Plot Example \label{fig:scatter}}
\end{figure}
\end{lstlisting}
\begin{figure}[htbp]
\centering
\includegraphics[width=0.6\textwidth]{scatter.pdf}
- \caption{Scatter Plot Example\label{fig:scatter}}
+ \caption{Scatter Plot Example \label{fig:scatter}}
\end{figure}
\subsection{Bibliography}
-This template uses Bib\TeX{} to generate the bibliography, the default bibliography style is \lstinline{aer}. ~\cite{Chen2018} use data from a major peer-to-peer lending marketplace in China to study whether female and male investors evaluate loan performance differently. If you want to use Bib\TeX{}, you must create a file named \lstinline{wpref.bib}, and add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to \lstinline{wpref.bib} file, and cite the bibkey in the \lstinline{tex} file.
+This template uses Bib\TeX{} to generate the bibliography, the default bibliography style is \lstinline{aer}. Let's take a glance at the citation effect, ~\cite{Chen2018} use data from a major peer-to-peer lending marketplace in China to study whether female and male investors evaluate loan performance differently.
-The Bib\TeX{} will automatically generate the bibliography for you for the reference you cited. If you want to add some noncited reference to the bibliography, you can use
+If you want to use Bib\TeX{}, you must create a file named \lstinline{wpref.bib}, and add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to \lstinline{wpref.bib} file, and cite the bibkey in the \lstinline{tex} file. The Bib\TeX{} will automatically generate the bibliography for you for the reference you cited. If you want to add some noncited reference to the bibliography, you can use
\begin{lstlisting}
\nocite{EINAV2010, Havrylchyk2018}
@@ -180,7 +180,7 @@ In this section, we give a simple example using this template.
\documentclass[lang=en]{elegantpaper}
% title information
-\title[lang=en]{A Working Paper Example}
+\title{A Working Paper Example}
\author{ddswhu}
\institute{Elegant\LaTeX{} Group}
\version{1.00}
@@ -192,15 +192,14 @@ In this section, we give a simple example using this template.
\begin{abstract}
Your abstract goes here.
+\keywords{keyword1, keyword2}
\end{abstract}
\section{Introduction}
-
-The text of introduction section.
+The content of introduction section.
\section{Conclusion}
-
-The text of conclusion section.
+The content of conclusion section.
% include the noncited reference
\nocite{ref1, ref2}
@@ -208,7 +207,7 @@ The text of conclusion section.
\end{document}
\end{lstlisting}
-\nocite{EINAV2010,Havrylchyk2018}
+\nocite{EINAV2010, Havrylchyk2018}
\bibliography{wpref}
\end{document}