summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/elegantpaper/elegantpaper-en.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-04-13 03:03:00 +0000
committerNorbert Preining <norbert@preining.info>2020-04-13 03:03:00 +0000
commitc98e9ebef816f09dc54c52a01df4f978e1b210fc (patch)
tree0073017824e78ee91d2356f76d2b2944437da5d9 /macros/latex/contrib/elegantpaper/elegantpaper-en.tex
parentffcfe2bb60911db71a31e4c12541eae3e9df29f3 (diff)
CTAN sync 202004130303
Diffstat (limited to 'macros/latex/contrib/elegantpaper/elegantpaper-en.tex')
-rw-r--r--macros/latex/contrib/elegantpaper/elegantpaper-en.tex159
1 files changed, 99 insertions, 60 deletions
diff --git a/macros/latex/contrib/elegantpaper/elegantpaper-en.tex b/macros/latex/contrib/elegantpaper/elegantpaper-en.tex
index 271dc27fa2..657457ba18 100644
--- a/macros/latex/contrib/elegantpaper/elegantpaper-en.tex
+++ b/macros/latex/contrib/elegantpaper/elegantpaper-en.tex
@@ -1,21 +1,24 @@
%!TEX program = pdflatex
% Full chain: pdflatex -> bibtex -> pdflatex -> pdflatex
-\documentclass[11pt,en,authoryear]{elegantpaper}
+\documentclass[11pt,en,cite=authoryear]{elegantpaper}
\title{ElegantPaper: An Elegant \LaTeX{} Template for Working Papers}
\author{Ethan DENG \\ Fudan University \and Dongsheng DENG \\ PA Technology}
\institute{\href{https://github.com/ElegantLaTeX}{Elegant\LaTeX{} Program}}
-\version{0.08}
+\version{0.09}
\date{\today}
+% cmd for this doc
+\usepackage{array}
+\newcommand{\ccr}[1]{\makecell{{\color{#1}\rule{1cm}{1cm}}}}
\begin{document}
\maketitle
\begin{abstract}
-This documentation illustrates the usage of the \href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} template. This template is based on the standard \LaTeX{} article class, which is designed for working paper writing. With this template, you can get rid of all the worries about the format and merely focus on writing. For any question, please leave a message on \href{https://github.com/ElegantLaTeX/ElegantPaper/issues}{Github::ElegantPaper/issues}. Want to know more about Elegant\LaTeX{} Templates? Please visit: \href{https://github.com/ElegantLaTeX}{https://github.com/ElegantLaTeX}.\par
+This documentation illustrates the usage of the \href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} template. This template is based on the standard \LaTeX{} article class, which is designed for working paper writing. With this template, you can get rid of all the worries about the format and merely focus on writing. For any question, please leave a message on \href{https://github.com/ElegantLaTeX/ElegantPaper/issues}{GitHub::ElegantPaper/issues}. Want to know more about Elegant\LaTeX{} Templates? Please visit: \href{https://github.com/ElegantLaTeX}{https://github.com/ElegantLaTeX}.\par
\keywords{Elegant\LaTeX{}, Working Paper, Template}
\end{abstract}
@@ -40,24 +43,29 @@ Language mode option \lstinline{lang} allows two alternative inputs, \lstinline{
\usepackage[UTF8,scheme=plain]{ctex}
\end{lstlisting}
-\subsection{Fonts}
-This template sets \lstinline{newtxtext} and \lstinline{newtxmath} for English and math fonts respectively.
-\begin{equation}
-(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k\label{eq:binom}
-\end{equation}
+\subsection{Math Fonts}
+
+This template defines a new option (\lstinline{math}), with three options:
+
+\begin{enumerate}
+ \item \lstinline{math=cm} (default), use \LaTeX{} default math font (recommended).
+ \item \lstinline{math=newtx}, use \lstinline{newtxmath} math font (may bring about bugs).
+ \item \lstinline{math=mtpro2}, use \lstinline{mtpro2} package to set math font.
+\end{enumerate}
+
\subsection{Custom Commands}
Default \LaTeX{} commands and environments are all the same in this template\footnote{To ensure the codes are replicatable. We recommend users pay more attention to the contents other than formats. This is the meaning of the existence of the template.}. We created four new commands:
\begin{enumerate}
- \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.
+ \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{Bibliography}
-This template used \hologo{BibTeX} to generate the bibliography, the default bibliography style is \lstinline{aer} under the option \lstinline{lang=en}. Citation example: ~\cite{en3} used data from a major peer-to-peer lending marketplace in China to study whether female and male investors evaluate loan performance differently.
+This template used \hologo{BibTeX} to generate the bibliography, the default bibliography style is \lstinline{aer} under the option \lstinline{lang=en}. Citation example: ~\citep{en1,en2,en3} used 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 \hologo{BibTeX}, 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. Note that \hologo{BibTeX} has to be added.
@@ -84,10 +92,7 @@ So far, Elegant\LaTeX{} has four support members:
Thank them all!!!
\section{Acknowledgement}
-The number of stars on Github for ElegantPaper reached 164 on Oct 17, 2019 at the release of ElegantPaper v0.08.
-Thank China\TeX{} and \href{http://www.latexstudio.net/}{\LaTeX{} studio} for their promotion.
-
-If you like our templates, star on Github.
+The number of stars on GitHub for ElegantPaper reached 277 on April 12, 2020 at the release of ElegantPaper v0.09. Thank China\TeX{} and \href{http://www.latexstudio.net/}{\LaTeX{} studio} for their promotion. If you like our templates, you can star it on GitHub.
\begin{figure}[!ht]
\centering
\includegraphics[width=\textwidth]{star.png}
@@ -103,27 +108,46 @@ To express your love for our templates and/or our developers, please do not hesi
\textbf{The explanation right of the tip usage belongs to Elegant\LaTeX{} with no supervision. Feel free to tip us.} Those who donate more than 10 RMB will be recorded in the donation list. Thank all the tippers!
-\begin{table}[htbp]
+
+\begin{table}[!htb]
\centering
\caption{Donation List}
- \begin{tabular}{cccc}
- \toprule
- Tipper & Amount & Date & Channel \\
- \midrule
- Lerh & 10 RMB & 2019/05/15 & Wechat \\
- Yueguodipingxian & 10 RMB & 2019/05/15 & Wechat \\
- Dapeng & 20 RMB & 2019/05/27 & Wechat\\
- Anonymous & 10 RMB & 2019/05/30 & Wechat \\
- \href{http://www.latexstudio.net/}{latexstudio.net} & 666 RMB & 2019/06/05 & Alipay \\
- Cassis & 11 RMB & 2019/06/30 & Wechat \\
- Some Jun & 10 RMB & 2019/07/23 & Wechat \\
- Some Meng & 19 RMB & 2019/08/28 & Wechat \\
- Qu DouDou & 10 RMB & 2019/08/28 & Wechat \\
- Li Bo & 100 RMB & 2019/10/06 & Wechat\\
- Njustsll & 10 RMB & 2019/10/11 & Wechat \\
- \bottomrule
+ \begin{tabular}{*{4}{>{\scriptsize}c}|*{4}{>{\scriptsize}c}}
+ \toprule
+ \textbf{Tipper} & \textbf{Amount} & \textbf{Date} & \textbf{Channel} & \textbf{Tipper} & \textbf{Amount} & \textbf{Date} & \textbf{Channel} \\
+ \midrule
+ Lerh & 10 RMB & 2019/05/15 & Wechat & yueguodipingxian & 10 RMB & 2019/05/15 & Wechat \\
+ yinsang & 20 RMB & 2019/05/27 & Wechat & *kong & 10 RMB & 2019/05/30 & Wechat \\
+ latexstudio.net & 666 RMB & 2019/06/05 & Alipay & A*n & 40 RMB & 2019/06/15 & Wechat \\
+ * xia & 22 RMB & 2019/06/15 & Wechat & * qian & 21 RMB & 2019/06/15 & Wechat \\
+ Cassis & 11 RMB & 2019/06/30 & Wechat & * jun & 10 RMB & 2019/07/23 & Wechat \\
+ P*u & 50 RMB & 2019/07/30 & Wechat & * meng & 19 RMB & 2019/08/28 & Wechat \\
+ Qu Doudou & 10 RMB & 2019/08/28 & Wechat & Li Bo & 100 RMB & 2019/10/06 & Wechat \\
+ Njustsll & 10 RMB & 2019/10/11 & Wechat & Liu Zhikuo & 99.99 RMB & 2019/10/15 & Alipay \\
+ * tao & 16 RMB & 2019/10/17 & Wechat & Chini & 12 RMB & 2019/10/17 & Alipay \\
+ yuanfengjing & 10 RMB & 2019/10/28 & Wechat & Guo Deliang & 88 RMB & 2019/11/03 & Wechat \\
+ ziqiangbuxi & 20 RMB & 2019/11/04 & Alipay & dushuzhichong & 20 RMB & 2019/11/18 & Wechat \\
+ * deng & 10 RMB & 2019/11/18 & Wechat & * zhe & 20 RMB & 2019/11/18 & Wechat \\
+ anonymous & 10 RMB & 2019/11/24 & Wechat & Jiye Qian & 66 RMB & 2019/12/04 & Wechat \\
+ * yang & 20 RMB & 2019/12/05 & Wechat & Catcher & 11 RMB & 2019/12/08 & Alipay \\
+ xierbotementu & 10 RMB & 2019/12/09 & Alipay & * wei & 10 RMB & 2019/12/09 & Wechat \\
+ Simon & 20 RMB & 2019/12/11 & Alipay & liushangqianyi & 66.60 RMB & 2019/12/18 & Alipay \\
+ yu & 10 RMB & 2019/12/20 & Alipay & *chen & 15 RMB & 2019/12/20 & Wechat \\
+ suifeng & 20 RMB & 2019/12/27 & Alipay & Ws & 23.30 RMB & 2019/12/28 & Wechat \\
+ chuba & 100 RMB & 2020/01/02 & Alipay & p*e & 20 RMB & 2020/01/03 & Wechat \\
+ Shunmx & 100 RMB & 2020/01/03 & Wechat & hj & 10 RMB & 2020/01/03 & Wechat \\
+ F*5 & 10 RMB & 2020/01/03 & Wechat & S*m & 20.20 RMB & 2020/01/03 & Wechat \\
+ erdaiqingzhi & 13 RMB & 2020/01/14 & Alipay & *? & 66 RMB & 2020/01/15 & Wechat \\
+ Mr. Xiong & 20 RMB & 2020/01/17 & Wechat & *bo & 15 RMB & 2020/01/18 & Wechat \\
+ *Zhe & 10 RMB & 2020/02/02 & Wechat & Jackie & 88.80 RMB & 2020/02/09 & Wechat \\
+ Henry\_Sun & 50 RMB & 2020/02/14 & Alipay & * Qiao & 50 RMB & 2020/02/21 & Wechat \\
+ YunLian & 10 RMB & 2020/03/02 & Alipay & S*y & 10 RMB & 2020/03/15 & Wechat \\
+ * Ge & 66.66 RMB & 2020/03/17 & Wechat & K*e & 30 RMB & 2020/03/30 & Wechat\\
+ * Yang & 20 RMB & 2020/04/02 & Wechat & Shi*n & 30 RMB & 2020/04/11 & Wechat \\
+ \bottomrule
\end{tabular}%
-\end{table}%
+ \label{tab:donation}%
+ \end{table}%
\section{FAQ}
@@ -138,43 +162,58 @@ To express your love for our templates and/or our developers, please do not hesi
\author{author 1\\ org. 1 \and author 2 \\ org. 2 }
\end{lstlisting}
\item \textit{How to display bilingual abstracts?}\\
- Please refer to \href{https://github.com/ElegantLaTeX/ElegantPaper/issues/5}{Github::ElegantPaper/issues/5}
+ Please refer to \href{https://github.com/ElegantLaTeX/ElegantPaper/issues/5}{GitHub::ElegantPaper/issues/5}
\end{enumerate}
-\section{Minimal Example}
-A minimal example is as follows:
-\begin{lstlisting}
-\documentclass[a4paper,11pt]{elegantpaper}
-% title information
-\title{Working Paper Example}
-\author{Author Name}
-\institute{Elegant\LaTeX{} Group}
+\nocite{en1,en2}
-\version{1.00}
-\date{\today}
+\bibliography{wpref}
-\begin{document}
+\appendix
+%\appendixpage
+\addappheadtotoc
-\maketitle
-\begin{abstract}
-Your abstract goes here.
-\keywords{keyword1, keyword2}
-\end{abstract}
+\section{Use newtx fonts}
+If you use \lstinline{newtx} fonts, type in:
-\section{Introduction}
-The content of introduction section.
+\begin{lstlisting}
+\documentclass[math=newtx]{elegantbook}
+\end{lstlisting}
-\section{Conclusion}
-The content of conclusion section.
-\bibliography{wpref}
+\subsection{Hyphens}
+Since the template uses \lstinline{newtx}, please pay attention to the hyphens. For instance,
+\begin{equation}
+\int_{R^q} f(x,y) dy.\emph{of\kern0pt f}
+\end{equation}
-\end{document}
+The corresponding code is:
+\begin{lstlisting}
+\begin{equation}
+\int_{R^q} f(x,y) dy.\emph{of \kern0pt f}
+\end{equation}
\end{lstlisting}
-\nocite{en1,en2}
-\bibliography{wpref}
+\subsection{Symbol Fonts}
+Feedback from ElegantBook users claims that error occurs when using our templates with \lstinline{yhmath}, \lstinline{esvect} and other packages.
+\begin{lstlisting}
+LaTeX Error:
+Too many symbol fonts declared.
+\end{lstlisting}
+
+The reason is that the template redefines font for math so that no new math font is allowed to be added. To use \lstinline{yhmath} and/or \lstinline{esvect}, please locate \lstinline{yhmath} or \lstinline{esvect} in \lstinline{elegantpaper.cls}, uncomment corresponding related code.
+
+\begin{lstlisting}
+%%% use yhmath pkg, uncomment following code
+% \let\oldwidering\widering
+% \let\widering\undefined
+% \RequirePackage{yhmath}
+% \let\widering\oldwidering
+
+%%% use esvect pkg, uncomment following code
+% \RequirePackage{esvect}
+\end{lstlisting}
\end{document}