Stable Release v1.0

Pherse · Apr 3, 2016 · 86fc674 · 86fc674
1 parent 5d1c03a
commit 86fc674
Show file tree

Hide file tree

Showing 12 changed files with 162 additions and 95 deletions.
diff --git a/Compile.bat b/Compile.bat
@@ -5,7 +5,7 @@
 @rem ******************************************
 @rem ********* Set target compiler ************
 @rem ******************************************
-set CompilerOrder="2"
+set CompilerOrder="1"
 @rem ******************************************
 if %CompilerOrder% == "1" (
 set CompileName="pdflatex"

diff --git a/HowToUse.pdf b/HowToUse.pdf
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ LATEX thesis template for The University of Chinese Academy of Sciences 中国
 
 考虑到大多数用户并无LaTeX使用经验，本模板将LaTeX的复杂性尽可能地进行了封装，开放出简单的接口，以便于使用者可以轻易地使用，同时，对使用LaTeX撰写论文所遇到的一些主要难题，如插入图片、文献索引等，进行了详细的说明，并提供了相应的代码样本，理解了上述问题后，对于初学者而言，使用此模板撰写其学文论文将不存在实质性的困难，所以，如果您是初学者，请不要直接放弃，因为同样作为初学者，十分明白让LaTeX变得简单易用的重要性，而这正是本模板所体现的.
 
-此中国科学院大学学位论文模板ucasthesis基于吴凌云的CASthesis模板发展而来，ucasthesis文档类的基础架构为ctexbook文档类。当前ucasthesis 模板满足最新的中国科学院大学学位论文撰写要求和封面设定。模板提供了pdflatex 或xelatex （默认） 编译方式，完美地支持中文书签、中文渲染、中文粗体显示、拷贝pdf中的文本到其他文本编辑器等特性，此外，对模板的文档结构进行了精心设计，撰写了编译脚本提高模板的易用性和使用效率。
+此中国科学院大学学位论文模板ucasthesis基于吴凌云的CASthesis模板发展而来，ucasthesis文档类的基础架构为ctexbook文档类。当前ucasthesis 模板满足最新的中国科学院大学学位论文撰写要求和封面设定。模板同时兼容~pdflatex~和~xelatex~ 编译方式，完美地支持中文书签、中文渲染、中文粗体显示、拷贝pdf中的文本到其他文本编辑器等特性，此外，对模板的文档结构进行了精心设计，撰写了编译脚本提高模板的易用性和使用效率。
 
 宏包的目的是简化学位论文的撰写，模板文档的默认设定是十分规范的，从而论文作者可以将精力集中到论文的内容上，而不需要在版面设置上花费精力。 同时，在编写模板的LaTeX文档代码过程中，作者对各结构和命令进行了十分详细的注解，并提供了整洁一致的代码结构，对文档的仔细阅读可以为初学的您提供一个学习LaTeX的窗口。除此之外，整个模板的架构十分注重通用性，事实上，本模板不仅是中国科学院大学学文论文模板，同时，也是使用LaTeX撰写中英文article或book的通用模板，并为使用者的个性化设定提供了接口和相应的代码。
 
@@ -18,9 +18,11 @@ LATEX thesis template for The University of Chinese Academy of Sciences 中国
 Change log:
 ==========
 
-2016-03-30 Stable Release v1.0
+2016-04-03 Stable Release v1.0
 ==========
 
+2016-04-03 Adjust the template to be directly compilable by Tex Editors such as WinEdit, since the majority users prefer this.
+
 2016-03-29 Update ucasthesis.cls to set the color of underline to black rather than blue.
 
 2016-03-18 Update custom.sty and Thesis.tex to ensure correct page reference for "List of Figures", "List of Tables", and "Reference". 

diff --git a/Style/commons.sty b/Style/commons.sty
@@ -1,6 +1,6 @@
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%***************************** version information ********************************
+%%%%***************************** Version Information ********************************
 %%
 %% this is the "commons.sty" package used for configure document styles
 %% Copyright (C) 2014-2018 Huangrui Mo <huangrui.mo@gmail.com> 
@@ -15,7 +15,7 @@
 macros package]
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************************Declare Options***********************************
+%%%%******************************* Declare Options **********************************
 %%
 \newif\ifCOMMONS@myhdr \COMMONS@myhdrfalse
 \DeclareOption{myhdr}{% user defined header and footer style
@@ -81,15 +81,15 @@ macros package]
 \ProcessOptions\relax
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************************Required Packages*********************************
+%%%%******************************* Required Packages ********************************
 %%
 %% Language Setting
 \RequirePackage{ifpdf,ifxetex}
 %% packages and settings depend on PDF mode
 \ifxetex % running xelatex in PDF mode
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%***********************************xelatex****************************************
+%%%%********************************** Xelatex ***************************************
 %%
 %%% >>> System Font Environment
 %%
@@ -115,7 +115,7 @@ macros package]
 \ifpdf % running pdfTeX in PDF mode
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%*********************************pdflatex*****************************************
+%%%%******************************** Pdflatex ****************************************
 %%
 %%% >>>  Input encoding and the font encoding
 %%
