From d39de1e186a554cd90262dacfd65bb74f9eb818e Mon Sep 17 00:00:00 2001 From: EthanDeng Date: Tue, 5 Feb 2019 11:50:05 +0800 Subject: [PATCH] paper wiki --- Bibliography.md | 8 + CustomCommands.md | 6 + FontSettings.md | 34 +++ Graphics.md | 10 + ElegantPaper-Wiki.md => Home.md | 13 +- Installation.md | 38 +++ Introduction.md | 1 + Languages.md | 7 + License | 416 ++++++++++++++++++++++++++++++++ Lists.md | 13 + MinimalExample.md | 33 +++ Tables.md | 26 ++ _Sidebar.md | 44 ++++ 列表环境.md | 15 ++ 参考文献.md | 7 + 字体设置.md | 35 +++ 安装说明.md | 35 +++ 插入图片.md | 11 + 插入表格.md | 26 ++ 最小示例.md | 35 +++ 模板介绍.md | 2 + 自定义命令.md | 7 + 语言模式.md | 8 + 23 files changed, 825 insertions(+), 5 deletions(-) create mode 100644 Bibliography.md create mode 100644 CustomCommands.md create mode 100644 FontSettings.md create mode 100644 Graphics.md rename ElegantPaper-Wiki.md => Home.md (60%) create mode 100644 Installation.md create mode 100644 Introduction.md create mode 100644 Languages.md create mode 100644 License create mode 100644 Lists.md create mode 100644 MinimalExample.md create mode 100644 Tables.md create mode 100644 _Sidebar.md create mode 100644 列表环境.md create mode 100644 参考文献.md create mode 100644 字体设置.md create mode 100644 安装说明.md create mode 100644 插入图片.md create mode 100644 插入表格.md create mode 100644 最小示例.md create mode 100644 模板介绍.md create mode 100644 自定义命令.md create mode 100644 语言模式.md diff --git a/Bibliography.md b/Bibliography.md new file mode 100644 index 0000000..2409d37 --- /dev/null +++ b/Bibliography.md @@ -0,0 +1,8 @@ +This template uses `BibTeX` to generate the bibliography, the default bibliography style is `aer` . Let’s take a glance at the citation effect, Chen et al. (2018) 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 `BibTeX`, you must create a file named `wpref.bib` , and add bib items (from Google Scholar, Mendeley, EndNote, and etc.) to `wpref.bib` file, and cite the bibkey in the `tex` file. The `BibTeX` 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 + +```tex +\nocite{EINAV2010, Havrylchyk2018} +``` diff --git a/CustomCommands.md b/CustomCommands.md new file mode 100644 index 0000000..bb8a90c --- /dev/null +++ b/CustomCommands.md @@ -0,0 +1,6 @@ +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 4 commands + +1. `\email`: create the hyperlink to email address. +2. `\figref`: same usage as `\ref`, but start with label text __Figure n__. +3. `\tabref`: same usage as `\ref`, but start with label text __Table n__. +4. `\keywords`: create the keywords in the abstract section. diff --git a/FontSettings.md b/FontSettings.md new file mode 100644 index 0000000..95adf79 --- /dev/null +++ b/FontSettings.md @@ -0,0 +1,34 @@ +## Compile with `PDFLaTeX` + +If you choose `PDFLaTeX` to process your paper, the default article font computer modern has changed to `newtx` series, and the default font size is set to `11pt` . The fonts are settings with: + ++ `newtxtext` package for text fonts, similar to times new roman font. ++ `newtxmath` package for math fonts, close to `times` package. ++ `FiraMono` package for typewriter fonts, with option `scale=0.8` . ++ `ctex` package for Chinese fonts, with option `scheme=plain` . + +## Compile with `XeLaTeX` + +If you choose `XeLaTeX` to process your paper, I use `fontspec` package and `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 + +```tex +\RequirePackage{fontenc} +\RequirePackage[no-math]{fontspec} +\setmainfont{Times New Roman}[NFSSFamily=ntxtlf] +\setsansfont{Arial} +%\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} +``` + +## Other Settings + +These packages operate perfectly but are inappropriate for big operators, for example `\sum` and `\prod`, thus, I change these operators back to computer modern font. + +The `\linespread` (controls line spacing) is set to 1.3, and I use `microtype` to improve the font justification. `type1cm` package is used to remove the font shape and font size warning messages. diff --git a/Graphics.md b/Graphics.md new file mode 100644 index 0000000..66a9828 --- /dev/null +++ b/Graphics.md @@ -0,0 +1,10 @@ +To include a graphic, you can use `figure` environment as usual. You can put all +your images in the sub directories ( `./image/` , `./img/` , `./figure/` , `./fig/` ) of your current working directory. + +```tex +\begin{figure}[htbp] + \centering + \includegraphics[width=0.6\textwidth]{scatter.pdf} + \caption{Scatter Plot Example \label{fig:scatter}} +\end{figure} +``` diff --git a/ElegantPaper-Wiki.md b/Home.md similarity index 60% rename from ElegantPaper-Wiki.md rename to Home.md index c6f7605..30d19ef 100644 --- a/ElegantPaper-Wiki.md +++ b/Home.md @@ -1,17 +1,20 @@ -[Homepage](https://elegantlatex.org/) | [Github](https://github.com/ElegantLaTeX/ElegantNote) | [CTAN](https://ctan.org/pkg/elegantnote) | [Wiki](https://github.com/ElegantLaTeX/ElegantNote/wiki) | [Weibo](https://weibo.com/elegantlatex) +# ElegantNote Wiki + +[Homepage](https://elegantlatex.org/) | [Github](https://github.com/ElegantLaTeX/ElegantNote) | [CTAN](https://ctan.org/pkg/elegantnote) | [Download](https://github.com/ElegantLaTeX/ElegantNote/releases) | [Wiki](https://github.com/ElegantLaTeX/ElegantNote/wiki) | [Weibo](https://weibo.com/elegantlatex) ![License](https://img.shields.io/ctan/l/elegantnote.svg) ![CTAN Version](https://img.shields.io/ctan/v/elegantnote.svg) ![Github Version](https://img.shields.io/github/release/ElegantLaTeX/ElegantNote.svg) ![Repo Size](https://img.shields.io/github/repo-size/ElegantLaTeX/ElegantNote.svg) +ElegantNote is designed for Notes. 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. -ElegantNote is designed for Notes. Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or pull requests or email us at elegantlatex2e@gmail.com. +设计 ElegantNote 是为了方便记录笔记和阅读笔记。如果你有其他问题、建议或者报告 bug，可以给提交 issues 或者给我们发邮件：elegantlatex2e@gmail.com。 - -设计 ElegantNote 是为了方便记录笔记和阅读笔记。如果你有其他问题、建议或者报告 bug，可以给提交 issues 或者提交补充或者给我们发邮件：elegantlatex2e@gmail.com。 +# License This work is released under the LaTeX Project Public License, v1.3c or later. -____ +本模板发布遵循 LaTeX 项目公共许可证 1.3 c 或更高版本。 +____ diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..eb81555 --- /dev/null +++ b/Installation.md @@ -0,0 +1,38 @@ +In this section, we will introduce the installation methods through cmd line or package manager of TeX Live 2018. + +## Cmd Line Method + +Run command line as administrator, the installation commands is + +```shell +tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet +tlmgr install elegantpaper +``` + +If you want to update or uninstall package, you can use + +```shell +tlmgr update elegantpaper +tlmgr uninstall elegantpaper +``` + +## Package Mananger Method + +Search tlmgr in windows, and open TeX Live Manager, + +![tlmgr](https://elegantlatex.org/image/tlmgr.png) + +click tlmgr and choose + +```shell +Load standard net repository: http://mirror.ctan.org/systems/texlive/tlnet +``` + +![tlmgr](https://elegantlatex.org/image/tlmgr-1.png) + +type the package name in the blank, and select the package you want to install/update/uninstall and click the action you wish. + +![tlmgr](https://elegantlatex.org/image/tlmgr-2.png) + +Complete. + diff --git a/Introduction.md b/Introduction.md new file mode 100644 index 0000000..a719edc --- /dev/null +++ b/Introduction.md @@ -0,0 +1 @@ +This template is based on the standard LaTeX `article` class, which means you can pass the arguments of article class to it (`a4paper`, `12pt` and etc.). It supports different engines, You can choose either `PDFLaTeX` or `XeLaTeX` . diff --git a/Languages.md b/Languages.md new file mode 100644 index 0000000..9fcd277 --- /dev/null +++ b/Languages.md @@ -0,0 +1,7 @@ +I defined one option named `lang`, this option has two alternative values, `lang=en` (default) or `lang=cn` . `lang=cn` will make the caption of figure/table, abstract name, refname etc. Chinese, while `lang=en` will keep all these +stuff English, as the default article class sets. You can use this option as + +```tex +\documentclass[lang=en]{elegantpaper} +\documentclass{en}{elegantpaper} % both ok +``` diff --git a/License b/License new file mode 100644 index 0000000..2244313 --- /dev/null +++ b/License @@ -0,0 +1,416 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 1999 2002-2008 LaTeX3 Project + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX Project Public License, either version 1.3 + % of this license or (at your option) any later version. + % The latest version of this license is in + % http://www.latex-project.org/lppl.txt + % and version 1.3 or later is part of all distributions of LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. + diff --git a/Lists.md b/Lists.md new file mode 100644 index 0000000..40e40dd --- /dev/null +++ b/Lists.md @@ -0,0 +1,13 @@ +You can use `itemize`, `enumerate`, or `description` environment as below + +```tex +\begin{itemize} + \item Routing and resource discovery; + \item Resilient and scalable networks; + \item Distributed storage and search. +\end{itemize} +``` + ++ Routing and resource discovery; ++ Resilient and scalable networks; ++ Distributed storage and search. diff --git a/MinimalExample.md b/MinimalExample.md new file mode 100644 index 0000000..bd43a10 --- /dev/null +++ b/MinimalExample.md @@ -0,0 +1,33 @@ +Here is a minimal example. + +```tex +\documentclass[lang=en]{elegantpaper} + +% title information +\title{A Working Paper Example} +\author{ddswhu} +\institute{Elegant\LaTeX{} Group} +\version{1.00} +\date{\today} + +\begin{document} + +\maketitle + +\begin{abstract} +Your abstract goes here. +\keywords{keyword1, keyword2} +\end{abstract} + +\section{Introduction} +The content of introduction section. + +\section{Conclusion} +The content of conclusion section. +% include the noncited reference + +\nocite{ref1, ref2} +\bibliography{wpref} + +\end{document} +``` diff --git a/Tables.md b/Tables.md new file mode 100644 index 0000000..e9b2fd1 --- /dev/null +++ b/Tables.md @@ -0,0 +1,26 @@ +I strongly recommend you to use the `booktabs` package in your paper. It adds three commands to make the table prettier, ie. `\toprule`, `\midrule` and `\bottomrule`. + +```tex +\begin{table}[htbp] + \small + \centering + \caption{燃油效率与汽⻋价格} + \begin{tabular}{lcc} + \toprule + & (1) & (2) \\ + \midrule + 燃油效率 & -238.90*** & -49.51 \\ + & (53.08) & (86.16) \\ + 汽车重量 & & 1.75*** \\ + & & (0.641) \\ + 常数项 & 11,253*** & 1,946 \\ + & (1,171) & (3,597) \\ + 观测数 & 74 & 74 \\ + $R^2$ & 0.220 & 0.293 \\ + \bottomrule + \multicolumn{3}{l}{\scriptsize 括号内为标准误} \\ + \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ + \end{tabular}% + \label{tab:reg}% +\end{table}% +``` diff --git a/_Sidebar.md b/_Sidebar.md new file mode 100644 index 0000000..c0278a1 --- /dev/null +++ b/_Sidebar.md @@ -0,0 +1,44 @@ +## 中文版本 + +* [模板介绍](https://github.com/ElegantLaTeX/ElegantPaper/wiki/模板介绍) +* 模板使用 + * [安装说明](https://github.com/ElegantLaTeX/ElegantPaper/wiki/安装说明) + * [语言模式](https://github.com/ElegantLaTeX/ElegantPaper/wiki/语言模式) + * [字体设置](https://github.com/ElegantLaTeX/ElegantPaper/wiki/字体设置) + * [自定义命令](https://github.com/ElegantLaTeX/ElegantPaper/wiki/自定义命令) + * [列表环境](https://github.com/ElegantLaTeX/ElegantPaper/wiki/列表环境) + * [插入图片](https://github.com/ElegantLaTeX/ElegantPaper/wiki/插入图片) + * [插入表格](https://github.com/ElegantLaTeX/ElegantPaper/wiki/插入表格) + * [参考文献](https://github.com/ElegantLaTeX/ElegantPaper/wiki/参考文献) +* [示例](https://github.com/ElegantLaTeX/ElegantPaper/wiki/最小示例) +* 作者 + * [Github](https://github.com/EthanDeng) + * [个人主页](https://ddswhu.me/) + + +## English Version + +* [Introduction](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Introduction) +* How to Use + * [Installation](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Installation) + * [Languages](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Languages) + * [FontSettings](https://github.com/ElegantLaTeX/ElegantPaper/wiki/FontSettings) + * [CustomCommands](https://github.com/ElegantLaTeX/ElegantPaper/wiki/CustomCommands) + * [Lists](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Lists) + * [Grapewfhics](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Graphics) + * [Tables](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Tables) + * [Bibliography](https://github.com/ElegantLaTeX/ElegantPaper/wiki/Bibliography) +* [Minimal Example](https://github.com/ElegantLaTeX/ElegantPaper/wiki/MinimalExample) +* Author + * [Github](https://github.com/EthanDeng) + * [Homepage](https://ddswhu.me/) + +## Links/相关链接 + +* [Github](https://github.com/ElegantLaTeX/ElegantPaper) +* [CTAN](https://ctan.org/pkg/elegantpaper) +* [Email](mailto:elegantlatex2e@gmail.com) +* [Issues](https://github.com/ElegantLaTeX/ElegantPaper/issues/new) +* [Pull Request](https://github.com/ElegantLaTeX/ElegantPaper/compare) +* [ElegantLaTeX](https://elegantlatex.org/) + diff --git a/列表环境.md b/列表环境.md new file mode 100644 index 0000000..eb92a92 --- /dev/null +++ b/列表环境.md @@ -0,0 +1,15 @@ +你可以和往常一样使用列表环境（`itemize`、`enumerate`、`description`），示例如下： + +```tex +\begin{itemize} + \item 春花秋月何时了, 往事知多少? + \item 小楼昨夜又东⻛, 故国不堪回首月明中。 + \item 雕栏玉砌应犹在, 只是朱颜改。 + \item 问君能有几多愁?恰似一江春水向东流。 +\end{itemize} +``` + ++ 春花秋月何时了, 往事知多少? ++ 小楼昨夜又东⻛, 故国不堪回首月明中。 ++ 雕栏玉砌应犹在, 只是朱颜改。 ++ 问君能有几多愁?恰似一江春水向东流。 diff --git a/参考文献.md b/参考文献.md new file mode 100644 index 0000000..d2945f6 --- /dev/null +++ b/参考文献.md @@ -0,0 +1,7 @@ +此模板使用了 `BibTeX` 来生成参考文献，默认使用的文献样式（bib style）是 `aer`。参考文献示例： Chen et al. (2018) 使用了中国一个大型的 P2P 平台（人人贷）的数据来检验男性投资者和女性投资者在投资表现上是否有显著差异。你可以在谷歌学术，Mendeley，Endnote 中获得文献条目（bib item），然后把它们添加到 `wpref.bib` 中。在文中引用的时候，引用它们的键值（bib key）即可。注意需要在编译的过程中添加 `BibTeX` 编译。如果你想在参考文献中添加未引用的文献，可以使用 + +```tex +\nocite{EINAV2010, Havrylchyk2018} +``` + +__注意：如果需要使用参考文献，请务必保证你的工作目录下有 wpref.bib 文件，如果没有，可以自行创建，然后把你的文献条目添加进去。__ diff --git a/字体设置.md b/字体设置.md new file mode 100644 index 0000000..40465c0 --- /dev/null +++ b/字体设置.md @@ -0,0 +1,35 @@ +本模板支持两种编译方式，`PDFLaTeX` 和 `XeLaTeX`。 + +## 选择 `PDFLaTeX` 编译 + +如果你使用 `PDFLaTeX` 编译，默认的 Computer Modern 字体被换成了 `newtx` 系列字体，默认的字体字号是 11 pt。关于字体设置的宏包主要用到了： + ++ `newtxtext` 用于文档正文字体，类似于 Times New Roman 字体。 ++ `newtxmath` 用于数学字体，搭配 `newtx` 非常合适，类似于过时的 `times` 宏包的效果。 ++ `FiraMono` 用于打字机字体，并使用了 `scale=0.8` 选项。 ++ `ctex` 用于中文字体设置，并使用了 `scheme=plain` 选项。 + +## 选择 `XeLaTeX` 编译 + +如果你选择 `XeLaTeX` 编译的话，那么设置字体的宏包为 `fontspec` 和 `xeCJK`。由于模板中使用的字体是 Windows 中的字体，所以如果你使用其他操作系统，比如 Linux 或者 Mac OS，那么你需要把所用字体替换为你系统中的字体。设置字体的命令： + +```tex +\RequirePackage{fontenc} +\RequirePackage[no-math]{fontspec} +\setmainfont{Times New Roman}[NFSSFamily=ntxtlf] +\setsansfont{Arial} +%\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} +``` + +这几个包由于都是一个系列的，字体搭配起来非常合适，字体宽度非常契合！唯独数学字体中的大型运算符，比如求和符号和积分符号不是很好看，为此，我把它们又改回了原先的字体效果。 + +我把行距设定为 1.3，并且使用了 `microtype` 宏包调整字体的间距，为了去除字体字号，字形警告信息，我使用了 `type1cm` 宏包。 + diff --git a/安装说明.md b/安装说明.md new file mode 100644 index 0000000..04c4e1c --- /dev/null +++ b/安装说明.md @@ -0,0 +1,35 @@ +本节以 TeX Live 2018 为例，介绍如何通过命令行或者包管理工具安装模板（包）。 + +## 命令行方式安装 + +以管理员权限打开命令行，在命令行输入下面命令即可安装 elegantpaper 模板。 + +```shell +tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet +tlmgr install elegantpaper +``` + +升级和卸载分别使用 + +```shell +tlmgr update elegantpaper +tlmgr uninstall elegantpaper +``` + +## 包管理工具方式安装 + +在 Windows 里面搜索 tlmgr，找到 TeX Live Manager 并打开： + +![tlmgr](https://elegantlatex.org/image/tlmgr.png) + +然后通过菜单 `tlmgr` 选择 + +```shell +Load standard net repository: http://mirror.ctan.org/systems/texlive/tlnet +``` + +![tlmgr](https://elegantlatex.org/image/tlmgr-1.png) + +然后在匹配框内输入包的名字，比如 `elegantpaper`，在搜索结果中勾选需要安装/更新/卸载的包： + +![tlmgr](https://elegantlatex.org/image/tlmgr-2.png) diff --git a/插入图片.md b/插入图片.md new file mode 100644 index 0000000..071ee3d --- /dev/null +++ b/插入图片.md @@ -0,0 +1,11 @@ +插图的命令和以前一样，也是使用 `figure` 环境。你可以把你的图放到当前工作目录的如下子目录下 ( `./image/` , `./img/` , `./figure/` , `./fig/` )。 + +```tex +% 如果要使抄录环境显示中文，必须用 XeLaTeX，而不能用 PDFLaTeX +% 这是由于 lstlisting 和 ctex 的问题 +\begin{figure}[htbp] + \centering + \includegraphics[width=0.6\textwidth]{scatter.pdf} + \caption{散点图示例\label{fig:scatter}} +\end{figure} +``` diff --git a/插入表格.md b/插入表格.md new file mode 100644 index 0000000..4f2229b --- /dev/null +++ b/插入表格.md @@ -0,0 +1,26 @@ +我强烈建议你使用 `booktabs` 宏包，这个宏包有三个命令 \toprule、\midrule 和 \bottomrule 能方便你制作三线表。下面是一个示例： + +```tex +\begin{table}[htbp] + \small + \centering + \caption{燃油效率与汽⻋价格} + \begin{tabular}{lcc} + \toprule + & (1) & (2) \\ + \midrule + 燃油效率 & -238.90*** & -49.51 \\ + & (53.08) & (86.16) \\ + 汽车重量 & & 1.75*** \\ + & & (0.641) \\ + 常数项 & 11,253*** & 1,946 \\ + & (1,171) & (3,597) \\ + 观测数 & 74 & 74 \\ + $R^2$ & 0.220 & 0.293 \\ + \bottomrule + \multicolumn{3}{l}{\scriptsize 括号内为标准误} \\ + \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ + \end{tabular}% + \label{tab:reg}% +\end{table}% +``` diff --git a/最小示例.md b/最小示例.md new file mode 100644 index 0000000..8be4c41 --- /dev/null +++ b/最小示例.md @@ -0,0 +1,35 @@ +在这部分，我提供一个示例文档： + +```tex +\documentclass[lang=cn]{elegantpaper} + +% 标题信息 +\title{工作论文示例展示} +\author{ddswhu} +\institute{Elegant\LaTeX{} 项目组} +\version{1.00} +\date{\today} + +\begin{document} + +\maketitle + +\begin{abstract} +在这里写摘要。 +\keywords{关键词1，关键词2} +\end{abstract} + +\section{引言} +这一部分是引言的内容。 + +\section{结论} +这是结论部分。 +% 在参考文献部分显示未引用的文献 + +\nocite{ref1, ref2} + +% 生成参考文献 +\bibliography{wpref} + +\end{document} +``` diff --git a/模板介绍.md b/模板介绍.md new file mode 100644 index 0000000..113bf7f --- /dev/null +++ b/模板介绍.md @@ -0,0 +1,2 @@ +此模板是基于 LaTeX 的标准文档类设计，也即意味着你可以在在文类选项使用文档（article）类 +型的选项，比如 `a4paper`, `12pt` 等等。本模板支持 `PDFLaTeX` 和 `XeLaTeX` 两种编译方式。 diff --git a/自定义命令.md b/自定义命令.md new file mode 100644 index 0000000..161cfbc --- /dev/null +++ b/自定义命令.md @@ -0,0 +1,7 @@ +在此模板中，并没有修改任何默认的命令或者环境，所以，你可以在此模板使用原来的命令和 +环境。另外，我自定义了 4 个命令： + +1. `\email`：创建邮箱地址的链接； +2. `\figref`：用法和 `\ref` 类似，但是会在插图的标题前添加 __图 n__ ； +3. `\tabref`：用法和 `\ref` 类似，但是会在表格的标题前添加 __表 n__； +4. `\keywords`：为摘要环境添加关键词。 diff --git a/语言模式.md b/语言模式.md new file mode 100644 index 0000000..71c4916 --- /dev/null +++ b/语言模式.md @@ -0,0 +1,8 @@ +我在这个模板中定义了一个语言选项 `lang`，可以选择英文模式 `lang=en`（默认）或者中文模式 +`lang=cn`。当选择中文模式时，图表的标题引导词以及参考文献，定理引导词等信息会变成中文。你 +可以通过下面两种方式来选择语言模式： + +```tex +\documentclass[lang=cn]{elegantpaper} +\documentclass{cn}{elegantpaper} % 两者皆可 +```