Skip to content

Commit

Permalink
Merge pull request #78 from SUSTech-CRA/feat/2025-mod
Browse files Browse the repository at this point in the history
更新模版2024-09
  • Loading branch information
liziwl authored Oct 6, 2024
2 parents 5972325 + 5849121 commit 26a4ef0
Show file tree
Hide file tree
Showing 11 changed files with 2,875 additions and 149 deletions.
17 changes: 0 additions & 17 deletions .github/workflows/close-issue.yml

This file was deleted.

12 changes: 6 additions & 6 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ jobs:
if: github.repository_owner == 'SUSTech-CRA'
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- uses: actions/setup-python@v3
- uses: actions/setup-python@v5
if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
with:
python-version: '3.9'
Expand All @@ -42,13 +42,13 @@ jobs:
exclusions: '*.git* /*node_modules/* .editorconfig'

- name: Upload release artifact
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: 'sustech-thesis-dev-build'
path: 'sustech-thesis-dev-build.zip'

- name: Upload Pre-release artifact
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: 'pre-release-artifacts_action_build'
path: |
Expand All @@ -62,7 +62,7 @@ jobs:
needs: build_latex
if: github.event_name == 'push'
steps:
- uses: actions/download-artifact@v3
- uses: actions/download-artifact@v4
name: Download artifact
- uses: "marvinpinto/action-automatic-releases@latest"
name: Auto pre-release
Expand All @@ -83,7 +83,7 @@ jobs:
needs: build_latex
if: startsWith(github.ref, 'refs/tags/v')
steps:
- uses: actions/download-artifact@v3
- uses: actions/download-artifact@v4
name: Download artifact

- name: Get the version
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/verify-compile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
texlive: [latest, TL2022-historic, TL2021-historic, TL2020-historic]
texlive: [latest, TL2023-historic, TL2022-historic, TL2021-historic]
# 多版本 TexLive 兼容性测试
# 版本号选自:https://hub.docker.com/r/texlive/texlive/tags
container: texlive/texlive:${{ matrix.texlive }}
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- uses: actions/setup-python@v3
- uses: actions/setup-python@v5
with:
python-version: '3.9'

Expand All @@ -26,7 +26,7 @@ jobs:
run: make doc test

- name: Publish PDF as actions assets
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: Example-PDFs-texlive-${{ matrix.texlive }}
path: |
Expand Down
16 changes: 12 additions & 4 deletions data/acknowledgements.tex
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
% !TeX root = ../sustechthesis-example.tex

\begin{acknowledgements}
衷心感谢导师×××教授和物理系××副教授对本人的精心指导。他们的言传身教将使我终生受益。

在美国麻省理工学院化学系进行九个月的合作研究期间,承蒙 Robert Field 教授热心指导与帮助,不胜感激
衷心感谢导师×××教授对本人的精心指导。他的言传身教将使我终生受益

感谢×××××实验室主任×××教授,以及实验室全体老师和同窗们学的热情帮助和支持!
感谢×××教授,以及实验室全体老师和同窗们的热情帮助和支持!

本课题承蒙××××基金资助,特此致谢。\\

\textcolor{red}{\textbf{以下内容为提示,仔细阅读后删除。}}

致谢应另起页,放置在参考文献、附录之后,标题和页眉均为“致谢”。语言要诚恳、恰当、简短。

致谢对象可以包括指导教师,在研究工作中提出建议和提供帮助的人,给予转载和引用权的资料、图片、文献、研究和调查的所有者,其他应感谢的组织和个人,资助研究工作的项目基金、奖学金基金、合同单位、资助或支持的企业、组织或个人,协助完成研究工作和提供便利条件的组织或个人。致谢字数以不超过一页纸为宜。

学位论文应由学生在导师(组)的指导下独立完成;\textcolor{red}{\textbf{若涉及团队工作,应注明属于团队成果,并明确个人独立完成的内容}},科学严谨,恪守规范。