@@ -128,23 +128,16 @@ macros package]
 \RequirePackage[utf8]{inputenc}% make sure your document is saved using the UTF-8 encoding.
 %\RequirePackage[latin1]{inputenc}% latin encoding
 %% Font encoding.
-\RequirePackage[T1]{fontenc}
+\RequirePackage[T1]{fontenc}% enable modern font encoding
 %% Font package.
-\RequirePackage{mathptmx}
+\RequirePackage{newtxtext,newtxmath}
 %% Options:
-%% Need \RequirePackage[T1]{fontenc}:
-%% - \RequirePackage{lmodern}, modern font.
-%% - \RequirePackage{concrete}, text: Concrete, math: Concrete italic + Euler VM symbols.
-%% - \RequirePackage{concmath}, text: Concrete, math: Concrete italic + Concmath symbols.
-%% No need \RequirePackage[T1]{fontenc}:
-%% Text: Helvetica, Math: Helvetica italic + Euler VM symbols:
-%% - \RequirePackage{eulervm} + \RequirePackage[scaled]{helvet}
-%% Text: Palatino, Math: Palatino italic + Euler VM symbols:
-%% - \RequirePackage{palatino} or {mathpazo} + \RequirePackage{eulervm}
-%% Text + Math: Times, not a good font for screen presentation:
-%% - \RequirePackage{mathptmx}
-%% Text: Bradhley Hand writing, Math: mathpazo symbols:
-%% - \RequirePackage{mathpazo} % Mathpazo symbols + \renewcommand{\rmdefault}{ibh} % Bradhley Hand.
+%% Text + Math: Adobe Times Roman (Recommended)
+%% - \RequirePackage{newtxtext,newtxmath}
+%% Text + Math: Palatino
+%% - \RequirePackage{palatino}
+%% Text + Math: Adobe Times Roman
+%% - \RequirePackage{mathptmx,newtxmath}
 \fi
 \fi
 %%
@@ -220,7 +213,6 @@ macros package]
 %%
 \ifCOMMONS@math% enable some extra math package
     \RequirePackage{mathtools,amstext,amsfonts,amssymb}
-    \RequirePackage{siunitx}% typeset numbers and units in an easy way
 \fi
 %%
 %% >>> Tkiz
@@ -277,7 +269,7 @@ macros package]
 %% other packages but prior to other settings.
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%*****************************Configuration Command********************************
+%%%%**************************** Configuration Command *******************************
 %%
 %% >>> Extensions and Directories for graphics
 %%
@@ -293,7 +285,7 @@ macros package]
         %% on the command line only, rather than embedding into source files.
     \fi
 \fi
-\graphicspath{{./Img/}}% search path for figures, no need if use scripts to compile
+\graphicspath{{Img/}}% search path for figures
 %%
 %%% >>> Page background:
 %%

diff --git a/Style/custom.sty b/Style/custom.sty
@@ -1,6 +1,6 @@
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%***************************** version information ********************************
+%%%%***************************** Version Information ********************************
 %%
 %% Copyright (C) 2014-2018 Huangrui Mo <huangrui.mo@gmail.com> 
 %% This is free software: you can redistribute it and/or modify it
