docs: update demo (#158)

* docs: update copyright year * docs: update demo basis * docs: tip about removing max background (see #76) * ci: format introduction.tex * docs: update SJTUThesis related * chore: remove built-in demo title figure * docs: demo minor fix * fix: demo listings highlight * docs: rename thesis.bib to ref.bib * docs: tip about no-math (#148) and English (#155) * docs: remove unused packages * docs: adjust demo comment * docs: update link * docs: add white bg to demo cover
sjtug · Dec 2, 2023 · 768a943 · 768a943
1 parent 1afa5c0
commit 768a943
Show file tree

Hide file tree

Showing 13 changed files with 99 additions and 91 deletions.
diff --git a/contents/basis.tex b/contents/basis.tex
@@ -2,7 +2,7 @@
 % !TeX root = ../main.tex
 
 %% ------------------------------------------------------------------------
-%% Copyright (C) 2021,2022 SJTUG
+%% Copyright (C) 2021-2023 SJTUG
 %% 
 %% SJTUBeamer Example Document by SJTUG
 %% 
@@ -304,7 +304,9 @@ \subsection{\LaTeX{} 排版入门}
   \begin{columns}
     \begin{column}{.6\textwidth}
 
-      \begin{lstlisting}[basicstyle=\ttfamily\small]
+      \begin{lstlisting}[basicstyle=\ttfamily\small,morekeywords={
+        tableofcontents, part, chapter, section, subsection, subsubsection,
+        paragraph, subparagraph}]
 \tableofcontents % 这里是目录
 \part{有监督学习}
 \chapter{支持向量机}
@@ -383,7 +385,7 @@ \subsubsection{支持向量机的诞生}
 \begin{figure}[htbp]
   \centering
   \includegraphics[height=.2\textheight]%
-  {libicon.pdf}
+  {sjtu-badge-blue.pdf}
   \caption{交大校徽。}
   \label{fig:badge}
 \end{figure}
@@ -397,6 +399,7 @@ \subsubsection{支持向量机的诞生}
 \end{frame}
 
 \begin{frame}[fragile]{交叉引用与插入表格}
+  \vspace{-1.5em}
   \begin{columns}
     \column{.6\textwidth}
     \begin{lstlisting}
@@ -628,7 +631,7 @@ \subsection{论文模板使用}
     \begin{itemize}
       \item 获取模板：已随发行版自带
             \begin{itemize}
-              \item 在安装目录 \verb|<prefix>\texlive\2021\texmf-dist\doc\latex\IEEEtran|
+              \item 在安装目录 \verb|<prefix>/texlive/2023/texmf-dist/doc/latex/IEEEtran|
                     下找到 \verb|bare_jrnl.tex|
               \item 复制到某个文件夹(比如个人存论文的目录)
             \end{itemize}
@@ -639,4 +642,4 @@ \subsection{论文模板使用}
             \end{itemize}
     \end{itemize}
   \end{block}
-\end{frame}
+\end{frame}
diff --git a/contents/introduction.tex b/contents/introduction.tex
@@ -2,7 +2,7 @@
 % !TeX root = ../main.tex
 
 %% ------------------------------------------------------------------------
-%% Copyright (C) 2021,2022 SJTUG
+%% Copyright (C) 2021-2023 SJTUG
 %% 
 %% SJTUBeamer Example Document by SJTUG
 %% 
@@ -258,7 +258,7 @@ \subsection{安装}
     \item \TL
           \begin{itemize}
             \item 跨平台：Windows, Linux, macOS (\MacTeX{} $\approx$ \TL)
-            \item 每年四月左右发布以年份命名的新版本，当前为 \TL 2021
+            \item 每年四月左右发布以年份命名的新版本，当前为 \TL{} 2023
             \item 官方维护，入门首选
           \end{itemize}
     \item \MiKTeX
@@ -281,7 +281,7 @@ \subsection{安装}
   \begin{itemize}
     \item 注意!
           \begin{itemize}
-            \item 新手建议安装完整版 \TL (\MacTeX)
+            \item 新手建议安装完整版 \TL{} (\MacTeX)
             \item 建议使用 ISO 镜像离线安装
             \item 在线安装要求网络稳定
             \item Windows 下不要放在带有中文的路径中
@@ -337,10 +337,10 @@ \subsection{安装}
     \item Linux
           \begin{itemize}
             \item 添加环境变量到 \nolinkurl{~/.bashrc} 文件：
-                  \begin{lstlisting}[language=bash]
-export PATH=/usr/local/texlive/2021/bin/x86_64-linux:$PATH
-export MANPATH=/usr/local/texlive/2021/texmf/doc/man:$MANPATH
-export INFOPATH=/usr/local/texlive/2021/texmf/doc/info:$INFOPATH
+                  \begin{lstlisting}[language=sh]
+export PATH=/usr/local/texlive/2023/bin/x86_64-linux:$PATH
+export MANPATH=/usr/local/texlive/2023/texmf/doc/man:$MANPATH
+export INFOPATH=/usr/local/texlive/2023/texmf/doc/info:$INFOPATH
           \end{lstlisting}
             \item 安装一个 dummy package，让系统的包管理器知道 \TL 已经装过了
                   \begin{itemize}
@@ -368,15 +368,16 @@ \subsection{安装}
   \begin{itemize}
     \item 专用编辑器
           \begin{itemize}
-            \item TeXworks、TeXShop、\alert{TeXStudio}、TeXmaker、WinEdt 等
+            \item TeXworks、TeXShop、\alert{TeXstudio}、TeXmaker、WinEdt 等
           \end{itemize}
     \item 通用编辑器（安装 \LaTeX{} 插件）
           \begin{itemize}
             \item Vim、Emacs、\alert{VS Code}、Sublime、Atom 等
           \end{itemize}
     \item 在线协作平台
           \begin{itemize}
-            \item OverLeaf \link{https://www.overleaf.com/}, \sout{ShareLaTeX}（已经与前者合并）
+            \item OverLeaf \link{https://www.overleaf.com/}, \TeX{} Page
+                  \link{https://www.texpage.com}
             \item 交大 LaTeX 文档助手 \link{https://latex.sjtu.edu.cn/}（基于 OverLeaf）
           \end{itemize}
     \item 编辑器对比：\link{https://tex.stackexchange.com/q/339}

diff --git a/contents/summary.tex b/contents/summary.tex
@@ -2,7 +2,7 @@
 % !TeX root = ../main.tex
 
 %% ------------------------------------------------------------------------
-%% Copyright (C) 2021,2022 SJTUG
+%% Copyright (C) 2021-2023 SJTUG
 %% 
 %% SJTUBeamer Example Document by SJTUG
 %% 
@@ -66,7 +66,7 @@ \section{总结}
 
 \begin{frame}[fragile]{利用文档}
   \begin{itemize}
-    \item 常用文档
+    \item 常用文档（\verb|texdoc <package>|）
           \begin{itemize}
             \item \pkg{symbols}: 符号大全
             \item \pkg{Mathmode}: 数学参考
@@ -80,7 +80,7 @@ \section{总结}
             \item \verb|texdoc|: \TeX{} 文档查看器\\
                   例如：\verb|texdoc lshort-zh-cn|
             \item 在线文档 \TeX{}doc \link{http://texdoc.net/}
-            \item TeX Studio 和 WinEdt 都支持在帮助里看文档
+            \item \TeX{}studio 和 WinEdt 都支持在帮助里看文档
           \end{itemize}
   \end{itemize}
 \end{frame}
@@ -118,7 +118,7 @@ \section{总结}
             \item 撤销与回滚：\verb|git reset|、\verb|git revert|
             \item 分支与高级用法：\verb|git branch|、\verb|git checkout|
                   \verb|git rebase|
-            \item 远端仓库操作：\verb|git pull|、\verb|git push|
+            \item 远端仓库操作：\verb|git pull|、\verb|git push|、
                   \verb|git fetch|
             \item 推荐用 VS Code 等进行可视化操作
             \item 参考链接：\link{https://git-scm.com/book/en/v2}
@@ -140,7 +140,7 @@ \section{总结}
       \begin{itemize}
         \item BBS
               \begin{itemize}
-                \item 水源社区 \link{https://dev.bbs.sjtu.edu.cn/}
+                \item 水源社区 \link{https://shuiyuan.sjtu.edu.cn/tag/latex}
                 \item \sout{\CTeX 社区} （已关闭） \link{http://bbs.ctex.org/}
                 \item 转移到 GitHub 的 \CTeX 社区
                       \link{https://github.com/CTeX-org/forum}
@@ -167,4 +167,4 @@ \section{总结}
     \item 科普、答疑
     \item \sout{来当主讲人}
   \end{itemize}
-\end{frame}
+\end{frame}
diff --git a/contents/thesis.tex b/contents/thesis.tex
@@ -2,7 +2,7 @@
 % !TeX root = ../main.tex
 
 %% ------------------------------------------------------------------------
-%% Copyright (C) 2021,2022 SJTUG
+%% Copyright (C) 2021-2023 SJTUG
 %% 
 %% SJTUBeamer Example Document by SJTUG
 %% 
@@ -18,22 +18,24 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
 
 \begin{frame}{\SJTUThesis}
   \framesubtitle{上海交通大学学位论文 \LaTeX{} 模板}
-  \begin{itemize}
-    \item 最早由韦建文于 2009 年 11 月发布 0.1a 版，2018 年起由 SJTUG 接手维护
-    \item 最新版：\SJTUThesisVersion{} (\SJTUThesisDate)
-    \item 支持本科、硕士、博士学位论文以及课程论文的排版
-  \end{itemize}
-  \begin{figure}[htbp]
-    \centering
-    \includegraphics[height=.4\textheight]
-    {sjtuthesis-bachelor-crop.pdf}\hspace{6pt}
-    \includegraphics[height=.4\textheight]
-    {sjtuthesis-master-crop.pdf}\hspace{6pt}
-    \includegraphics[height=.4\textheight]
-    {sjtuthesis-doctor-crop.pdf}\hspace{6pt}
-    \includegraphics[height=.4\textheight]
-    {sjtuthesis-course-crop.pdf}
-  \end{figure}
+  \begin{columns}
+    \begin{column}{.7\textwidth}
+      \begin{itemize}
+        \item 最早由韦建文于 2009 年 11 月发布 0.1a 版，2018 年起由 SJTUG 接手维护
+        \item 最新版：\SJTUThesisVersion{} (\SJTUThesisDate)
+        \item 支持本科、硕士、博士学位论文以及课程论文的排版
+      \end{itemize}
+    \end{column}
+    \begin{column}{.2\textwidth}
+      \begin{figure}[htbp]
+        \centering
+        {
+          \setlength{\fboxsep}{0pt}
+          \fcolorbox{black}{white}{\includegraphics[height=.5\textheight]{sjtuthesis-cover.pdf}}
+        }
+      \end{figure}
+    \end{column}
+  \end{columns}
 \end{frame}
 
 \begin{frame}[fragile]{获取\SJTUThesis{}}
@@ -49,7 +51,7 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
         \item 下载最新开发版（高级 / 想尝鲜 / 着急的用户）
               \begin{itemize}
                 \item \url{https://github.com/sjtug/SJTUThesis}
-                \item 切换到 \verb|develop| 分支，点右边栏
+                \item 点右边栏
                       \href{https://github.com/sjtug/SJTUThesis/archive/dev.zip}{Download ZIP} 按钮
               \end{itemize}
         \item 编译
@@ -73,7 +75,7 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
 
 \begin{frame}[fragile]{模板选项}
   \begin{description}
-    \item[type] 指定论文类型（本科/硕士/博士/课程）
+    \item[type] 指定论文类型（本科/硕士/博士）
           \begin{lstlisting}[basicstyle=\ttfamily]
 \documentclass[type=bachelor]{sjtuthesis}
   \end{lstlisting}
@@ -93,16 +95,16 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
   \begin{lstlisting}
 \sjtusetup{
   info = {
-    title             = {上海交通大学学位论文 \LaTeX{} 模板示例文档},
-    title*            = {A Sample for \LaTeX-based SJTU Thesis Template},
-    author            = {某\quad{}某},
-    author*           = {Mo Mo},
+    zh/title  = {上海交通大学学位论文 \LaTeX{} 模板示例文档},
+    en/title  = {A Sample for \LaTeX-based SJTU Thesis Template},
+    zh/author = {某\quad{}某},
+    en/author = {Mo Mo},
   },
   style = {
-    header-logo-color = red,
+    title-logo-color = red,
   },
   name = {
-    publications      = {攻读学位期间完成的论文},
+    achv = {攻读学位期间完成的论文},
   },
 }
   \end{lstlisting}
@@ -114,30 +116,26 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
     \centering
     \footnotesize
     \begin{tabular}{lll} \toprule
-      命令作用   & 中文对应选项                            & 英文对应选项                 \\ \midrule
-      论文标题   & \verb|title|                      & \verb|title*|
-      \\
-      关键字列表  & \verb|keywords|                   & \verb|keywords*|       \\
-      作者姓名   & \verb|author|                     & \verb|author*|         \\
-      申请学位名称 & \verb|degree|                     & \verb|degree*|         \\
-      院系名称   & \verb|department|                 & \verb|department*|     \\
-      专业名称   & \verb|major|                      & \verb|major*|          \\
-      导师     & \verb|supervisor|                 & \verb|supervisor*|
-      \\
-      副导师    & \verb|assisupervisor|             & \verb|assisupervisor*|
-      \\
-      日期     & \multicolumn{2}{c}{\texttt{date}}
-      \\
-      学号     & \multicolumn{2}{c}{\texttt{id}}
-      \\
-      \bottomrule
+      命令作用   & 中文对应选项                            & 英文对应选项                       \\ \midrule
+      论文标题   & \texttt{zh/title}                 & \texttt{en/title}            \\
+      关键字列表  & \texttt{zh/keywords}              & \texttt{en/keywords}         \\
+      作者姓名   & \texttt{zh/author}                & \texttt{en/author}           \\
+      申请学位名称 & \texttt{zh/degree}                & \texttt{en/degree}           \\
+      院系名称   & \texttt{zh/department}            & \texttt{en/department}       \\
+      专业名称   & \texttt{zh/major}                 & \texttt{en/major}            \\
+      导师     & \texttt{zh/supervisor}            & \texttt{en/supervisor}       \\
+      副导师    & \texttt{zh/assoc-supervisor}      & \texttt{en/assoc-supervisor} \\
+      联培导师   & \texttt{zh/co-supervisor}         & \texttt{en/co-supervisor}    \\
+      日期     & \multicolumn{2}{c}{\texttt{date}}                                \\
+      学号     & \multicolumn{2}{c}{\texttt{id}}                                  \\ \bottomrule
     \end{tabular}
   \end{table}
 \end{frame}
 
 \begin{frame}[fragile]{数学}
   \begin{itemize}
-    \item 公式示例：\nolinkurl{contents/math_and_citations.tex}
+    \item 公式示例：\verb|contents/math_and_citations.tex|
+          \link{https://github.com/sjtug/SJTUThesis/blob/master/contents/math_and_citations.tex}
     \item \SJTUThesis{} 定义了常用的数学环境（需要手工引入 \verb|amsthm| 宏包）：
           \begin{table}[h]
             \centering
@@ -194,7 +192,7 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
     \cite{key12, key13}
           \end{lstlisting}
             \item 正文模式：如“文献~[14] 证明了……”
-                  \begin{lstlisting}[basicstyle=\ttfamily]
+                  \begin{lstlisting}[basicstyle=\ttfamily,morekeywords={parencite}]
     \parencite{key14}
           \end{lstlisting}
           \end{itemize}
@@ -206,7 +204,8 @@ \subsection{\SJTUThesis 上海交通大学学位论文模板}
     \item 常见问题
           \begin{itemize}
             \item 参考文献列表出错、缺少字体、无法编译、格式不对……
-            \item 阅读模板文档 \verb|sjtuthesis.pdf| 和 SJTUThesis 示例文档代码
+            \item 阅读模板文档 \verb|sjtutex.pdf| \link{https://github.com/sjtug/SJTUTeX/releases}
+                  和 SJTUThesis 示例文档代码
             \item 查看 Wiki \link{https://github.com/sjtug/SJTUThesis/wiki}
           \end{itemize}
 

diff --git a/figures/sjtuthesis-bachelor-crop.pdf b/figures/sjtuthesis-bachelor-crop.pdf
diff --git a/figures/sjtuthesis-course-crop.pdf b/figures/sjtuthesis-course-crop.pdf
diff --git a/figures/sjtuthesis-cover.pdf b/figures/sjtuthesis-cover.pdf
diff --git a/figures/sjtuthesis-doctor-crop.pdf b/figures/sjtuthesis-doctor-crop.pdf
diff --git a/figures/sjtuthesis-master-crop.pdf b/figures/sjtuthesis-master-crop.pdf
diff --git a/figures/title-background.jpg b/figures/title-background.jpg