本课题承蒙国家自然科学基金资助,特此致谢。
\end{acknowledgements}
82 changes: 80 additions & 2 deletions data/chap02.tex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% !TeX root = ../sustechthesis-example.tex

\chapter{图表示例}
\chapter{图、表及条目示例}

\section{插图}

Expand All @@ -10,6 +10,8 @@ \section{插图}
其他的栅格图应使用无损的 PNG 格式。
注意,LaTeX 不支持 TIFF 格式;EPS 格式已经过时。

建议图的大小一般为宽 \SI{6.67}{\centi\meter} \times\SI{5.00}{\centi\meter}。特殊情况下,也可为宽 \SI{9.00}{\centi\meter} \times\SI{6.75}{\centi\meter},或宽 \SI{13.5}{\centi\meter} \times\SI{9.00}{\centi\meter}。总之,一篇论文中,同类图片的大小应该一致,编排美观、整齐。图应尽可能显示在同一页(屏)。

\begin{figure}
\centering
\includegraphics[width=0.6\linewidth]{example-image-a.pdf}
Expand Down Expand Up @@ -261,7 +263,7 @@ \section{伪代码}
\end{algorithm}

\newpage
\section{测试}
\section{图表格式测试}

图题在图之下,段前空 6 磅,段后空 12 磅。图整体前后距离未定义,目前默认距离:段前空 12 磅,段后空 12 磅。

Expand Down Expand Up @@ -295,3 +297,79 @@ \section{测试}

表后,表后,表后,表后,表后,表后,表后,表后,表后,表后,表后。
\emph{图表前后是否有空行不影响图表与正文之间的距离}。


\section{条目编写}

\subsection{支持三级目录显示}

支持三级目录显示


\subsection{条目要求}

条目要求首行左缩进 2 个汉字符,避免悬挂缩进。如需使用带括号的条目列表,请自行添加 \verb|label=<style>| 参数。
下面是两个例子,还有更多用法,查阅 \pkg{enumitem} 宏包的文档。

默认条目序号:

\verb|\begin{enumerate} ... \end{enumerate}|

\begin{enumerate}
\item 一级
\begin{enumerate}
\item 二级
\begin{enumerate}
\item 三级
\begin{enumerate}
\item 四级,《写作要求》未定义,请自行定义或者选择。
\end{enumerate}
\end{enumerate}
\end{enumerate}
\end{enumerate}

自定义序号样式定义如表~\ref{tab:enum-style}。

\begin{table}[h]
\centering
\caption{条目样式选项}
\label{tab:enum-style}
\begin{tabular}{@{}ll@{}}
\toprule
\textbf{Code} & \textbf{Description} \\ \midrule
\textbackslash{}alph & Lowercase letter (a, b, c, ...) \\
\textbackslash{}Alph & Uppercase letter (A, B, C, ...) \\
\textbackslash{}arabic & Arabic number (1, 2, 3, ...) \\
\textbackslash{}roman & Lowercase Roman numeral (i, ii, iii, ...) \\
\textbackslash{}Roman & Uppercase Roman numeral (I, II, III, ...) \\ \bottomrule
\end{tabular}
\end{table}

\subsubsection{条目测试}


条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字。

\begin{enumerate}
\item 一级条目,超长行。南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学。
\item 一级条目,南方科技大学,南方科技大学,南方科技大学。
\item 一级条目,南方科技大学,南方科技大学,南方科技大学。
\begin{enumerate}
\item 二级条目,超长行。南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\begin{enumerate}
\item 三级条目,南方科技大学,南方科技大学,南方科技大学。
\item 三级条目,南方科技大学,南方科技大学,南方科技大学。
\item 三级条目,南方科技大学,南方科技大学,南方科技大学。
\begin{enumerate}
\item \textbf{四级条目及之后的条目无规定序号格式,请自行设定选择。}
\end{enumerate}
\end{enumerate}
\end{enumerate}
\end{enumerate}

条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字。
103 changes: 28 additions & 75 deletions data/chap04.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,42 @@ \chapter{引用文献的标注}

\section{顺序编码制}

