sjtug · LogCreative · Nov 23, 2022 · Oct 19, 2022 · Oct 20, 2022 · Oct 21, 2022
diff --git a/.gitattributes b/.gitattributes
@@ -22,7 +22,10 @@ sjtuvi.sty linguist-generated=true
 beamerfontthemesjtubeamer.sty linguist-generated=true
 beamerouterthemesjtubeamer.sty linguist-generated=true
 sjtucover.sty linguist-generated=true
+
+# l3build generated file
 sjtubeamer.code-snippets linguist-generated=true
+MANIFEST.md linguist-generated=true
 
 # regression test target file
 *.tlg linguist-generated=true
diff --git a/.github/ci/build_contrib.sh b/.github/ci/build_contrib.sh
@@ -10,7 +10,7 @@ do
     latexmk $@ $theme.tex -shell-escape
     cp $theme.pdf build/$theme.pdf
     echo Compiling $theme preview ...
-    sed -e "s|<theme>|$theme|g" src/doc/contrib.template.tex > build/contrib.$theme.tex
+    sed -e "s|<theme>|$theme|g" src/support/contrib.template.tex > build/contrib.$theme.tex
     latexmk $@ -outdir=build build/contrib.$theme.tex
     echo Converting $theme to png...
     convert -verbose -density 500 -resize '1280' build/contrib.$theme.pdf build/contrib.$theme.png

diff --git a/.github/ci/build_package.sh b/.github/ci/build_package.sh
@@ -1,8 +1,12 @@
 #!/bin/bash
 
 cd src
-l3build ctan
+
 # This will trigger checkinit_hook() to move the files to the root directory.
+l3build ctan
+l3build cache-demo # cache demos for making the next ctan process faster
+l3build manifest
+l3build ctan
 
 cd ..
 .github/ci/copy_resources.sh

diff --git a/.github/ci/gen_cover.sh b/.github/ci/gen_cover.sh
@@ -5,17 +5,17 @@ set -e
 mkdir -p build
 
 # covers
-sed -e "s|<options>|red,light|g" src/doc/cover.template.tex > build/cover-red-light.tex
-sed -e "s|<options>|red,dark|g" src/doc/cover.template.tex > build/cover-red-dark.tex
-sed -e "s|<options>|blue,light|g" src/doc/cover.template.tex > build/cover-blue-light.tex
-sed -e "s|<options>|blue,dark|g" src/doc/cover.template.tex > build/cover-blue-dark.tex
+sed -e "s|<options>|red,light|g" src/support/cover.template.tex > build/cover-red-light.tex
+sed -e "s|<options>|red,dark|g" src/support/cover.template.tex > build/cover-red-dark.tex
+sed -e "s|<options>|blue,light|g" src/support/cover.template.tex > build/cover-blue-light.tex
+sed -e "s|<options>|blue,dark|g" src/support/cover.template.tex > build/cover-blue-dark.tex
 
 # compile covers
 latexmk $@ -outdir=build build/cover-*.tex
 
 # copy cover main file with removed last line
