v0.5 ElegantPaper

README.md

@@ -1,4 +1,4 @@
-<!-- Author: ddswhu -->
+<!-- Author: Dongsheng Deng -->
 <!-- Email: ddswhu@outlook.com -->
 <!-- Homepage: https://ddswhu.me/ -->
 <!-- Program Email: elegantlatex2e@gmail.com -->

elegantpaper-cn.tex

@@ -2,10 +2,10 @@
 \documentclass[lang=cn]{elegantpaper}
 
 \title{ElegantPaper: 一个优美的 \LaTeX{} 工作论文模板}
-\author{\href{https://ddswhu.me/}{邓 东 升}}
+\author{\href{https://ddswhu.me/}{邓 东 升}\thanks{感谢 Peiyi Yao 的帮助与建议。}}
 
-\institute{\href{https://github.com/ElegantLaTeX/}{Elegant\LaTeX{} 项目组}}
+\institute{\href{https://elegantlatex.org/}{Elegant\LaTeX{} 项目组}}
-\version{0.04}
+\version{0.05}
 \date{\today}
 
 
@@ -15,11 +15,12 @@
 
 \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/}。
+\keywords{Elegant\LaTeX{}，工作论文，模板}
 \end{abstract}
 
 \section{模板介绍}
 
-此模板是基于 \LaTeX{} 的标准文档类设计，也即意味着你可以在在文类选项使用文档（article）类型的选项，比如 \texttt{a4paper, 12pt} 等等。本模板支持 \lstinline{PDFLaTeX} 和 \lstinline{XeLaTeX} 两种编译方式。
+此模板是基于 \LaTeX{} 的标准文档类设计，也即意味着你可以在在文类选项使用文档（article）类型的选项，比如 \lstinline{a4paper, 12pt} 等等。本模板支持 \lstinline{PDFLaTeX} 和 \lstinline{XeLaTeX} 两种编译方式。
       
 \subsection{全局选项}
 我在这个模板中定义了一个语言选项 \lstinline{lang}，可以选择英文模式 \lstinline{lang=en}（默认）或者中文模式 \lstinline{lang=cn}。当选择中文模式时，图表的标题引导词以及参考文献，定理引导词等信息会变成中文。你可以通过下面两种方式来选择语言模式：
@@ -29,23 +30,22 @@
 \end{lstlisting}
 
 \subsection{字体设置}
-\subsubsection{选择 \lstinline{PDFLaTeX} 编译}
+\subsubsection[选择 PDFLaTeX 编译]{选择 \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{FiraMono} 用于打字机字体。
+	\item \lstinline{FiraMono} 用于打字机字体，并使用了 \lstinline{scale=0.8} 选项。
 	\item \lstinline{ctex} 用于中文字体设置，并使用了 \lstinline{scheme=plain} 选项。
 \end{itemize}
 
-\subsubsection{选择 \lstinline{XeLaTeX} 编译}
+\subsubsection[选择 XeLaTeX 编译]{选择 \lstinline{XeLaTeX} 编译}
 如果你选择 \lstinline{XeLaTeX} 编译的话，那么设置字体的宏包为 \lstinline{fontspec} 和 \lstinline{xeCJK}。由于模板中使用的字体是 Windows 中的字体，所以如果你使用其他操作系统，比如 Linux 或者 Mac OS，那么你需要把所用字体替换为你系统中的字体。设置字体的命令：
 
 \begin{lstlisting}
 \RequirePackage{fontenc}
 \RequirePackage[no-math]{fontspec}
-\setmainfont{Times New Roman}
+\setmainfont{Times New Roman}[NFSSFamily=ntxtlf]
-%\setmainfont{Times New Roman}[NFSSFamily=ntxtlf]
 \setsansfont{Arial}
 %\setmonofont[Scale=0.9]{Courier New}
 \RequirePackage{xeCJK}
@@ -53,9 +53,9 @@
 \setCJKmainfont[BoldFont={SimHei},ItalicFont={KaiTi}]{SimSun}
 \setCJKsansfont[BoldFont={SimHei},ItalicFont={KaiTi}]{KaiTi}
 \setCJKmonofont[BoldFont={SimHei},ItalicFont={KaiTi},Scale=0.9]{Microsoft YaHei}
+\XeTeXlinebreaklocale "zh"
+\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
 \RequirePackage{newtxmath}
-\DeclareSymbolFont{operators}{OT1}{ntxtlf}{m}{n}
-\SetSymbolFont{operators}{bold}{OT1}{ntxtlf}{b}{n}
 \end{lstlisting}
 
 \subsubsection{其他设置}
@@ -72,10 +72,11 @@
 在此模板中，并没有修改任何默认的命令或者环境，所以，你可以在此模板使用原来的命令和环境。另外，我自定义了 3 个命令：
 
 \begin{enumerate}
-	\item \lstinline{\email}: 创建邮箱地址的链接；
+	\item \lstinline{\email}：创建邮箱地址的链接；
-	\item \lstinline{\figref}: 用法和 \lstinline{\ref} 类似，但是会在插图的标题前添加 <\textbf{图 n}> ；
+	\item \lstinline{\figref}：用法和 \lstinline{\ref} 类似，但是会在插图的标题前添加 <\textbf{图 n}> ；
-	\item \lstinline{\tabref}: 用法和 \lstinline{\ref} 类似，但是会在表格的标题前添加 <\textbf{表 n}>。
+	\item \lstinline{\tabref}：用法和 \lstinline{\ref} 类似，但是会在表格的标题前添加 <\textbf{表 n}>；
-\end{enumerate}{}
+	\item \lstinline{\keywords}：为摘要环境添加关键词。
+\end{enumerate}
 
 
 
@@ -203,6 +204,7 @@
 
 \begin{abstract}
 在这里写摘要。
+\keywords{关键词1，关键词2}
 \end{abstract}
 
 \section{引言}

elegantpaper-en.tex

@@ -2,9 +2,9 @@
 \documentclass[en]{elegantpaper}
 
 \title{ElegantPaper: An Elegant \LaTeX{} Template for Working Papers}
-\author{\href{https://ddswhu.me/}{Dongsheng Deng}}
+\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.04}
+\version{0.05}
 \date{\today}
 
 
@@ -13,9 +13,11 @@
 \maketitle
 
 \begin{abstract}
-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}.
+\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}. 
@@ -29,31 +31,32 @@ I defined one option named \lstinline{lang}, this option has two alternative val
 \end{lstlisting}
 
 \subsection{Font Settings}
-\subsubsection{Compile with \lstinline{PDFLaTeX}}
+\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{FiraMono} package for typewriter fonts.
+	\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}
 
-\subsubsection{Compile with \lstinline{XeLaTeX}}
+\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.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}
@@ -73,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}
@@ -101,7 +105,7 @@ I strongly recommend you to use the \lstinline{booktabs} package in your paper.
 \begin{table}[htbp]
   \small
   \centering
-  \caption{Auto MPG and Price}
+  \caption{Auto MPG and Price \label{tab:reg}}
     \begin{tabular}{lcc}
     \toprule
                     &       (1)         &        (2)      \\
@@ -118,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)      \\
@@ -141,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}%
 
 
@@ -190,6 +192,7 @@ In this section, we give a simple example using this template.
 
 \begin{abstract}
 Your abstract goes here.
+\keywords{keyword1, keyword2}
 \end{abstract}
 
 \section{Introduction}

elegantpaper.cls

@@ -1,11 +1,11 @@
-% Current Version: 0.04
+% Current Version: 0.05
-% Author: ddswhu
+% Author: Dongsheng Deng
 % Homepage: https://ddswhu.me/
-% Email: ddswhu@outlook.com
+% Email: elegantlatex2e@gmail.com
-% Lastest Version: https://github.com/EthanDeng/ElegantPaper
+% Lastest Version: https://github.com/ElegantLaTeX/ElegantPaper
 
 \NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{elegantpaper}[2018/01/16 v0.04 ElegantLaTeX Paper class]
+\ProvidesClass{elegantpaper}[2019/02/01 v0.05 ElegantLaTeX Paper class]
   
 \LoadClass[11pt]{article}
 
@@ -32,7 +32,7 @@
 % font setting for text and math
 
 \RequirePackage{amsthm}
-\RequirePackage{amsmath,amssymb,accents}
+\RequirePackage{amsmath,amssymb}
 %\RequirePackage{newtxtext}
 %\RequirePackage{newtxmath}
 %  
@@ -42,6 +42,8 @@
 % more pretty font
 \linespread{1.3}
 
+
+
 % indentation, table and figure package
 \RequirePackage{indentfirst}
 \RequirePackage{booktabs}
@@ -51,7 +53,7 @@
 \RequirePackage{fancyvrb}
 \RequirePackage{type1cm}
 \RequirePackage{abstract}
-\renewcommand{\abstracttextfont}{\sffamily\small}
+
 \graphicspath{{image/}{figure/}{fig/}{img/}}
 
 % caption settings 
@@ -94,7 +96,7 @@
 \ifxetex
 	\RequirePackage{fontenc}
 	\RequirePackage[no-math]{fontspec}
-	\setmainfont{Times New Roman}
+	\setmainfont{Times New Roman}[NFSSFamily=ntxtlf]
 	\setsansfont{Arial}
 	%\setmonofont[Scale=0.9]{Courier New}
 	\RequirePackage{xeCJK}
@@ -105,16 +107,23 @@
 	\XeTeXlinebreaklocale "zh"
 	\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
 	\RequirePackage{newtxmath}
-	\DeclareSymbolFont{operators}{OT1}{ntxtlf}{m}{n}
+	%\DeclareSymbolFont{operators}{OT1}{ntxtlf}{m}{n}
-	\SetSymbolFont{operators}{bold}{OT1}{ntxtlf}{b}{n}
+	%\SetSymbolFont{operators}{bold}{OT1}{ntxtlf}{b}{n}
+	\setCJKfamilyfont{zhsong}{SimSun}
+	\setCJKfamilyfont{zhhei}{SimHei}
+	\setCJKfamilyfont{zhkai}{KaiTi}
+	\setCJKfamilyfont{zhfs}{FangSong}
+	\newcommand*{\songti}{\CJKfamily{zhsong}} 
+	\newcommand*{\heiti}{\CJKfamily{zhhei}}   
+	\newcommand*{\kaishu}{\CJKfamily{zhkai}} 
+	\newcommand*{\fangsong}{\CJKfamily{zhfs}} 
 \else
 	\RequirePackage{fontenc}
 	\RequirePackage{newtxtext}
 	\RequirePackage{newtxmath}
 	\RequirePackage[UTF8, scheme=plain]{ctex}
 \fi
-\RequirePackage{FiraMono}
+\RequirePackage[scale=0.8]{FiraMono}
-%
 
 \ifdefstring{\ELEGANT@lang}{cn}{
   	\theoremstyle{plain}% default
@@ -139,6 +148,8 @@
 	\newcommand\updatetext{最后更新：}%
 	\renewcommand\abstractname{摘\hspace{2em}要}
 	\setlength{\parindent}{2em}
+	\renewcommand{\abstracttextfont}{\kaishu\sffamily\small}
+	\newcommand{\keywords}[1]{\vskip2ex\par\noindent\normalfont{\bfseries 关键词: } #1}
 }{\relax}
 \ifdefstring{\ELEGANT@lang}{en}{
   \theoremstyle{plain}% default
@@ -157,12 +168,49 @@
 	\renewcommand*{\proofname}{\normalfont\bfseries\color{ecolor}Proof}%
 	\newcommand\versiontext{Version: }%
 	\newcommand\updatetext{Last update: }%
+	\renewcommand{\abstracttextfont}{\sffamily\small}
+	\newcommand{\keywords}[1]{\vskip2ex\par\noindent\normalfont{\bfseries Keywords: } #1}
 }{\relax}
 
+\AtBeginEnvironment{verbatim}{\microtypesetup{activate=false}}
 
 \newtoks\version
 \newtoks\institute
-\def\maketitle{%
+
+\renewcommand\maketitle{\par
+  \begingroup
+    \renewcommand\thefootnote{\@fnsymbol\c@footnote}%
+    \def\@makefnmark{\rlap{\@textsuperscript{\normalfont\@thefnmark}}}%
+    \long\def\@makefntext##1{\parindent 1em\noindent
+            \hb@xt@1.8em{%
+                \hss\@textsuperscript{\normalfont\@thefnmark}}##1}%
+    \if@twocolumn
+      \ifnum \col@number=\@ne
+        \@maketitle
+      \else
+        \twocolumn[\@maketitle]%
+      \fi
+    \else
+      \newpage
+      \global\@topnum\z@   % Prevents figures from going at top of page.
+      \@maketitle
+    \fi
+    \thispagestyle{plain}\@thanks
+  \endgroup
+  \setcounter{footnote}{0}%
+  \global\let\thanks\relax
+  \global\let\maketitle\relax
+  \global\let\@maketitle\relax
+  \global\let\@thanks\@empty
+  \global\let\@author\@empty
+  \global\let\@date\@empty
+  \global\let\@title\@empty
+  \global\let\title\relax
+  \global\let\author\relax
+  \global\let\date\relax
+  \global\let\and\relax
+}
+\def\@maketitle{%
   \newpage
   \null
   \vskip 2em%
@@ -184,6 +232,8 @@
   \par
   \vskip 1.5em}
   
+
+
 \DeclareSymbolFont{cmlargesymbols}{OMX}{cmex}{m}{n}
 \DeclareMathSymbol{\intop}{\mathop}{cmlargesymbols}{"5A}
   \def\int{\intop\nolimits}
@@ -210,13 +260,14 @@
 	breaklines=true,
 	keywordstyle=\bf\color{winered}\ttfamily,
 	commentstyle=\color{gray},
-	emph={elegantpaper,fontenc,fontspec,xeCJK,FiraMono,xunicode,newtxmath,figure,fig,image,img,table,itemize,enumerate,newtxtext,newtxtt,ctex,microtype,description,times,newtx,booktabs,tabular,PDFLaTeX,XeLaTeX,type1cm},
+	emph={elegantpaper,fontenc,fontspec,xeCJK,FiraMono,xunicode,newtxmath,figure,fig,image,img,table,itemize,enumerate,newtxtext,newtxtt,ctex,microtype,description,times,newtx,booktabs,tabular,PDFLaTeX,XeLaTeX,type1cm,BibTeX},
 	emphstyle={\color{frenchplum}},
-	morekeywords={DeclareSymbolFont,SetSymbolFont,toprule,midrule,bottomrule,institute,version,includegraphics,setmainfont,setsansfont,setmonofont ,setCJKmainfont,setCJKsansfont,setCJKmonofont,RequirePackage,figref,tabref,email,maketitle},
+	morekeywords={DeclareSymbolFont,SetSymbolFont,toprule,midrule,bottomrule,institute,version,includegraphics,setmainfont,setsansfont,setmonofont ,setCJKmainfont,setCJKsansfont,setCJKmonofont,RequirePackage,figref,tabref,email,maketitle,keywords},
 	frame=none,
 	tabsize=2,
 	backgroundcolor=\color{lightgrey}
 }
 
-
 \bibliographystyle{aer}
+
+