依学校样式规定,一般使用 \cs{cite},即序号置于方括号中,引文页码会放在括号外。统一处引用的连续序号会自动用短横线连接。如多次引用同一文献,可能需要标注页码,例如:引用第二页\cite[2]{zhangkun1994},引用第五页\cite[5]{zhangkun1994}。
\thusetup{
cite-style = super,
}
% \citestyle{super} % 全局上标数字模式
% \bibliographystyle{sustechthesis-numeric}

在顺序编码制下,默认的 \cs{cite} 命令同 \cs{citep} 一样,即序号置于方括号中,引文页码会放在括号外。统一处引用的连续序号会自动用短横线连接。如多次引用同一文献,可能需要标注页码,例如:引用第二页\cite[2]{zhangkun1994},引用第五页\cite[5]{zhangkun1994}。

\begin{tabular}{l@{\quad$\Rightarrow$\quad}l}
\verb|\cite{zhangkun1994}| & \cite{zhangkun1994} {\kaishu 不带页码的上标引用} \\
\verb|\citet{zhangkun1994}| & \citet{zhangkun1994} \\
\verb|\citep{zhangkun1994}| & \citep{zhangkun1994} \\
\verb|\cite[42]{zhangkun1994}| & \cite[42]{zhangkun1994} {\kaishu 手动带页码的上标引用} \\
\verb|\cite{zhangkun1994,zhukezhen1973}| & \cite{zhangkun1994,zhukezhen1973} {\kaishu 一次多篇文献的上标引用} \\
\end{tabular}

\section{著者-出版年制}

著者-出版年制下的 \cs{cite} 跟 \cs{citet} 一样。

\thusetup{
cite-style = author-year,
}
\begin{tabular}{l@{\quad$\Rightarrow$\quad}l}
\verb|\cite{zhangkun1994}| & \cite{zhangkun1994} \\
\verb|\citet{zhangkun1994}| & \citet{zhangkun1994} \\
\verb|\citep{zhangkun1994}| & \citep{zhangkun1994} \\
\verb|\cite[42]{zhangkun1994}| & \cite[42]{zhangkun1994} \\
\verb|\citep{zhangkun1994,zhukezhen1973}| & \citep{zhangkun1994,zhukezhen1973} \\
\end{tabular}

\subsection{其他引用注意事项}

\thusetup{
cite-style = super,
}
注意,引文参考文献的每条都要在正文中标注
\cite{zhangkun1994,zhukezhen1973,dupont1974bone,zhengkaiqing1987,%
jiangxizhou1980,jianduju1994,merkt1995rotational,mellinger1996laser,%
Expand All @@ -30,80 +56,7 @@ \section{顺序编码制}
tushuguan1957tushuguanxue,aaas1883science,fugang2000fengsha,%
xiaoyu2001chubanye,oclc2000about,scitor2000project%
}。

引用测试:2个连续引用\cite{zhangkun1994,zhukezhen1973},2个间隔\cite{zhangkun1994,dupont1974bone},3个连续\cite{zhangkun1994,zhukezhen1973,dupont1974bone}。

如参考文献中需要使用上标或者下标,使用数学环境书写 \verb|$\mathrm{Ba}_{3}\mathrm{CoSb}_{2}\mathrm{O}_{9}$|,例如该文献\cite{kamiya2018nature}。根据 \pkg{gbt7714} 规定著者姓名自动转为大写。西文的题名、期刊名的大小写不自动处理,需要自行处理以符合信息资源本身文种的习惯用法。


\subsection{支持三级目录显示}

支持三级目录显示


\subsection{条目要求}

条目要求首行左缩进 2 个汉字符,避免悬挂缩进。如需使用带括号的条目列表,请自行添加 \verb|label=<style>| 参数。
下面是两个例子,还有更多用法,查阅 \pkg{enumitem} 宏包的文档。

默认条目序号:

\verb|\begin{enumerate} ... \end{enumerate}|

