Skip to content

Commit

Permalink
v0.03
Browse files Browse the repository at this point in the history
  • Loading branch information
EthanDeng committed Jan 15, 2019
1 parent 8242ffe commit 0351167
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 36 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ ElegantPaper is designed for writing a working paper, especially for economics s
other templates designed by ElegantLATEX Group? Please visit: [ElegantLaTeX Resource](https://ddswhu.me/resource/).


此模板基于 LaTeX 的 article 类,专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式,专心写作,从而有更加舒适,简便的写作体验。我是 ddswhu,如果你有其他问题或者建议,请联系我,我的邮箱是:ddswhu@outlook.com。如果你想了解更多由 ElegantLATEX 项目组设计的模板,请访问 [ElegantLaTeX 资源中心](https://ddswhu.me/resource/)
此模板基于 LaTeX 的 article 类,专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式,专心写作,从而有更加舒适,简便的写作体验。我是 ddswhu,如果你有其他问题或者建议,请联系我,我的邮箱是:ddswhu@outlook.com。如果你想了解更多由 ElegantLaTeX 项目组设计的模板,请访问 [ElegantLaTeX 资源中心](https://ddswhu.me/resource/)

This work is released under the LaTeX Project Public License, v1.3c or later.
Binary file modified elegantpaper-cn.pdf
Binary file not shown.
33 changes: 16 additions & 17 deletions elegantpaper-cn.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\author{\href{https://ddswhu.me/}{邓 东 升}}

\institute{Elegant\LaTeX{} 项目组}
\version{0.02}
\version{0.03}
\date{\today}


Expand All @@ -16,32 +16,31 @@
\maketitle

\begin{abstract}
\noindent \itshape 本文为 ElegantPaper 的说明文档(中文)。此模板基于 \LaTeX{} 的 article 类,专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式,专心写作,从而有更加舒适,简便的写作体验。如果你有其他问题或者建议,请联系我,我的邮箱是:\email{ddswhu@outlook.com}。如果你想了解更多由 Elegant\LaTeX{} 项目组设计的模板,请访问 \href{https://ddswhu.me/resource/}{Elegant\LaTeX{} 资源中心}。
\noindent \sffamily 本文为 ElegantPaper 的说明文档(中文)。此模板基于 \LaTeX{} 的 article 类,专为工作论文写作而设计。设计这个模板的初衷是让作者不用关心工作论文的格式,专心写作,从而有更加舒适,简便的写作体验。如果你有其他问题或者建议,请联系我,我的邮箱是:\email{ddswhu@outlook.com}。如果你想了解更多由 Elegant\LaTeX{} 项目组设计的模板,请访问 \href{https://ddswhu.me/resource/}{Elegant\LaTeX{} 资源中心}。
\end{abstract}

\section{模板介绍}

此模板是基于 \LaTeX{} 的标准文档类设计,也即意味着你可以在在文类选项使用文档(article)类型的选项,比如 \texttt{a4paper, 12pt} 等等。本模板支持 \lstinline{pdflatex} 和 \lstinline{xelatex} 两种编译方式。
此模板是基于 \LaTeX{} 的标准文档类设计,也即意味着你可以在在文类选项使用文档(article)类型的选项,比如 \texttt{a4paper, 12pt} 等等。本模板支持 \lstinline{PDFLaTeX} 和 \lstinline{XeLaTeX} 两种编译方式。

\subsection{全局选项}
我在这个模板中定义了一个语言选项 \lstinline{lang},可以选择英文模式 \lstinline{lange=en}(默认)或者中文模式 \lstinline{lang=cn}。当选择中文模式时,图表的标题引导词以及参考文献,定理引导词等信息会变成中文。你可以通过下面两种方式来选择语言模式:

我在这个模板中定义了一个语言选项 \lstinline{lang},可以选择英文模式 \lstinline{lang=en}(默认)或者中文模式 \lstinline{lang=cn}。当选择中文模式时,图表的标题引导词以及参考文献,定理引导词等信息会变成中文。你可以通过下面两种方式来选择语言模式:
\begin{lstlisting}
\documentclass[lang=cn]{elegantpaper}
\documentclass{cn}{elegantpaper} % 两者皆可
\end{lstlisting}

\subsection{字体设置}
\noindent\textbf{选择 PDFLaTeX 编译:} 如果你使用 PDFLaTeX 编译,默认的 Computer Modern 字体被换成了 \lstinline{newtx} 系列字体,默认的字体字号是 11 pt。关于字体设置的宏包主要用到了

\subsubsection{选择 \lstinline{PDFLaTeX} 编译}
如果你使用 \lstinline{PDFLaTeX} 编译,默认的 Computer Modern 字体被换成了 \lstinline{newtx} 系列字体,默认的字体字号是 11 pt。关于字体设置的宏包主要用到了:
\begin{itemize}
\item \lstinline{newtxtext} 用于文档正文字体,类似于 Times New Roman 字体。
\item \lstinline{newtxmath} 用于数学字体,搭配 \lstinline{newtx} 非常合适,类似于过时的 \lstinline{times} 宏包的效果。
\item \lstinline{newtxtt} 用于打字机字体, 并使用了 \lstinline{scale=0.8} 选项缩放字体。
\item \lstinline{ctex} 用于中文字体设置,并使用了 \lstinline{scheme=plain} 选项。
\end{itemize}

\noindent\textbf{选择 XeLaTeX 编译}
\subsubsection{选择 \lstinline{XeLaTeX} 编译}
如果你选择 \lstinline{XeLaTeX} 编译的话,那么设置字体的宏包为 \lstinline{fontspec} 和 \lstinline{xeCJK}。由于模板中使用的字体是 Windows 中的字体,所以如果你使用其他操作系统,比如 Linux 或者 Mac OS,那么你需要把所用字体替换为你系统中的字体。设置字体的命令:

\begin{lstlisting}
Expand All @@ -59,27 +58,29 @@ \subsection{字体设置}
\DeclareSymbolFont{operators}{\encodingdefault}{\familydefault}{m}{n}
\end{lstlisting}

\subsubsection{其他设置}

这几个包由于都是一个系列的,字体搭配起来非常合适,字体宽度非常契合!唯独数学字体中的大型运算符,比如求和符号和积分符号不是很好看,为此,我把它们又改回了原先的字体效果。公式~(\ref{eq:binom}) 展示了最终的数学字体的效果。
\begin{equation}
(a+3b)^{n} = \sum_{k=0}^{n} C_{n}^{k} a^{n-k} (3b)^k \label{eq:binom}
\end{equation}

我把行距设定为 1.3,并且使用了 \lstinline{microtype} 包调整字体的间距,为了去除字体字号,字形警告信息,我使用了 \lstinline{type1cm}。
我把行距设定为 1.3,并且使用了 \lstinline{microtype} 宏包调整字体的间距,为了去除字体字号,字形警告信息,我使用了 \lstinline{type1cm} 宏包


\subsection{自定义命令}
在此模板中,并没有修改任何默认的命令或者环境,所以,你可以在此模板使用原来的命令和环境。另外,我自定义了 3 个命令:

\begin{enumerate}
\item \lstinline{\email}: 创建邮箱地址的链接;
\item \lstinline{\figref}: 用法和 \lstinline{\ref} 类似,但是会在插图的标题前添加 <\textbf{图 n}>
\item \lstinline{\tabref}: 用法和 \lstinline{\ref} 类似,但是会在表格的标题前添加 <\textbf{表 n}>.
\item \lstinline{\figref}: 用法和 \lstinline{\ref} 类似,但是会在插图的标题前添加 <\textbf{图 n}>
\item \lstinline{\tabref}: 用法和 \lstinline{\ref} 类似,但是会在表格的标题前添加 <\textbf{表 n}>
\end{enumerate}{}



\subsection{列表环境}
你可以使用列表环境(\lstinline{itemize}、\lstinline{enumerate}、\lstinline{description},示例如下\\[2ex]
你可以使用列表环境(\lstinline{itemize}、\lstinline{enumerate}、\lstinline{description},示例如下\\[2ex]
\begin{minipage}[c]{0.51\linewidth}
\begin{lstlisting}
\begin{itemize}
Expand Down Expand Up @@ -179,13 +180,13 @@ \subsection{参考文献}


\section{示例}
在这部分,我们将给出一个示例文档
在这部分,我提供一个示例文档

\begin{lstlisting}
\documentclass[lang=cn]{elegantpaper}

% 标题信息
\title[lang=en]{工作论文示例展示}
\title{工作论文示例展示}
\author{ddswhu}
\institute{Elegant\LaTeX{} 项目组}
\version{1.00}
Expand All @@ -200,12 +201,10 @@ \section{示例}
\end{abstract}

\section{引言}

这一部分是引言的内容。

\section{结论}

这是结论部分
这是结论部分。

% 在参考文献部分显示未引用的文献
\nocite{ref1, ref2}
Expand Down
Binary file modified elegantpaper-en.pdf
Binary file not shown.
27 changes: 13 additions & 14 deletions elegantpaper-en.tex
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
%!TEX program = pdflatex
\documentclass[en]{elegantpaper}

\title{ElegantPaper: An Elegant \LaTeX{} Template for Working Paper}
\title{ElegantPaper: An Elegant \LaTeX{} Template for Working Papers}
\author{\href{https://ddswhu.me/}{Dongsheng Deng}}
\institute{Elegant\LaTeX{} Program}
\version{0.02}
\version{0.03}
\date{\today}


Expand All @@ -13,12 +13,12 @@
\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}.
\sffamily 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}.
\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
Expand All @@ -29,16 +29,17 @@ \subsection{Global Options}
\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 \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{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 \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}
Expand All @@ -55,7 +56,7 @@ \subsection{Font Settings}
\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}
Expand Down Expand Up @@ -180,7 +181,7 @@ \section{A Minimal Example}
\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}
Expand All @@ -195,20 +196,18 @@ \section{A Minimal Example}
\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}
\bibliography{wpref}
\end{document}
\end{lstlisting}

\nocite{EINAV2010,Havrylchyk2018}
\nocite{EINAV2010, Havrylchyk2018}
\bibliography{wpref}

\end{document}
8 changes: 4 additions & 4 deletions elegantpaper.cls
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
% Current Version: 0.02
% Current Version: 0.03
% Author: ddswhu
% Homepage: https://ddswhu.me/
% Email: ddswhu@outlook.com
% Lastest Version: https://github.com/EthanDeng/ElegantPaper

\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{elegantpaper}[2018/1/12 v0.02 ElegantLaTeX Paper class]
\ProvidesClass{elegantpaper}[2018/1/13 v0.03 ElegantLaTeX Paper class]

\LoadClass[11pt]{article}

Expand Down Expand Up @@ -209,9 +209,9 @@
breaklines=true,
keywordstyle=\bf\color{winered}\ttfamily,
commentstyle=\color{gray},
emph={elegantpaper,fontenc,fontspec,xeCJK,xunicode,newtxmath,figure,fig,image,img,table,itemize,enumerate,newtxtext,newtxtt,ctex,microtype,description,times,newtx,booktabs,tabular},
emph={elegantpaper,fontenc,fontspec,xeCJK,xunicode,newtxmath,figure,fig,image,img,table,itemize,enumerate,newtxtext,newtxtt,ctex,microtype,description,times,newtx,booktabs,tabular,PDFLaTeX,XeLaTeX,type1cm},
emphstyle={\color{frenchplum}},
morekeywords={DeclareSymbolFont,toprule,midrule,bottomrule,institute,version,includegraphics,setmainfont,setsansfont,setmonofont ,setCJKmainfont,setCJKsansfont,setCJKmonofont,RequirePackage,figref,tabref,email},
morekeywords={DeclareSymbolFont,toprule,midrule,bottomrule,institute,version,includegraphics,setmainfont,setsansfont,setmonofont ,setCJKmainfont,setCJKsansfont,setCJKmonofont,RequirePackage,figref,tabref,email,maketitle},
frame=none,
tabsize=2,
backgroundcolor=\color{lightgrey}
Expand Down

0 comments on commit 0351167

Please sign in to comment.