Patrick/ElegantBook
1
0
Fork 0
mirror of https://github.com/ElegantLaTeX/ElegantBook.git synced 2026-01-26 12:24:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

test

EthanDeng
2019-02-28 21:04:24 +08:00
parent 17f6d6706a
commit 64b1d91ab6
21 changed files with 997 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

242
.gitignore vendored Normal file

@@ -0,0 +1,242 @@
## Core latex/pdflatex auxiliary files:
*.aux
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.fmt
*.fot
*.cb
*.cb2
.*.lb
## Intermediate documents:
*.dvi
*.xdv
*-converted-to.*
# these rules might exclude image files for figures etc.
# *.ps
# *.eps
# *.pdf
## Generated if empty string is given at "Please type another file name for output:"
.pdf
## Bibliography auxiliary files (bibtex/biblatex/biber):
*.bbl
*.bcf
*.blg
*-blx.aux
*-blx.bib
*.run.xml
## Build tool auxiliary files:
*.fdb_latexmk
*.synctex
*.synctex(busy)
*.synctex.gz
*.synctex.gz(busy)
*.pdfsync
## Auxiliary and intermediate files from other packages:
# algorithms
*.alg
*.loa
# achemso
acs-*.bib
# amsthm
*.thm
# beamer
*.nav
*.pre
*.snm
*.vrb
# changes
*.soc
# cprotect
*.cpt
# elsarticle (documentclass of Elsevier journals)
*.spl
# endnotes
*.ent
# fixme
*.lox
# feynmf/feynmp
*.mf
*.mp
*.t[1-9]
*.t[1-9][0-9]
*.tfm
#(r)(e)ledmac/(r)(e)ledpar
*.end
*.?end
*.[1-9]
*.[1-9][0-9]
*.[1-9][0-9][0-9]
*.[1-9]R
*.[1-9][0-9]R
*.[1-9][0-9][0-9]R
*.eledsec[1-9]
*.eledsec[1-9]R
*.eledsec[1-9][0-9]
*.eledsec[1-9][0-9]R
*.eledsec[1-9][0-9][0-9]
*.eledsec[1-9][0-9][0-9]R
# glossaries
*.acn
*.acr
*.glg
*.glo
*.gls
*.glsdefs
# gnuplottex
*-gnuplottex-*
# gregoriotex
*.gaux
*.gtex
# htlatex
*.4ct
*.4tc
*.idv
*.lg
*.trc
*.xref
# hyperref
*.brf
# knitr
*-concordance.tex
# TODO Comment the next line if you want to keep your tikz graphics files
*.tikz
*-tikzDictionary
# listings
*.lol
# makeidx
*.idx
*.ilg
*.ind
*.ist
# minitoc
*.maf
*.mlf
*.mlt
*.mtc[0-9]*
*.slf[0-9]*
*.slt[0-9]*
*.stc[0-9]*
# minted
_minted*
*.pyg
# morewrites
*.mw
# nomencl
*.nlg
*.nlo
*.nls
# pax
*.pax
# pdfpcnotes
*.pdfpc
# sagetex
*.sagetex.sage
*.sagetex.py
*.sagetex.scmd
# scrwfile
*.wrt
# sympy
*.sout
*.sympy
sympy-plots-for-*.tex/
# pdfcomment
*.upa
*.upb
# pythontex
*.pytxcode
pythontex-files-*/
# thmtools
*.loe
# TikZ & PGF
*.dpth
*.md5
*.auxlock
# todonotes
*.tdo
# easy-todo
*.lod
# xmpincl
*.xmpi
# xindy
*.xdy
# xypic precompiled matrices
*.xyc
# endfloat
*.ttt
*.fff
# Latexian
TSWLatexianTemp*
## Editors:
# WinEdt
*.bak
*.sav
# Texpad
.texpadtmp
# Kile
*.backup
# KBibTeX
*~[0-9]*
# auto folder when using emacs and auctex
./auto/*
*.el
# expex forward references with \gathertags
*-tags.tex
# standalone packages
*.sta
# generated if using elsarticle.cls
*.spl

11
ColorThemes.md Normal file

@@ -0,0 +1,11 @@
This template contains 5 color themes, green, cyan, blue, sakura, black. Where
green is the default color theme, if you don’t need color, you can choose black
theme. The color theme is enabled in the same way as before:
```tex
\documentclass[green]{elegantnote}
\documentclass[color=green]{elegantnote}
....
\documentclass[black]{elegantnote}
\documentclass[color=black]{elegantnote}
```

9
CompilationMethods.md Normal file

@@ -0,0 +1,9 @@
You can use `PDFLaTeX` or `XeLaTeX` to process your notes.
+ If you are using PDFLaTeX, `ctex` package is used;
+ If you are using XeLaTeX , `xeCJK` package is called when processing Chinese characters.
The test environment is Win10 + TeX Live 2018. If you are using a Mac/Linux
system and compiled with `XeLaTeX`, please change the font in elegantnote.cls with your system font.
__Note:__ If you are using `PDFLaTeX`, you do not need to change the font settings.

19
DeviceOptions.md Normal file

@@ -0,0 +1,19 @@
To make the notes more comfortable to read, we designed four output options (of different sizes) that correspond to different reading devices: Pad, Kindle, PC and A4paper. The options of output for different devices are
```tex
\documentclass[device=pad]{elegantnote}
\documentclass[device=kindle]{elegantnote}
\documentclass[device=pc]{elegantnote}
\documentclass[device=normal]{elegantnote}
```
__Note:__ You can also select the device by using a direct assignment method, such as:
```tex
\documentclass[pad]{elegantnote}
\documentclass[kindle]{elegantnote}
\documentclass[pc]{elegantnote}
\documentclass[normal]{elegantnote}
```
Note that if you want a normal A4paper size PDF, you need to select `device=normal` instead of `device=pc` , because `device=pc` is actually set to double page mode on your computer.

9
GoodforEyeMode.md Normal file

@@ -0,0 +1,9 @@
This template added good for eye mode (geye), the default is none, you can switch to good eye mode using:
```tex
\documentclass[geye]{elegantnote} % or
\documentclass[mode=geye]{elegantnote}
```
__Remark:__ In this version, only one background color is added. If you are expected to add other colors, you can [create issues](https://github.com/ElegantLaTeX/ElegantNote/issues/new) or [pull requests](https://github.com/ElegantLaTeX/ElegantNote/compare) at [Github/ElegantNote](https://github.com/ElegantLaTeX/ElegantNote).

38
Installation.md Normal file

@@ -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 elegantnote
```
If you want to update or uninstall package, you can use
```shell
tlmgr update elegantnote
tlmgr uninstall elegantnote
```
## 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-note.png)
Complete.

14
Introduction.md Normal file

@@ -0,0 +1,14 @@
This template was originally designed to take notes and was conceived in 2013. In the first version, we designed a series of beautiful theorem environments and introduced 3 different color themes. But when taking notes using this template, we found there were so many theorem blocks which makes the notes not pretty. So we decided to update the ElegantNote to the ElegantBook template. The design of ElegantNote stopped there.
In 2018, after being "urged" by some users, ElegantBook received a major update, the original floating theorem environments are rewritten with tcolorbox package. After that, we want to completely redesign the ElegantNote template. We are in favor of more compact, simpler theorem environments, and aim to design an Elegant LaTeX template which is more suitable for note taking and note reading.
With the advice and inspiration of some friends, we redesigned the new ElegantNote template based on the Standard LaTeX article class! The new template has the following features:
+ good for eye mode: with green page color;
+ different devices: Pad (default), Kindle, PC (double-page) and normal (A4);
+ 5 color themes: green (default), cyan, blue, sakura, black;
+ languages support: Chinese (default), English;
+ support `PDFLaTeX` and `XeLaTeX` ;
+ prettier captions, list environments, and unified fonts.
____

10
Languages.md Normal file

@@ -0,0 +1,10 @@
This template contains two sets of language environments, changing the language environment will change the title of table/figure (figure, table), article structure words (such as the table of contents, references, etc.), and the environment introductory words (such as Theorem, Lemma, etc.). The different language modes are enabled as follows:
```tex
\documentclass[cn]{elegantnote}
\documentclass[lang=cn]{elegantnote}
\documentclass[en]{elegantnote}
\documentclass[lang=en]{elegantnote}
```
Note You can input Chinese Characters in either environment.

416
License Normal file

@@ -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.

20
MinimalExample.md Normal file

@@ -0,0 +1,20 @@
Here is a minimal example.
```tex
\documentclass[geye,green,pad,en]{elegantnote}
\title{A Note Example}
\author{ddswhu}
\institute{Elegant\LaTeX{} Program}
\version{1.00}
\date{\today}
\begin{document}
\maketitle
\section{Introduction}
Example Text.
\end{document}
```

8
TheoremClassEnvironments.md Normal file

@@ -0,0 +1,8 @@
This template used the `amsthm` to create theorems, there are 4 types of theorem environments
+ __Theorem-Class__: theorem, lemma, proposition, corollary;
+ __Definition-Class__: definition, conjecture, example;
+ __Remark-Class__: remark, note, case;
+ __Proof-Class__: proof.
__Remark:__ With the option `lang=cn`, the introductory words of the theorem class environments will be changed to Chinese.

42
_Sidebar.md Normal file

@@ -0,0 +1,42 @@
## 中文版本
* [模板介绍](https://github.com/ElegantLaTeX/ElegantNote/wiki/介绍)
* 模板使用
* [安装说明](https://github.com/ElegantLaTeX/ElegantNote/wiki/安装)
* [护眼模式](https://github.com/ElegantLaTeX/ElegantNote/wiki/护眼模式)
* [设备选择](https://github.com/ElegantLaTeX/ElegantNote/wiki/设备选择)
* [颜色主题](https://github.com/ElegantLaTeX/ElegantNote/wiki/颜色主题)
* [语言模式](https://github.com/ElegantLaTeX/ElegantNote/wiki/语言模式)
* [编译方式](https://github.com/ElegantLaTeX/ElegantNote/wiki/编译方式)
* [定理类环境](https://github.com/ElegantLaTeX/ElegantNote/wiki/定理类环境)
* [示例](https://github.com/ElegantLaTeX/ElegantNote/wiki/最小示例)
* 作者
* [Github](https://github.com/EthanDeng)
* [个人主页](https://ddswhu.me/)
## English Version
* [Introduction](https://github.com/ElegantLaTeX/ElegantNote/wiki/Introduction)
* Features Overview
* [Installation](https://github.com/ElegantLaTeX/ElegantNote/wiki/Installation)
* [Good for Eye Mode](https://github.com/ElegantLaTeX/ElegantNote/wiki/GoodforEyeMode)
* [Device Options](https://github.com/ElegantLaTeX/ElegantNote/wiki/DeviceOptions)
* [Color Themes](https://github.com/ElegantLaTeX/ElegantNote/wiki/ColorThemes)
* [Languages](https://github.com/ElegantLaTeX/ElegantNote/wiki/Languages)
* [Compilation Methods](https://github.com/ElegantLaTeX/ElegantNote/wiki/CompilationMethods)
* [Theorem Class Environments](https://github.com/ElegantLaTeX/ElegantNote/wiki/TheoremClassEnvironments)
* [Minimal Example](https://github.com/ElegantLaTeX/ElegantNote/wiki/MinimalExample)
* Author
* [Github](https://github.com/EthanDeng)
* [Homepage](https://ddswhu.me/)
## Links/相关链接
* [Github](https://github.com/ElegantLaTeX/ElegantNote)
* [CTAN](https://ctan.org/pkg/elegantnote)
* [Email](mailto:elegantlatex2e@gmail.com)
* [Issues](https://github.com/ElegantLaTeX/ElegantNote/issues/new)
* [Pull Request](https://github.com/ElegantLaTeX/ElegantNote/compare)
* [ElegantLaTeX](https://elegantlatex.org/)

14
介绍.md Normal file

@@ -0,0 +1,14 @@
此模板设计的初衷是为了记录笔记，在 2013 年开始构想，初版我们设计了非常美观的定理环境，并设计了 3 套不同的颜色主题。但我们发现在实际记笔记的时候，过多的定理区块使得整个文章并不是非常美观，所以我们把 ElegantNote 更新为 ElegantBook 模板，在后面被用户熟知。而 ElegantNote 的设计自此停止。
2018 年，在被一些用户“催更”之后，ElegantBook 迎来重大更新，原先浮动的定理环境用 `tcolorbox` 全部改写。时至今日，ElegantBook 版本为 3.05。之后，我们便想把 ElegantNote 也彻底更新下，放弃 ElegantBook 的定理环境设计，改用更为紧凑，更加朴素的定理环境，设计更适合笔记记录和笔记阅读的 LaTeX 模板。
在一些朋友的建议和启发下，我们基于标准的 LaTeX 文类 article 重新设计了新版 ElegantNote 模板，在此特别感谢！新模板的特色有：
+ 添加护眼模式，颜色为绿豆沙颜色，默认为白色背景；
+ 适配不同设备，包括 Pad（默认），Kindle，PC（双页），通用（A4）；
+ 5 套颜色主题，分别是：green（默认），cyan，blue，sakura，black；
+ 语言模式支持：中文（默认），英文；
+ 支持 `PDFLaTeX` 和 `XeLaTeX` 编译；
+ 更加美观的图表标题格式，列表环境，数学字体等。
____

35
安装.md Normal file

@@ -0,0 +1,35 @@
本节以 TeX Live 2018 为例，介绍如何通过命令行或者包管理工具安装模板（包）。
## 命令行方式安装
以管理员权限打开命令行，在命令行输入下面命令即可安装 elegantnote 模板。
```shell
tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet
tlmgr install elegantnote
```
升级和卸载分别使用
```shell
tlmgr update elegantnote
tlmgr uninstall elegantnote
```
## 包管理工具方式安装
在 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)
然后在匹配框内输入包的名字，比如 `elegantnote`，在搜索结果中勾选需要安装/更新/卸载的包：
![tlmgr](https://elegantlatex.org/image/tlmgr-note.png)

8
定理类环境.md Normal file

@@ -0,0 +1,8 @@
此模板采用了 `amsthm` 中的定理样式，使用了 4 类定理样式，所包含的环境分别为
+ __定理类__：theorem，lemma，proposition，corollary；
+ __定义类__：definition，conjecture，example；
+ __备注类__：remark，note，case；
+ __证明类__：proof。
__评论：__ 在选用 `lang=cn` 时，定理类环境的引导词全部会改为中文。

7
护眼模式.md Normal file

@@ -0,0 +1,7 @@
本模板增加了护眼模式，默认为不开启，开启的方法如下：
```tex
\documentclass[geye]{elegantnote} % 或者
\documentclass[mode=geye]{elegantnote}
```
__评论：__ 此次更新只添加了护眼模式（绿豆沙色背景），如果您有希望增加其他颜色，可以在 [Github/ElegantNote](https://github.com/ElegantLaTeX/ElegantNote) 创建 [issues](https://github.com/ElegantLaTeX/ElegantNote/issues/new) 或者提交 [pull request](https://github.com/ElegantLaTeX/ElegantNote/compare)。

20
最小示例.md Normal file

@@ -0,0 +1,20 @@
安装之后即可使用，下面是一个示例：
```tex
\documentclass[geye,green,pad,cn]{elegantnote}
\title{一个笔记示例}
\author{ddswhu}
\institute{Elegant\LaTeX{} 项目组}
\version{1.00}
\date{2019 年 2 月 3 日}
\begin{document}
\maketitle
\section{介绍}
介绍部分内容。
\end{document}
```

37
编译方式.md Normal file

@@ -0,0 +1,37 @@
# 编译方式
本模板基于基础的 book 文类，所以 book 的选项对于本模板也是有效的。默认编码为 UTF-8，推荐使用 TeX Live 编译。本文编写环境为 Win10 (64bit) + TeX Live 2018，支持 `PDFLaTeX` 以及 `XeLaTeX` 编译。
## 选择 `PDFLaTeX` 编译
如果你使用 `PDFLaTeX` 编译，默认的 Computer Modern 字体被换成了 newtx 系列字体，默认的字体字号是 12 pt。关于字体设置的宏包主要用到了：
+ `newtxtext` 用于文档正文字体，类似于 Times New Roman 字体。
+ `newtxmath` 用于数学字体，搭配 `newtxtext` 非常合适。
+ `FiraMono` 用于打字机字体，并使用了 `scale=0.7` 选项。
+ `ctex` 用于中文字体设置，并使用了 `scheme=plain` 选项。
一次完整的编译：`PDFLaTeX` -> `BibTeX` -> `PDFLaTeX`*2。
## 选择 `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.7]{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.7]{Microsoft YaHei}
\XeTeXlinebreaklocale ”zh”
\XeTeXlinebreakskip = 0pt plus 1pt minus 0.1pt
\RequirePackage{newtxmath}
```
一次完整的编译：`XeLaTeX` -> `BibTeX` -> `XeLaTeX`*2。

19
设备选择.md Normal file

@@ -0,0 +1,19 @@
为了让笔记方便在不同设备上阅读，免去切边，缩放等操作，本模板适配不同的屏幕大小，分别为 Pad，Kindle，PC，A4。不同屏幕的选择为
```tex
\documentclass[device=pad]{elegantnote}
\documentclass[device=kindle]{elegantnote}
\documentclass[device=pc]{elegantnote}
\documentclass[device=normal]{elegantnote}
```
__注：__ 也可以采取直接赋值的方法选择屏幕，比如：
```tex
\documentclass[pad]{elegantnote}
\documentclass[kindle]{elegantnote}
\documentclass[pc]{elegantnote}
\documentclass[normal]{elegantnote}
```
__注：__ 如果想要得到普通的 A4 纸张大小的 PDF，需要选择 `device=normal`，而不是选择 `device=pc`，因为 `device=pc` 实际上设置的是电脑双页模式。

10
语言模式.md Normal file

@@ -0,0 +1,10 @@
本模板内含两套语言环境，改变语言环境会改变图表标题的引导词（图，表），文章结构词（比如目录，参考文献等），以及定理环境中的引导词（比如定理，引理等）。不同语言模式的启用如下：
```tex
\documentclass[cn]{elegantnote} % 中文模式
\documentclass[lang=cn]{elegantnote}
\documentclass[en]{elegantnote} % 英文模式
\documentclass[lang=en]{elegantnote}
```
__注：__ 不管选用中文环境还是英文环境均可输入中文。另外如果在笔记中使用了抄录环境（`lstlisting`），并且其中包括了中文，请务必使用 `XeLaTeX` 编译。本说明文档也只能通过 `XeLaTeX` 编译。

9
颜色主题.md Normal file

@@ -0,0 +1,9 @@
本模板内置 5 套颜色主题，分别是 green，cyan，blue，sakura，black。其中 green 为默认颜色主题，如果用户不需要彩色，可以选择 black 主题。颜色主题的启用方法和之前一样：
```tex
\documentclass[green]{elegantnote}
\documentclass[color=green]{elegantnote}
...
\documentclass[black]{elegantnote}
\documentclass[color=black]{elegantnote}
```