\begin{enumerate}
\item 一级
\begin{enumerate}
\item 二级
\begin{enumerate}
\item 三级
\begin{enumerate}
\item 四级,《写作要求》未定义,请自行定义或者选择。
\end{enumerate}
\end{enumerate}
\end{enumerate}
\end{enumerate}

自定义序号样式定义如表~\ref{tab:enum-style}。

\begin{table}[h]
\centering
\caption{条目样式选项}
\label{tab:enum-style}
\begin{tabular}{@{}ll@{}}
\toprule
\textbf{Code} & \textbf{Description} \\ \midrule
\textbackslash{}alph & Lowercase letter (a, b, c, ...) \\
\textbackslash{}Alph & Uppercase letter (A, B, C, ...) \\
\textbackslash{}arabic & Arabic number (1, 2, 3, ...) \\
\textbackslash{}roman & Lowercase Roman numeral (i, ii, iii, ...) \\
\textbackslash{}Roman & Uppercase Roman numeral (I, II, III, ...) \\ \bottomrule
\end{tabular}
\end{table}

\subsubsection{条目测试}


条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字,条目前文字。

\begin{enumerate}
\item 一级条目,超长行。南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学。
\item 一级条目,南方科技大学,南方科技大学,南方科技大学。
\item 一级条目,南方科技大学,南方科技大学,南方科技大学。
\begin{enumerate}
\item 二级条目,超长行。南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\item 二级条目,南方科技大学,南方科技大学,南方科技大学。
\begin{enumerate}
\item 三级条目,南方科技大学,南方科技大学,南方科技大学。
\item 三级条目,南方科技大学,南方科技大学,南方科技大学。
\item 三级条目,南方科技大学,南方科技大学,南方科技大学。
\begin{enumerate}
\item \textbf{四级条目及之后的条目无规定序号格式,请自行设定选择。}
\end{enumerate}
\end{enumerate}
\end{enumerate}
\end{enumerate}

条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字,条目后文字。
2 changes: 2 additions & 0 deletions data/conclusion.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@

结论应是作者在学位论文研究过程中所取得的创新性成果的概要总结,不能与摘要混为一谈。博士学位论文结论应包括论文的主要结果、创新点、展望三部分,在结论中应概括论文的核心观点,明确、客观地指出本研究内容的创新性成果(含新见解、新观点、方法创新、技术创新、理论创新),并指出今后进一步在本研究方向进行研究工作的展望与设想。对所取得的创新性成果应注意从定性和定量两方面给出科学、准确的评价,分(1)、(2)、(3)…条列出,宜用“提出了”、“建立了”等词叙述。

在评价自己的研究工作成果时,要实事求是,除非有足够的证据表明自己的研究是“首次”、“领先”、“填补空白”的,否则应避免使用这些或类似词语

\end{conclusion}
10 changes: 7 additions & 3 deletions sustech-setup.tex
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,17 @@
%%%%%% 顺序编码制的文献引用形式
%%%%%% 参考文献编译方式二选一,不要同时开启。
%%%% 选择一:使用 BibTeX + natbib 宏包
\usepackage[sort&compress]{gbt7714}
\citestyle{super} % 全局上标数字模式
% \citestyle{numbers} % 全局行内数字模式,在写作指南2022年8月23日版本已废弃, 并决定中英文都采用上标数字格式
\usepackage[sort&compress]{natbib}
% 全局上标数字模式
\bibliographystyle{sustechthesis-numeric}
% 全局著者-出版年制模式
% \bibliographystyle{sustechthesis-author-year}

%%%% 选择二:使用 BibLaTeX 宏包(兼容性不佳,不太推荐)
% 全局上标数字模式
% \usepackage[backend=biber,style=gb7714-2015,gbalign=left]{biblatex}
% 全局著者-出版年制模式
% \usepackage[backend=biber,style=gb7714-2015ay]{biblatex}
% \addbibresource{ref/refs.bib} % 声明 BibLaTeX 的数据库

% 定义所有的图片文件在 figures 子目录下
Expand Down
Loading

0 comments on commit 26a4ef0

Please sign in to comment.