diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/README.md | 13 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.pdf | bin | 136252 -> 342905 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.tex | 238 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.pdf | bin | 233782 -> 390041 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex | 218 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/figure/ElegantLaTeX.png | bin | 91663 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.pdf | bin | 16037 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.py | 27 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/image/donate.jpg | bin | 0 -> 141078 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/image/star.png | bin | 0 -> 48934 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/elegantpaper/wpref.bib | 3 |
11 files changed, 225 insertions, 274 deletions
diff --git a/Master/texmf-dist/doc/latex/elegantpaper/README.md b/Master/texmf-dist/doc/latex/elegantpaper/README.md index 798c370e7ad..c3a0fb2ce83 100644 --- a/Master/texmf-dist/doc/latex/elegantpaper/README.md +++ b/Master/texmf-dist/doc/latex/elegantpaper/README.md @@ -10,13 +10,18 @@   -ElegantPaper is designed for writing a working paper, especially for economics students. 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 create issues, pull requests or email us at elegantlatex2e@gmail.com. -此模板基于 LaTeX 的 article 类，专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式，专心写作，从而有更加舒适，简便的写作体验。如果你有其他问题、建议或者报告 bug，可以提交 issues 或者给我们发邮件：elegantlatex2e@gmail.com。 +ElegantPaper is designed for writing a working paper, especially for economics students. 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 create issues or email us at elegantlatex2e@gmail.com. -# License +此模板基于 LaTeX 的 article 类，专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式，专心写作，从而有更加舒适，简便的写作体验。如果你有其他问题、建议或者报告 bug，可以提交 issues 或者给我们发邮件：elegantlatex2e@gmail.com。用户 QQ 交流群（Q 群：692108391），欢迎加入。 + +The official user guide is [here](https://github.com/ElegantLaTeX/ElegantPaper/releases), or you can refer to the [wiki](https://github.com/ElegantLaTeX/ElegantPaper/wiki). + +模板使用说明请参见[模板文档](https://github.com/ElegantLaTeX/ElegantPaper/releases)，或者 [wiki](https://github.com/ElegantLaTeX/ElegantPaper/wiki)。 + +## License This work is released under the LaTeX Project Public License, v1.3c or later. -本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。 +本模板发布遵循 LaTeX 项目公共许可证 1.3c 或更高版本。 diff --git a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.pdf b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.pdf Binary files differindex 700c8751317..eaa05d3287a 100644 --- a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.pdf +++ b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.pdf diff --git a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.tex b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.tex index 858d31f2a25..f5a57994bbe 100644 --- a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.tex +++ b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-cn.tex @@ -1,184 +1,171 @@ %!TEX program = xelatex -% 完整编译方法 1 pdflatex -> bibtex -> pdflatex -> pdflatex -% 完整编译方法 2: xelatex -> bibtex -> xelatex -> xelatex -\documentclass[lang=cn,11pt]{elegantpaper} +% 完整编译: xelatex -> bibtex -> xelatex -> xelatex +\documentclass[lang=cn,11pt,a4paper]{elegantpaper} \title{ElegantPaper: 一个优美的 \LaTeX{} 工作论文模板} -\author{\href{https://ddswhu.me/}{邓 东 升}} - +\author{Ethan DENG \\ Fudan University \and Dongsheng DENG \\ PA Technology} \institute{\href{https://elegantlatex.org/}{Elegant\LaTeX{} 项目组}} -% 不需要版本信息，直接注释即可 -\version{0.07} -% 不需要时间信息的话，需要把 \today 删除。 -\date{\today} - - -% 如果想修改参考文献样式，请把这行注释掉 -\usepackage[authoryear]{gbt7714} % 国标 +\version{0.08} +\date{\zhtoday} \begin{document} \maketitle \begin{abstract} -\noindent 本文为 \href{https://github.com/ElegantLaTeX/ElegantPaper/}{ElegantPaper} 的说明文档（中文）。此模板基于 \LaTeX{} 的 article 类，专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式，专心写作，从而有更加舒适，简便的写作体验。如果你有其他问题、建议或者报告 bug，可以在 \href{https://github.com/ElegantLaTeX/ElegantPaper/issues}{ElegantPaper/issues} 留言。如果你想了解更多由 Elegant\LaTeX{} 项目组设计的模板，请访问 \href{https://github.com/ElegantLaTeX/}{https://github.com/ElegantLaTeX/}。 +本文为 \href{https://github.com/ElegantLaTeX/ElegantPaper/}{ElegantPaper} 的说明文档。此模板基于 \LaTeX{} 的 article 类，专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式，专心写作，从而有更加舒心的写作体验。如果你有其他问题、建议或者报告 bug，可以在 \href{https://github.com/ElegantLaTeX/ElegantPaper/issues}{Github::ElegantPaper/issues} 留言。如果你想了解更多 Elegant\LaTeX{} 项目组设计的模板，请访问 \href{https://github.com/ElegantLaTeX/}{Github::ElegantLaTeX}。 \keywords{Elegant\LaTeX{}，工作论文，模板} \end{abstract} -\section{模板介绍} -此模板是基于 \LaTeX{} 的标准文类 article设计，也即意味着你可以把 article 文类的选项传递给本模板，比如 \lstinline{a4paper, 10pt} 等等（推荐使用 \lstinline{11pt}）。本模板支持 \lstinline{PDFLaTeX} 和 \lstinline{XeLaTeX}\footnote{中文字体均使用 \lstinline{ctex} 包设置。} 两种编译方式。 +\section{模板使用须知} -数学字体的效果如下： +\subsection{模板介绍} -\begin{equation} -(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k\label{eq:binom} -\end{equation} - -\subsection{全局选项} -我在这个模板中定义了一个语言选项 \lstinline{lang}，可以选择英文模式 \lstinline{lang=en}（默认）或者中文模式 \lstinline{lang=cn}。当选择中文模式时，图表的标题引导词以及参考文献，定理引导词等信息会变成中文。你可以通过下面两种方式来选择语言模式： +此模板基于 \LaTeX{} 的标准文类 article 设计，所以 article 文类的选项也能传递给本模板，比如 \lstinline{a4paper, 11pt} 等等。本模板支持 \hologo{pdfLaTeX} 和 \hologo{XeLaTeX} 编译。 \begin{lstlisting} +\documentclass[a4paper,11pt]{elegantpaper} +\end{lstlisting} + +\textbf{注意}：Elegant\LaTeX{} 系列模板已经全部上传至 \href{https://www.overleaf.com/latex/templates/elegantpaper-template/yzghrqjhmmmr}{Overleaf} 上，用户可以在线使用。另外，为了方便国内用户，模板也已经传至\href{https://gitee.com/ElegantLaTeX/ElegantPaper}{码云}。 + + +\subsection{全局选项} +此模板定义了一个语言选项 \lstinline{lang}，可以选择英文模式 \lstinline{lang=en}（默认）或者中文模式 \lstinline{lang=cn}。当选择中文模式时，图表的标题引导词以及参考文献，定理引导词等信息会变成中文。你可以通过下面两种方式来选择语言模式： +\begin{lstlisting} \documentclass[lang=cn]{elegantpaper} % or \documentclass{cn}{elegantpaper} \end{lstlisting} +\textbf{注意：} 英文模式下，由于没有添加中文宏包，无法输入中文。如果需要输入中文，可以通过在导言区引入中文宏包 \lstinline{ctex} 或者加入 \lstinline{xeCJK} 宏包后自行设置字体。 +\begin{lstlisting} +\usepackage[UTF8,scheme=plain]{ctex} +\end{lstlisting} + +\subsection{英文与数学字体} -\subsection{自定义命令} -在此模板中，并没有修改任何默认的命令或者环境，所以，你可以在此模板使用原来的命令和环境。另外，我自定义了 3 个命令： +本模板使用 \lstinline{newtxtext} 和 \lstinline{newtxmath} 分别设置全文的英文文本字体和数学字体。数学字体的效果如下： +\begin{equation} +(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k\label{eq:binom} +\end{equation} +\subsection{自定义命令} +此模板并没有修改任何默认的 \LaTeX{} 命令或者环境\footnote{目的是保证代码的可复用性，请用户关注内容，不要太在意格式，这才是本工作论文模板的意义。}。另外，我自定义了 4 个命令： \begin{enumerate} - \item \lstinline{\email}：创建邮箱地址的链接； - \item \lstinline{\figref}：用法和 \lstinline{\ref} 类似，但是会在插图的标题前添加 <\textbf{图 n}> ； - \item \lstinline{\tabref}：用法和 \lstinline{\ref} 类似，但是会在表格的标题前添加 <\textbf{表 n}>； - \item \lstinline{\keywords}：为摘要环境添加关键词。 + \item \lstinline{\email}：创建邮箱地址的链接，比如 \email{ddswhu@outlook.com}； + \item \lstinline{\figref}：用法和 \lstinline{\ref} 类似，但是会在插图的标题前添加 <\textbf{图 n}> ； + \item \lstinline{\tabref}：用法和 \lstinline{\ref} 类似，但是会在表格的标题前添加 <\textbf{表 n}>； + \item \lstinline{\keywords}：为摘要环境添加关键词。 \end{enumerate} +\subsection{参考文献} +此模板使用 \hologo{BibTeX} 来生成参考文献，中文模式下默认使用的文献样式（bib style）是 \lstinline{GB/T 7714-2015}\footnote{通过调用 \href{https://ctan.org/pkg/gbt7714}{\lstinline{gbt7714}} 宏包}。参考文献示例：~\cite{en3} 使用了中国一个大型的 P2P 平台（人人贷）的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。 +你可以在谷歌学术，Mendeley，Endnote 中获得文献条目（bib item），然后把它们添加到 \lstinline{wpref.bib} 中。在文中引用的时候，引用它们的键值（bib key）即可。注意需要在编译的过程中添加 \hologo{BibTeX} 编译。 -\subsection{列表环境} -你可以使用列表环境（\lstinline{itemize}、\lstinline{enumerate}、\lstinline{description}），示例如下：\\[2ex] -\begin{minipage}[c]{0.59\linewidth} +本模板还添加了 \lstinline{cite=numbers} 、\lstinline{cite=super} 和 \lstinline{cite=authoryear} 三个参考文献选项，用于设置参考文献格式的设置，默认为 \lstinline{numbers}。理工科类一般使用数字形式 \lstinline{numbers} 或者上标形式 \lstinline{super}，而文科类多使用作者-年份 \lstinline{authoryear} 比较多。如果需要改为 \lstinline{cite=numbers} 或者 \lstinline{authoryear} ，可以使用 \begin{lstlisting} -\begin{itemize} - \item Routing and resource discovery; - \item Resilient and scalable networks; - \item Distributed storage and search. -\end{itemize} +\documentclass[cite=super]{elegantpaper} % super style ref style +\documentclass[super]{elegantpaper} + +\documentclass[cite=authoryear]{elegantpaper} % author-year ref style +\documentclass[authoryear]{elegantpaper} \end{lstlisting} -\end{minipage} -\begin{minipage}[c]{0.4\linewidth} -\begin{itemize} - \item Routing and resource discovery; - \item Resilient and scalable networks; - \item Distributed storage and search. -\end{itemize} -\end{minipage} +\section{协作人员招募} +招募 Elegant\LaTeX{} 的协作人员，没有工资。工作内容：翻译 Elegant\LaTeX{} 系列模板相关的文稿（中翻英），维护模板的 wiki（主要涉及 Markdown），如果有公众号文稿写作经历的话，也可以帮忙写微信稿。本公告长期有效。 +目前 ElegantLaTeX 共有 4 名协作人员，分别是 +\begin{itemize} + \item 官方文档翻译: \href{https://github.com/peggy2006xzyz}{YPY}; + \item Github 维基维护: \href{https://github.com/izinngo}{Ingo Zinngo}、\href{https://github.com/xiaohao890809}{追寻原风景}; + \item QQ 群管理员: \href{https://github.com/sikouhjw}{Sikouhjw}. +\end{itemize} -\subsection{插图} -插图的命令和以前一样，也是使用 \lstinline{figure} 环境。\figref{fig:scatter} 显示了插图的效果。你可以把你的图放到当前工作目录的如下子目录下 (\lstinline{./image/}, \lstinline{./img/}, \lstinline{./figure/}, \lstinline{./fig/})。 +在此感谢他们无私的奉献！ -\begin{lstlisting} +\section{致谢} +截止到 2019 年 10 月 17 日，ElegantPaper v0.08 版本发布，ElegantPaper 模板在 Github 上的收藏数（star）达到了 164。在此特别感谢 China\TeX{} 以及 \href{http://www.latexstudio.net/}{\LaTeX{} 工作室}对于本系列模板的大力宣传与推广。 + +如果你喜欢我们的模板，你可以在 Github 上收藏（Star）我们的模板。 \begin{figure}[htbp] - \centering - \includegraphics[width=0.6\textwidth]{scatter.pdf} - \caption{Scatter Plot Example \label{fig:scatter}} + \centering + \includegraphics[width=\textwidth]{star.png} + \caption{一键三连求赞} \end{figure} -\end{lstlisting} + +\section{捐赠} +如果您非常喜爱我们的模板，你还可以选择捐赠以表达您对我们模板和我的支持！ + \begin{figure}[htbp] - \centering - \includegraphics[width=0.6\textwidth]{scatter.pdf} - \caption{Scatter Plot Example \label{fig:scatter}} + \centering + \includegraphics[width=0.5\textwidth]{donate.jpg} \end{figure} -\subsection{表格} -我强烈建议你使用 \lstinline{booktabs} 宏包，这个宏包有三个命令 \lstinline{\toprule}、\lstinline{\midrule} 和 \lstinline{\bottomrule} 能方便你制作三线表。\tabref{tab:reg} 是一个示例： +\textbf{赞赏费用的使用解释权归 Elegant\LaTeX{} 所有，并且不接受监督，请自愿理性打赏}。10 元以上的赞赏，我们将列入捐赠榜，谢谢各位金主！ -\begin{lstlisting} -\begin{table}[htbp] - \small - \centering - \caption{Auto MPG and Price \label{tab:reg}} - \begin{tabular}{lcc} - \toprule - & (1) & (2) \\ - \midrule - mpg & -238.90*** & -49.51 \\ - & (53.08) & (86.16) \\ - weight & & 1.75*** \\ - & & (0.641) \\ - constant & 11,253*** & 1,946 \\ - & (1,171) & (3,597) \\ - obs & 74 & 74 \\ - $R^2$ & 0.220 & 0.293 \\ - \bottomrule - \multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\ - \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ - \end{tabular}% -\end{table}% -\end{lstlisting} -\begin{table}[htbp] - \small +\begin{table}[!htbp] \centering - \caption{Auto MPG and Price \label{tab:reg}} - \begin{tabular}{lcc} + \caption{Elegant\LaTeX{} 系列模板捐赠榜} + \begin{tabular}{crcc} \toprule - & (1) & (2) \\ + 捐赠者 & 金额 & 时间 & 渠道 \\ \midrule - mpg & -238.90*** & -49.51 \\ - & (53.08) & (86.16) \\ - weight & & 1.75*** \\ - & & (0.641) \\ - constant & 11,253*** & 1,946 \\ - & (1,171) & (3,597) \\ - obs & 74 & 74 \\ - $R^2$ & 0.220 & 0.293 \\ - \bottomrule - \multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\ - \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ - \end{tabular}% + Lerh & 10 元 & 2019/05/15 & 微信 \\ + 越过地平线 & 10 元 & 2019/05/15 & 微信 \\ + 大熊 & 20 元 & 2019/05/27 & 微信 \\ + * 空 & 10 元 & 2019/05/30 & 微信\\ + \href{http://www.latexstudio.net/}{latexstudio.net} & 666 元 & 2019/06/05 & 支付宝\\ + Cassis & 11 元 & 2019/06/30 & 微信\\ + * 君 & 10 元 & 2019/07/23 & 微信\\ + * 萌 & 19 元 & 2019/08/28 & 微信 \\ + 曲豆豆 & 10 元 & 2019/08/28 & 微信 \\ + 李博 & 100 元 & 2019/10/06 & 微信\\ + Njustsll & 10 元 & 2019/10/11 & 微信 \\ + \bottomrule + \end{tabular}% \end{table}% - - -\subsection{参考文献} -此模板使用了 Bib\TeX{} 来生成参考文献，默认使用的文献样式（bib style）是 \lstinline{GB/T 7714-2015}\footnote{通过调用 \href{https://ctan.org/pkg/gbt7714}{\lstinline{gbt7714}} 宏包}。参考文献示例：~\cite{en3} 使用了中国一个大型的 P2P 平台（人人贷）的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。 - -你可以在谷歌学术，Mendeley，Endnote 中获得文献条目（bib item），然后把它们添加到 \lstinline{wpref.bib} 中。在文中引用的时候，引用它们的键值（bib key）即可。注意需要在编译的过程中添加 Bib\TeX{} 编译。如果你想在参考文献中添加未引用的文献（部分或者全部），可以使用 - -\begin{lstlisting} -\nocite{EINAV2010, Havrylchyk2018} % add the two reference. -\nocite{*} % add all the reference in the bib file. -\end{lstlisting} - -如果你想修改参考文献的样式（比如改为 \lstinline{aer}），你可以在导言区将下面代码注释掉。 -\begin{lstlisting} -\usepackage[authoryear]{gbt7714} -\end{lstlisting} - -并且文档末尾添加 - -\begin{lstlisting} -\bibliographystyle{aer} +\section{常见问题 FAQ} + +\begin{enumerate}[label=\arabic*).] + \item \textit{如何删除版本信息？}\\ + 导言区不写 \lstinline|\version{x.xx}| 即可。 + \item \textit{如何删除日期？}\\ + 需要注意的是，与版本 \lstinline{\version} 不同的是，导言区不写或注释 \lstinline{\date} 的话，仍然会打印出当日日期，原因是 \lstinline{\date} 有默认参数。如果不需要日期的话，日期可以留空即可，也即 \lstinline|\date{}|。 + \item \textit{如何获得中文日期？}\\ + 为了获得中文日期，必须在中文模式下\footnote{英文模式下，由于未加载中文宏包，无法输入中文。}，使用 \lstinline|\date{\zhdate{2019/10/11}}|，如果需要当天的汉化日期，可以使用 \lstinline|\date{\zhtoday}|，这两个命令都来源于 \href{https://ctan.org/pkg/zhnumber}{\lstinline{zhnumber}} 宏包。 + \item \textit{如何添加多个作者？}\\ + 在 \lstinline{\author} 里面使用 \lstinline{\and}，作者单位可以用 \lstinline{\\} 换行。\begin{lstlisting} +\author{author 1\\ org. 1 \and author 2 \\ org. 2 } \end{lstlisting} + \item \textit{如何添加中英文摘要？}\\ + 请参考 \href{https://github.com/ElegantLaTeX/ElegantPaper/issues/5}{Github::ElegantPaper/issues/5} +\end{enumerate} \section{示例} -在这部分，我提供一个示例文档： +为了让大家更加清楚最终的论文效果，如下给出两篇使用 ElegantPaper 模板排版的工作论文示例，也欢迎大家“投稿”！ + +\begin{enumerate} + \item \href{https://github.com/EthanDeng/bank-custody}{银行存管、投资者决策与 P2P 网络借贷规范发展}； + \item \href{https://github.com/EthanDeng/risk-awareness}{互联网金融风险与投资者风险意识 —— 来自网贷平台交易数据的证据}。 +\end{enumerate} +这是一个最小示例文档（Minimal Example）： \begin{lstlisting} -\documentclass[lang=cn]{elegantpaper} +\documentclass[lang=cn,a4paper,11pt]{elegantpaper} % title information -\title{A Working Paper Example} -\author{ddswhu} +\title{Working Paper Example} +\author{Author Name} \institute{Elegant\LaTeX{} Group} + \version{1.00} \date{\today} @@ -197,17 +184,12 @@ The content of introduction section. \section{Conclusion} The content of conclusion section. -% include the noncited reference -\nocite{ref1, ref2} -\bibliographystyle{aer} \bibliography{wpref} + \end{document} \end{lstlisting} \nocite{*} - -% 如果想修改参考文献样式（非国标），请把下行取消注释，并换成合适的样式（比如 unsrt，plain 样式）。 -%\bibliographystyle{aer} \bibliography{wpref} \end{document} diff --git a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.pdf b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.pdf Binary files differindex 2d7a161d9ae..e5f3f4a37d4 100644 --- a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.pdf +++ b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.pdf diff --git a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex index 8f21f148981..271dc27fa21 100644 --- a/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex +++ b/Master/texmf-dist/doc/latex/elegantpaper/elegantpaper-en.tex @@ -1,11 +1,12 @@ %!TEX program = pdflatex % Full chain: pdflatex -> bibtex -> pdflatex -> pdflatex -\documentclass[11pt]{elegantpaper} +\documentclass[11pt,en,authoryear]{elegantpaper} \title{ElegantPaper: An Elegant \LaTeX{} Template for Working Papers} -\author{\href{https://ddswhu.me/}{Dongsheng Deng}} +\author{Ethan DENG \\ Fudan University \and Dongsheng DENG \\ PA Technology} \institute{\href{https://github.com/ElegantLaTeX}{Elegant\LaTeX{} Program}} -\version{0.07} + +\version{0.08} \date{\today} @@ -14,149 +15,142 @@ \maketitle \begin{abstract} -\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 +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} \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{10pt} and etc.)( \lstinline{11pt} is recommended). It supports different engines, You can choose either \lstinline{PDFLaTeX} or \lstinline{XeLaTeX}\footnote{with \lstinline{ctex} package for Chinese fonts settings.}. +This template is based on the standard \LaTeX{} article class, hence the arguments of article class are acceptable (\lstinline{a4paper}, \lstinline{10pt} and etc.). Alternative engines are \hologo{pdfLaTeX} and \hologo{XeLaTeX}. -The effect of math fonts is as follow: -\begin{equation} -(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k \label{eq:binom} -\end{equation} +\begin{lstlisting} +\documentclass[a4paper,11pt]{elegantpaper} +\end{lstlisting} +\textbf{Note:} ElegantPaper is available on \href{https://www.overleaf.com/latex/templates/elegantpaper-template/yzghrqjhmmmr}{Overleaf} and \href{https://gitee.com/ElegantLaTeX/ElegantPaper}{gitee}. \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 - +Language mode option \lstinline{lang} allows two alternative inputs, \lstinline{lang=en} (default) for English or \lstinline{lang=cn} for Chinese. \lstinline{lang=cn} will make the caption of figure/table, abstract name, refname etc. Chinese. You can use this option as \begin{lstlisting} -\documentclass[lang=en]{elegantpaper} -\documentclass{en}{elegantpaper} % both ok +\documentclass[lang=cn]{elegantpaper} % or +\documentclass{cn}{elegantpaper} +\end{lstlisting} +\textbf{Note:} Under the English mode \lstinline{lang=en}, Chinese characters are not allowed. To type in Chinese, please load \lstinline{ctex} or \lstinline{xeCJK} package at the preamble as: +\begin{lstlisting} +\usepackage[UTF8,scheme=plain]{ctex} \end{lstlisting} -\subsection{Custom Commands} +\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} -I don't change any default command or environment, which means you can use all the basic \LaTeX{} commands and environments as before. Besides, I define 3 commands +\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. -\end{enumerate}{} +\end{enumerate} -\subsection{List Environments} -You can use \lstinline{itemize}, \lstinline{enumerate}, or \lstinline{description} environment as below\\ -\begin{minipage}[c]{0.51\linewidth} -\begin{lstlisting} -\begin{itemize} - \item Routing and resource discovery; - \item Resilient and scalable networks; - \item Distributed storage and search. -\end{itemize} -\end{lstlisting} -\end{minipage} -\begin{minipage}[c]{0.48\linewidth} -\begin{itemize} - \item Routing and resource discovery; - \item Resilient and scalable networks; - \item Distributed storage and search. -\end{itemize} -\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}. \tabref{tab:reg} is an example. +\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. + +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. +Three options for the references, \lstinline{cite=numbers} (default), \lstinline{cite=super} and \lstinline{cite=authoryear}. Those who major in science and engineering use \lstinline{numbers} and \lstinline{super} more often, while those who major in arts use \lstinline{authoryear} more frequently. To switch different options, use \begin{lstlisting} -\begin{table}[htbp] - \small - \centering - \caption{Auto MPG and Price \label{tab:reg}} - \begin{tabular}{lcc} - \toprule - & (1) & (2) \\ - \midrule - mpg & -238.90*** & -49.51 \\ - & (53.08) & (86.16) \\ - weight & & 1.75*** \\ - & & (0.641) \\ - constant & 11,253*** & 1,946 \\ - & (1,171) & (3,597) \\ - obs & 74 & 74 \\ - $R^2$ & 0.220 & 0.293 \\ - \bottomrule - \multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\ - \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ - \end{tabular}% -\end{table}% +\documentclass[cite=super]{elegantpaper} % super style ref style +\documentclass[super]{elegantpaper} + +\documentclass[cite=authoryear]{elegantpaper} % author-year ref style +\documentclass[authoryear]{elegantpaper} \end{lstlisting} -\begin{table}[htbp] - \small - \centering - \caption{Auto MPG and Price \label{tab:reg}} - \begin{tabular}{lcc} - \toprule - & (1) & (2) \\ - \midrule - mpg & -238.90*** & -49.51 \\ - & (53.08) & (86.16) \\ - weight & & 1.75*** \\ - & & (0.641) \\ - constant & 11,253*** & 1,946 \\ - & (1,171) & (3,597) \\ - obs & 74 & 74 \\ - $R^2$ & 0.220 & 0.293 \\ - \bottomrule - \multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\ - \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ - \end{tabular}% -\end{table}% +\section{Recruit Support Members} + +Recruit support members for Elegant\LaTeX{} to translate template official guide, maintain wiki entries(Markdown), update Wechat articles. No deadline for this recruitment. + +So far, Elegant\LaTeX{} has four support members: +\begin{itemize} + \item OG Translator: \href{https://github.com/peggy2006xzyz}{YPY}; + \item Wiki Maintainer: \href{https://github.com/izinngo}{Ingo Zinngo}, \href{https://github.com/xiaohao890809}{Xiaohao890809}; + \item QQ Group Manager: \href{https://github.com/sikouhjw}{Sikouhjw}. +\end{itemize} +Thank them all!!! -\subsection{Graphics} -To include a graphic, you can use figure environment as usual. \figref{fig:scatter} shows the effect. You can put all your images in the sub directories (\lstinline{./image/}, \lstinline{./img/}, \lstinline{./figure/}, \lstinline{./fig/}) of your current working directory. +\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. -\begin{lstlisting} -\begin{figure}[htbp] +If you like our templates, star on Github. +\begin{figure}[!ht] \centering - \includegraphics[width=0.6\textwidth]{scatter.pdf} - \caption{Scatter Plot Example \label{fig:scatter}} + \includegraphics[width=\textwidth]{star.png} + \caption{Twinkle, Twinkle, Little Star} \end{figure} -\end{lstlisting} -\begin{figure}[htbp] + +\section{Donation} +To express your love for our templates and/or our developers, please do not hesitate to tip us. +\begin{figure}[!htbp] \centering - \includegraphics[width=0.6\textwidth]{scatter.pdf} - \caption{Scatter Plot Example \label{fig:scatter}} + \includegraphics[width=0.4\textwidth]{donate.jpg} \end{figure} -\subsection{Bibliography} -This template uses Bib\TeX{} to generate the bibliography, the default bibliography style is \lstinline{unsrt}. Let's take a glance at the citation effect, ~\cite{en3} 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. The Bib\TeX{} will automatically generate the bibliography for you for the reference you cited. If you want to add some noncited references or all of them to the bibliography, you can use - -\begin{lstlisting} -\nocite{EINAV2010, Havrylchyk2018} % add two noncited references -\nocite{*} % list all the references of the bib file. -\end{lstlisting} - -If you want to change the bibliography style, you can replace \lstinline{aer} for the prefered style, for example, the \lstinline{unsrt} style. - -\begin{lstlisting} -\bibliographystyle{unsrt} -\end{lstlisting} +\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! -\section{A Minimal Example} -In this section, we give a simple example using this template. +\begin{table}[htbp] + \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 + \end{tabular}% +\end{table}% +\section{FAQ} + +\begin{enumerate}[label=\arabic*).] + \item \textit{How to remove the information of version?}\\ + Please comment \lstinline|\version{x.xx}|. + \item \textit{How to remove the information of date?}\\ + Please type in \lstinline|\date{}|. + \item \textit{How to add several authors?}\\ + Use \lstinline{\and} in \lstinline{\author} and use \lstinline{\\} to start a new line. + \begin{lstlisting} + \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} +\end{enumerate} + +\section{Minimal Example} +A minimal example is as follows: \begin{lstlisting} -\documentclass[lang=en]{elegantpaper} +\documentclass[a4paper,11pt]{elegantpaper} % title information -\title{A Working Paper Example} -\author{ddswhu} +\title{Working Paper Example} +\author{Author Name} \institute{Elegant\LaTeX{} Group} + \version{1.00} \date{\today} @@ -175,18 +169,12 @@ The content of introduction section. \section{Conclusion} The content of conclusion section. -% include the noncited reference -\nocite{ref1, ref2} -\bibliographystyle{aer} \bibliography{wpref} + \end{document} \end{lstlisting} \nocite{en1,en2} - -% If you want change the bibliography style, replace aer with the prefered one. -\bibliographystyle{aer} - \bibliography{wpref} \end{document} diff --git a/Master/texmf-dist/doc/latex/elegantpaper/figure/ElegantLaTeX.png b/Master/texmf-dist/doc/latex/elegantpaper/figure/ElegantLaTeX.png Binary files differdeleted file mode 100644 index 1252e91ece0..00000000000 --- a/Master/texmf-dist/doc/latex/elegantpaper/figure/ElegantLaTeX.png +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.pdf b/Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.pdf Binary files differdeleted file mode 100644 index b217cdc055f..00000000000 --- a/Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.py b/Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.py deleted file mode 100644 index 576e6b07df0..00000000000 --- a/Master/texmf-dist/doc/latex/elegantpaper/figure/scatter.py +++ /dev/null @@ -1,27 +0,0 @@ -# This file is the source file of the scatter.pdf -# source page: https://matplotlib.org/gallery/shapes_and_collections/scatter.html -import numpy as np -import matplotlib.pyplot as plt - -# Fixing random state for reproducibility -np.random.seed(19680801) - - -N = 50 -x = np.random.rand(N) -y = np.random.rand(N) -colors = np.random.rand(N) -area = (30 * np.random.rand(N))**2 # 0 to 15 point radii - -ax = plt.subplot(111) -ax.scatter(x, y, s=area, c=colors, alpha=0.5) - -# Hide the right and top spines -ax.spines['right'].set_visible(False) -ax.spines['top'].set_visible(False) - -# Only show ticks on the left and bottom spines -ax.yaxis.set_ticks_position('left') -ax.xaxis.set_ticks_position('bottom') - -plt.savefig('scatter.pdf', transparent=True) diff --git a/Master/texmf-dist/doc/latex/elegantpaper/image/donate.jpg b/Master/texmf-dist/doc/latex/elegantpaper/image/donate.jpg Binary files differnew file mode 100644 index 00000000000..60741efcdee --- /dev/null +++ b/Master/texmf-dist/doc/latex/elegantpaper/image/donate.jpg diff --git a/Master/texmf-dist/doc/latex/elegantpaper/image/star.png b/Master/texmf-dist/doc/latex/elegantpaper/image/star.png Binary files differnew file mode 100644 index 00000000000..2d736ac2b37 --- /dev/null +++ b/Master/texmf-dist/doc/latex/elegantpaper/image/star.png diff --git a/Master/texmf-dist/doc/latex/elegantpaper/wpref.bib b/Master/texmf-dist/doc/latex/elegantpaper/wpref.bib index fd2c1192609..c4870395f21 100644 --- a/Master/texmf-dist/doc/latex/elegantpaper/wpref.bib +++ b/Master/texmf-dist/doc/latex/elegantpaper/wpref.bib @@ -34,6 +34,7 @@ @article{cn1, author = {方军雄}, + key = {fang1 jun1 xiong2}, title = {{所有制、制度环境与信贷资金配置}}, journal = {经济研究}, number = {12}, @@ -45,6 +46,7 @@ @article{cn2, author = {刘凤良 and 章潇萌 and 于泽}, + key = {liu2 feng4 liang2 zhang1 xiao1 meng2 yu2 ze2}, title = {{高投资、结构失衡与价格指数二元分化}}, journal = {金融研究}, number = {02}, @@ -56,6 +58,7 @@ @article{cn3, author = {吕捷 and 王高望}, + key = {lv3 jie2 wang2 gao1 wang4}, title = {{CPI 与 PPI “背离”的结构性解释}}, journal = {经济研究}, volume = {50}, |