-cp -f src/doc/cover.tex build/cover.tex
-sed -e "s|\\\end{document}||g" src/doc/cover.tex > build/cover.tex
+cp -f src/support/cover.tex build/cover.tex
+sed -e "s|\\\end{document}||g" src/support/cover.tex > build/cover.tex
 
 # contrib
 for theme in contrib/*;

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -96,7 +96,8 @@ jobs:
       - uses: xu-cheng/texlive-action/full@v1
         with:
           run: |
-            apk add diffutils git make
+            apk add diffutils findutils git make
+            git config --global --add safe.directory /github/workspace
             make format-dev
       - name: check if generated files are of latest version
         run: |

diff --git a/.github/workflows/contrib.yml b/.github/workflows/contrib.yml
@@ -8,6 +8,8 @@ on:
     branches:
       - main
       - develop
+    types:
+      - 'review_requested'
     paths:
       - 'contrib/**'
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -114,3 +114,12 @@ jobs:
           asset_path: src/build/distrib/ctan/sjtubeamer/sjtubeamer.pdf
           asset_name: sjtubeamer.pdf
           asset_content_type: application/pdf
+      - name: add quickstart
+        uses: actions/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: src/build/distrib/ctan/sjtubeamer/sjtubeamerquickstart.pdf
+          asset_name: sjtubeamerquickstart.pdf
+          asset_content_type: application/pdf
diff --git a/.vscode/sjtubeamer.code-snippets b/.vscode/sjtubeamer.code-snippets
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,15 +3,14 @@
 SJTUBeamer 现在已经开放插件接口，存放于根目录的 `contrib/` 文件夹中。如果您实现了自己的主题模板，或者是基于 SJTUBeamer API 的插件，可以考虑通过下面的步骤向本存储库发 PR：
 1. fork 仓库，克隆自己的仓库到本地。
 2. 向你的电脑安装当前版本的 SJTUBeamer，`cd src && l3build install`，在 TeX 发布版中刷新文件名数据库，便于插件文档的编写。
-3. 在 `contrib` 文件夹中新建一个插件文件夹 `<theme>`
-4. 在文件夹中至少应该有下面两个文件：
+3. 使用 `l3build add-contrib <theme>` 命令在 `contrib` 文件夹中新建一个插件文件夹 `<theme>`，在文件夹中至少应该有下面两个文件：
     - 插件入口 `contrib/<theme>/sjtubeamertheme<theme>.ltx`
     - 插件文档 `contrib/<theme>/<theme>.tex`
-5. 如果在插件中需要使用相对于该插件目录的文件，请使用下面的 API：
+4. 如果在插件中需要使用相对于该插件目录的文件，请使用下面的 API：
     - `\getcontribdir{<theme>}` 返回插件目录 `contrib/<theme>`
     - `\getcontribpath{<theme>}{<filepath>}` 返回插件文件 `contrib/<theme>/<filepath>`
-6. 发 PR 时，使用 `contrib: <theme>` 作为标题，并向维护者发出代码审查请求。
-7. 之后在根目录的主文件中就可以在 `\usetheme{sjtubeamer}`（如果是子主题需要指定 `my` 参数）后使用 `\usesjtutheme{<theme>}` 调用你的插件。
+5. 发 PR 时，使用 `contrib: <theme>` 作为标题，并向维护者发出代码审查请求。
+6. 之后在根目录的主文件中就可以在 `\usetheme{sjtubeamer}`（如果是子主题需要指定 `my` 参数）后使用 `\usesjtutheme{<theme>}` 调用你的插件。
 
 更多信息，请参阅开发文档。
 
@@ -23,14 +22,13 @@ SJTUBeamer is available for receiving plugins, which are stored in `contrib/` fo
 1. Fork this repository and clone your own version to the machine.
 2. Install the current version of `SJTUBeamer` to your computer for the convenience of writing documentation.
 `cd src && l3build install`, then refresh the database of filenames in your TeX distribution.
-3. Create a new plugin folder `<theme>` in `contrib`.
-4. At least two files should be implemented in the folder:
+3. Use command `l3build add-contrib <theme>`. Create a new plugin folder `<theme>` in `contrib`. At least two files should be implemented in the folder:
     - Plugin entry point. `contrib/<theme>/sjtubeamertheme<theme>.ltx`
     - Plugin documentation. `contrib/<theme>/<theme>.tex`
-5. If you want to use the file in your plugin directory, use the following API:
+4. If you want to use the file in your plugin directory, use the following API:
     - `\getcontribdir{<theme>}` returns the plugin directory `contrib/<theme>`
     - `\getcontribpath{<theme>}{<filepath>}` returns plugin file path `contrib/<theme>/<filepath>`
-6. Pull request to this repo naming `contrib: <theme>`, request a review from one of the collaborators.
-7. Now, you could call your plugin by using `\usesjtutheme{<theme>}` (specify `my` option if it is a sub-theme) after `\usetheme{sjtubeamer}`.
+5. Pull request to this repo naming `contrib: <theme>`, request a review from one of the collaborators.
+6. Now, you could call your plugin by using `\usesjtutheme{<theme>}` (specify `my` option if it is a sub-theme) after `\usetheme{sjtubeamer}`.
 
 For more information, please refer to the development guide.
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@
 # User commands
 # ----------------
 
-LATEXINDENT_ARGS=-l latexindent.yaml -c build
+LATEXINDENT_ARGS=-l latexindent.yaml -c build -m -r
 LATEXMK_ARGS=-halt-on-error -time -xelatex -outdir=build -shell-escape
 
 all: build

diff --git a/README.md b/README.md
@@ -29,14 +29,16 @@ SJTUBeamer 是上海交通大学的非官方 Beamer 模版。您可以使用 SJT
 %   miniframes infolines  sidebar 
 %   default    smoothbars split	 
 %   shadow     tree       smoothtree
+% 使用 topright/bottomright 切换徽标位置
+% 使用逗号分隔列表以同时使用多种选项
 
 % \tikzexternalize[prefix=build/]
 % 如果您需要缓存 tikz 图像，请取消注释上一行，并在编译选项中添加 -shell-escape。
 
 \usepackage[backend=biber,style=gb7714-2015]{biblatex}
 \addbibresource{thesis.bib}
 
-\institute[SJTUG]{上海交通大学 Linux 用户组} % 组织
+\institute[Linux User Group]{Linux 用户组} % 组织
 
 \title{SJTUBeamer 幻灯片模板}         % 标题
 \subtitle{SJTUBeamer Template}       % 副标题
@@ -108,7 +110,7 @@ int main(){
 
 \part{参考文献}
 \begin{frame}[allowframebreaks]
-  \printbibliography[title=参考文献]
+  \printbibliography[heading=none]
 \end{frame}
 
 \makebottom       % 创建结束页
@@ -137,8 +139,9 @@ int main(){
   * 之后通过 `latexmk -xelatex main.tex` 命令进行编译即可。
   * VSCode 用户可以使用 LaTeX Workshop 中的 “Recipe: latexmk (latexmkrc)” 进行编译。
 
-目前模版最新的稳定版是 v2.9.0。您可以在 [发布页](https://github.com/sjtug/SJTUBeamer/releases) 查看修改日志和更多资料。通常来说，SJTUBeamer 的一个稳定版本包括如下内容：
+目前模版最新的稳定版是 v3.0.0。您可以在 [发布页](https://github.com/sjtug/SJTUBeamer/releases) 查看修改日志和更多资料。通常来说，SJTUBeamer 的一个稳定版本包括如下内容：
 
+* `sjtubeamerquickguide.pdf`：SJTUBeamer 快速入门。
 * `sjtubeamer.pdf`: **强烈推荐在使用前阅读一遍 👍👍👍** SJTUBeamer 用户文档。
 * `sjtubeamerdevguide.pdf`: SJTUBeamer 开发指南。
 * `sjtulib-talk-max-red.pdf`: 示例文档《如何使用 LaTeX 排版论文》的 `max,red` 主题版本。
@@ -149,10 +152,11 @@ int main(){
 * `sjtubeamer-ctan.zip`: 包含所有文档和样式的压缩包。
 * SJTUBeamer 源代码。
 
-请使用 Chrome 浏览器或 Adobe Acrobat 打开 SJTUBeamer 用户文档，以避免 pdf 兼容性导致的显示问题。
+请使用 Chrome 浏览器或 Adobe Acrobat 打开 SJTUBeamer 用户文档，以避免 PDF 兼容性导致的显示问题。
 
 ## 使用反馈与贡献代码 👷
 
+* 文件清单详见 [MANIFEST](src/MANIFEST.md)。
 * 您可以通过 GitHub Issue 反馈使用时碰到的问题。同时，也欢迎您提交 PR 帮助我们改进。
 * 所有对模版的修改应该在 `.dtx` 文件中进行，而后用 l3build 生成 sty 文件。
 * 您可以阅读发布页面中的《SJTUBeamer 开发指南》`sjtubeamerdevguide.pdf` 了解模版的实现细节与编译方法。

diff --git a/README_en.md b/README_en.md
@@ -27,14 +27,16 @@ Current document `main.tex` is an example documentation of *How to Use LaTeX to
 %   miniframes infolines  sidebar
 %   default    smoothbars split	 
 %   shadow     tree       smoothtree
+% use topright/bottomright to change the position of the logo.
+% use comma seperated list to use multiple options at the same time.
 
 % \tikzexternalize[prefix=build/]
 % To cache the tikz picture, please uncomment the previous line.
 
 \usepackage{biblatex}
 \addbibresource{thesis.bib}
 
-\institute[SJTUG]{Shanghai Jiao Tong University *nix User Group}
+\institute{Linux User Group}
 
 \title{SJTUBeamer}
 \subtitle{A Beamer Template}
@@ -103,7 +105,7 @@ int main(){
 
 \part{Bibliography}
 \begin{frame}[allowframebreaks]
-  \printbibliography
+  \printbibliography[heading=none]
 \end{frame}
 
 \makebottom       % create the bottom page
@@ -132,9 +134,10 @@ Edit `main.tex` and start to use.
   * Run `latexmk -xelatex main.tex` to compile
   * VSCode LaTeX Workshop: use “Recipe: latexmk (latexmkrc)” to compile
 
-The current stable version is v2.9.0。You could visit [the release page](https://github.com/sjtug/SJTUBeamer/releases) for the changelog and more details. Generally speaking, a release of SJTUBeamer has the following content:
+The current stable version is v3.0.0。You could visit [the release page](https://github.com/sjtug/SJTUBeamer/releases) for the changelog and more details. Generally speaking, a release of SJTUBeamer has the following content:
 
-* `sjtubeamer.pdf`: SJTUBeamer User Guide。**HIGHLY RECOMMENDED TO READ BEFORE YOU START👍👍👍**
+* `sjtubeamerquickstart.pdf`：SJTUBeamer Quick Start.
+* `sjtubeamer.pdf`: SJTUBeamer User Guide.
 * `sjtubeamerdevguide.pdf`: SJTUBeamer Development Guide.
 * `sjtulib-talk-max-red.pdf`: `max,red` version of `main.tex`.
 * `sjtulib-talk-maxplus-blue.pdf`: `maxplus,blue` version of `main.tex`.
@@ -148,6 +151,7 @@ Please use Chrome browser or Adobe Acrobat to open user guide, otherwise there c
 
 ## Feedback & Contribution 👷
 
+* You could get the repository manifest in [MANIFEST](src/MANIFEST.md).
 * Feel free to file an issue with GitHub Issues. At the same time, PRs are always welcomed.
 * The source code should be modified in `.dtx` files. Then use l3build to generate sty files.
 * You could get more implementation details in `sjtubeamerdevguide.pdf`.

diff --git a/beamercolorthemesjtubeamer.sty b/beamercolorthemesjtubeamer.sty
diff --git a/beamerfontthemesjtubeamer.sty b/beamerfontthemesjtubeamer.sty
diff --git a/beamerinnerthemesjtubeamer.sty b/beamerinnerthemesjtubeamer.sty
diff --git a/beamerouterthemesjtubeamer.sty b/beamerouterthemesjtubeamer.sty
diff --git a/beamerthemesjtubeamer.sty b/beamerthemesjtubeamer.sty
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,8 @@ on: @@
         branches:
           - main
           - develop
+        types:
+          - 'review_requested'
         paths:
           - 'contrib/**'
@@ Expand Down @@