@@ -14,7 +14,7 @@
 macros package]
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************************Declare Options***********************************
+%%%%******************************* Declare Options **********************************
 %%
 %% end-user parameters, each option is declared by one declare option command
 \DeclareOption*{% handle non-implemented options
@@ -24,12 +24,53 @@ macros package]
 \ProcessOptions\relax
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%***************************User Defined Command***********************************
+%%%%************************** User Defined Command **********************************
+%%
+%%% >>> Notice
+%% 
+%% -- \newcommand: defines a new command, makes an error if already defined
+%% -- \renewcommand: redefines a predefined command, makes an error if not yet defined
+%% -- \providecommand: defines a new command, if already defined, keep old definition
+%% -- \def: define a command whether new or predefined, equivalent to
+%%          \providecommand{name}{}%
+%%          \renewcommand{name}[number of arguments][default value]{definition}
+%%
+%%% >>> Math functions
+%%
+%% International standard layout rules (from isomath package)
+%% -- The overall rule is that symbols representing math quantities or variables should
+%%    be italicised, symbols representing units or labels are unitalicised (roman).
+%% -- Symbols for vectors and matrices are bold italic, symbols for tensors are 
+%%    sans-serif bold italic.
+%% -- The above rules apply equally to letter symbols from the Greek and 
+%%    the Latin alphabet.
+%% -- More information may be found in <<The LaTeX Mathematics Companion>>
+%% However, math typefaces vary from field to field. To keep consistent typography
+%% and easy adaption, it it always best to create a corresponding command for 
+%% variables in each math category.  
+%\providecommand{\Scalar}[1]{#1}% Scalar is the normal math typeset, italic
+\providecommand{\Vector}[1]{\boldsymbol{#1}}% General vectors in bold italic
+%\renewcommand{\vec}[1]{\Vector{#1}}% redefine predefined vector if needed
+\providecommand{\unitVector}[1]{\boldsymbol{\mathbf{#1}}}% Unit vectors in bold roman
+\providecommand{\Tensor}[1]{\boldsymbol{\mathsf{#1}}}% Tensor in sans-serif bold italic
+\providecommand{\unitTensor}[1]{\boldsymbol{{\mathsf{#1}}}}% Identity tensor in sans-serif bold
+\providecommand{\Matrix}[1]{\boldsymbol{\mathbf{#1}}}% Matrix in bold roman
+\providecommand{\unitMatrix}[1]{\boldsymbol{\mathbf{#1}}}% Identity matrix in bold roman
+\providecommand{\Unit}[1]{\,\mathrm{#1}}% Units in roman
+\providecommand{\Const}[1]{\mathrm{#1}}% Math constants, functions, operators
+\providecommand{\Set}[1]{\mathbb{#1}}% Special sets (e.g. real numbers) in blackboard bold
+\providecommand{\Div}[1]{\operatorname{div}\left(#1\right)}% divergence math operator
 %%
 %%% >>> Graphic Length Factor
 %%
-\newcommand*{\MyFactor}{0.6}% for single figure
-\newcommand*{\MySubFactor}{0.4}% for subfigure
+\newcommand*{\MyFactor}{0.8}% for single figure
+\newcommand*{\MySubFactor}{0.48}% for subfigure
+%%
+%%% >>> Nomenclature item
+%%
+\newcommand{\nomenclatureitem}[3][ ]{%
+    \noindent\makebox[0.15\textwidth][l]{#2}{{#3}\hfill{#1}}\par
+}
 %%
 %%% >>> Add content link to the table of content and bookmark
 %%
@@ -41,15 +82,9 @@ macros package]
     \phantomsection% use for adobe bookmark.
     \addcontentsline{toc}{#1}{#2}% add content #2 to toc as #1
 }
-%%
-%%% >>> Define a command for Nomenclature
-%%
-\newcommand{\nomenclatureitem}[3][ ]{
-    \noindent\makebox[0.15\textwidth][l]{#2}{{#3}\hfill{#1}}\par
-}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%*****************************User Configuration***********************************
+%%%%**************************** User Configuration **********************************
 %%
 %%
 %%% >>> Space and Skip

diff --git a/Style/ucasthesis.cfg b/Style/ucasthesis.cfg
@@ -9,19 +9,19 @@
 %%%% This is the configuration file of the ucasthesis package.
 %%
 \ProvidesFile{ucasthesis.cfg}
-  [2016/03/05 v1.0 ucasthesis
+  [2014/10/01 v1.0 ucasthesis
    configuration file]
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%******************** config chinese labels in ctex *******************************
+%%%%******************** Config Chinese Labels in Ctex *******************************
 %%
 \renewcommand*{\contentsname}{目\quad 录}
 \renewcommand*{\listfigurename}{图形列表}
 \renewcommand*{\listtablename}{表格列表}
 \renewcommand*{\bibname}{参考文献}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************** labels in chinese titlepage *******************************
+%%%%********************** Labels in Chinese Titlepage *******************************
 %%
 \def\UCAS@label@confidential{密级:}
 \def\UCAS@label@thesis{学位论文}
@@ -32,7 +32,7 @@
 \def\UCAS@label@institute{培养单位：}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************** values in chinese titlepage *******************************
+%%%%********************** Values in Chinese Titlepage *******************************
 %%
 \def\UCAS@value@confidential{}
 \def\UCAS@value@schoollogo{}
@@ -48,12 +48,12 @@
 \def\UCAS@value@chinesedate{\the\year~年~\the\month~月}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************** labels in english titlepage *******************************
+%%%%********************** Labels in English Titlepage *******************************
 %%
 %\def\UCAS@label@englishadvisor{Supervisor:}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************** values in english titlepage *******************************
+%%%%********************** Values in English Titlepage *******************************
 %%
 \def\UCAS@value@englishtitle{(English Title of Thesis)}
 \def\UCAS@value@englishauthor{(Author Name)}
@@ -73,7 +73,7 @@
     \UCAS@value@englishdegree\ of \UCAS@value@englishmajor}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************** values in author's declaration ****************************
+%%%%********************** Values in Author's Declaration ****************************
 %%
 \def\UCAS@value@declare@create{学位论文独创性声明}
 \def\UCAS@value@declare@creativity{%
@@ -94,15 +94,15 @@
 \def\UCAS@value@declare@rule{（保密的论文在解密后应遵守此规定）}
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%***************** configure labels of some environments **************************
+%%%%***************** Configure Labels of Some Environments **************************
 %%
 \def\UCAS@label@abstract{摘\quad 要}
 \def\UCAS@label@englishabstract{Abstract}
 \def\UCAS@label@keywords{关键词：}
 \def\UCAS@label@englishkeywords{Keywords:\ }
 %%%%% --------------------------------------------------------------------------------
 %%
-%%%%********************** configure structure environments **************************
+%%%%********************** Configure Structure Elements ******************************
 %%
 %% chapter
 \def\CTEX@chapter@nameformat{\heiti\zihao{3}}