Skip to content

Commit

Permalink
feat: bump version to 2.0 (#58)
Browse files Browse the repository at this point in the history 
Signed-off-by: Alex Chi <[email protected]>

Co-authored-by: LogCreative <[email protected]>
  • Loading branch information
@skyzh @LogCreative
skyzh and LogCreative authored Sep 4, 2021
1 parent fadb4f9 commit 4f765b5
Show file tree
Hide file tree
Showing 3 changed files with 164 additions and 46 deletions.
26 changes: 14 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,21 @@ int main(){
### 模版下载与编译

* Overleaf
* 下载 [最新版](https://github.com/sjtug/SJTUBeamer/archive/refs/heads/main.zip) 压缩包。
* 或下载 [v1.5.0](https://github.com/sjtug/SJTUBeamer/archive/refs/tags/v1.5.0.zip) 压缩包。
* 下载开发版压缩包。页面右上角 Code - Download Zip 即可。
* 或下载 [最新版](https://github.com/sjtug/SJTUBeamer/releases) 压缩包。点击 “Source Code (zip)” 即可下载。
* 上传至 Overleaf 使用即可。
* Overleaf 的设置中需要选择“XeLaTeX”编译器编译。
* 本地使用
* 安装 TeXLive 套件。
* 下载 [最新版](https://github.com/sjtug/SJTUBeamer/archive/refs/heads/main.zip) 压缩包。
* 或下载 [v1.5.0](https://github.com/sjtug/SJTUBeamer/archive/refs/tags/v1.5.0.zip) 压缩包。
* 或使用 git 克隆仓库 `git clone https://github.com/sjtug/SJTUBeamer/`。
* 使用 git 克隆仓库 `git clone https://github.com/sjtug/SJTUBeamer/`。
* 或下载开发版压缩包。页面右上角 Code - Download Zip 即可。
* 或下载 [最新版](https://github.com/sjtug/SJTUBeamer/releases) 压缩包。点击 “Source Code (zip)” 即可下载。
* 之后通过 `latexmk -xelatex main.tex` 命令进行编译即可。
* VSCode 用户可以使用 LaTeX Workshop 中的 “Recipe: latexmk (latexmkrc)” 进行编译。

目前模版最新的稳定版是 v1.5.0。您可以在 [发布页](https://github.com/sjtug/SJTUBeamer/releases/tag/v1.5.0) 查看修改日志和更多资料。通常来说，SJTUBeamer 的一个稳定版本包括如下内容：
目前模版最新的稳定版是 v2.0.0。您可以在 [发布页](https://github.com/sjtug/SJTUBeamer/releases) 查看修改日志和更多资料。通常来说，SJTUBeamer 的一个稳定版本包括如下内容：

* `sjtubeamer.pdf`: SJTUBeamer 用户文档。**强烈推荐在使用前阅读一遍 👍👍👍。**
* `sjtubeamer.pdf`: **强烈推荐在使用前阅读一遍 👍👍👍** SJTUBeamer 用户文档。
* `sjtubeamerdevguide.pdf`: SJTUBeamer 开发指南。
* `sjtulib-talk-max-red.pdf`: 示例文档《如何使用 LaTeX 排版论文》的 `max,red` 主题版本。
* `sjtulib-talk-maxplus-blue.pdf`: 示例文档《如何使用 LaTeX 排版论文》的 `maxplus,blue` 主题版本。
Expand All @@ -147,6 +147,8 @@ int main(){
* `sjtubeamer-ctan.zip`: 包含所有文档和样式的压缩包。
* SJTUBeamer 源代码。

请使用 Chrome 浏览器或 Adobe Acrobat 打开 SJTUBeamer 用户文档，以避免 pdf 兼容性导致的显示问题。

## 使用反馈与贡献代码 👷

* 您可以通过 GitHub Issue 反馈使用时碰到的问题。同时，也欢迎您提交 PR 帮助我们改进。
Expand All @@ -166,15 +168,15 @@ int main(){

## 展示 🧐

![cover-0](https://user-images.githubusercontent.com/4198311/131241659-90f0804b-d0b1-4bb9-b45c-7d3c81ace02a.png)
![cover-1](https://user-images.githubusercontent.com/4198311/131241665-2ced7884-7428-4967-8055-6ce47de7f8bd.png)
![cover-2](https://user-images.githubusercontent.com/4198311/131241668-cc47d9fb-14c4-4681-b95d-98400e9b8d77.png)
![cover-3](https://user-images.githubusercontent.com/4198311/131241669-ccf58f17-d35f-492d-8707-2cfdbd613107.png)
![cover-0](https://user-images.githubusercontent.com/4198311/132097433-3c44d6f6-47e1-4d38-95db-560252ec5817.png)
![cover-1](https://user-images.githubusercontent.com/4198311/132097442-0994886f-3eb1-4935-a8f5-34f5516fcdc3.png)
![cover-2](https://user-images.githubusercontent.com/4198311/132097445-6fbfeb22-8e19-4c48-ab1e-ba81672e7ba3.png)
![cover-3](https://user-images.githubusercontent.com/4198311/132097448-f3c44794-3834-4c4f-8a9a-769098aad8a9.png)

## 许可证

SJTUBeamer 仓库同时包含 SJTUBeamer 包和一个示例文档。其中内容的许可证各不相同。您可以阅读各个文件的开头部分，了解该文件所使用的许可证。

* SJTUBeamer 包使用的许可证为 Apache-2.0。
* SJTUBeamer 示例文档使用 CC-BY-SA 4.0 许可。
* sjtuvi 和 sjtucover 库及其附属徽标、图片由上海交通大学持有版权。校属各单位及个人以经营为目的使用视觉形象识别系统，须向学校申请使用许可。校外单位及个人未经许可，不得制作或使用载有视觉形象识别系统的物品。
* sjtuvi 和 sjtucover 库及其附属徽标、图片由上海交通大学持有版权。校属各单位及个人以经营为目的使用视觉形象识别系统，须向学校申请使用许可。校外单位及个人未经许可，不得制作或使用载有视觉形象识别系统的物品。您可以在 [vi.sjtu.edu.cn](https://vi.sjtu.edu.cn/index.php/articles/bulletin/16) 阅读许可协议。
176 changes: 146 additions & 30 deletions README_en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,21 @@ Welcome! 🥳

This is the beamer template exclusively for Shanghai Jiaotong University students to give a speech on group meeting or course project.

## Usage 🧰

For Overleaf users, you can directly download the zip file from github and upload it to https://latex.sjtu.edu.cn to use this template.

If you want to use this template locally, simply download zip file and run `latexmk -xelatex`.
## Starting Up 👋

## Design Philosophy 💭
Current document `main.tex` is an example documentation of *How to Use LaTeX to Typeset Thesis*. You could replace the content with the following minimum working example:

To design the template as simple as possible, since everyone can modify it according to their preferences with a little knowledge of LaTeX syntax and beamer.
<details>

## Contribution 👷

Feel free to file an issue with GitHub Issues. At the same time, PRs are always welcomed.

> After modifying the corresponding source code in src/source, run .github/ci/build_package.sh in bash to build the package and update the sty files.
> For Windows users, before the next edition of l3build is released, please run
```cmd
cd src/source
latex beamerthemesjtubeamer.ins
```
and copy the corresponding files to the correct directory.
<summary>Expand to show the code block</summary>

## Test Version

You could get different styles from the following keywords.
```latex
\documentclass[
% draft, % draft mode
aspectratio=169, % use 16:9 ratio
]{beamer}
\mode<presentation>
\usetheme[maxplus]{sjtubeamer}
% use maxplus/max/min to change covers.
% use red/blue to change main color.
Expand All @@ -39,22 +28,149 @@ You could get different styles from the following keywords.
% default smoothbars split
% shadow tree smoothtree
% *siderbar is recommended to be used with max option.
\usepackage{biblatex}
\addbibresource{thesis.bib}
\institute[SJTUG]{Shanghai Jiao Tong University *nix User Group}
\title{SJTUBeamer}
\subtitle{A Beamer Template}
\author{SJTUG}
\date{\today}
\begin{document}
\maketitle
\part{Intro}
\AtBeginSection[]{
\begin{frame}
\sectionpage
\end{frame}
}
\section{Basics}
\begin{frame}
\frametitle{Title}
\paragraph{List} This \alert{slide} contains the following items:
\begin{itemize}
\item Item 1
\item Item 2
\item Item 3
\end{itemize}
\end{frame}
\begin{frame}
\frametitle{Title}
\framesubtitle{Subtitle}
\begin{equation}
x^2+2x+1=(x+1)^2
\end{equation}
\end{frame}
\section{Blocks}
\begin{frame}
\frametitle{Some boxes}
\begin{block}{block}
This is a box.
% \cite{<thelegendofjiang>}
\end{block}
\begin{alertblock}{alertblock}
Text.
\end{alertblock}
\begin{exampleblock}{exampleblock}
Text.
\end{exampleblock}
\end{frame}
\begin{frame}[fragile] % fragile
\frametitle{codeblock}
\begin{codeblock}[language=c++]{C++ Code}
#include<iostream>
int main(){
// Console Output
std::cout << "Hello, SJTU!" << std::endl;
return 0;
}
\end{codeblock}
\end{frame}
\part{Bibliography}
\begin{frame}[allowframebreaks]
\printbibliography
\end{frame}
\makebottom % create the bottom page
\end{document}
```

## Appearance 🧐
</details>

**Blue theme cover page**
## Usage 🧰

![page001](https://user-images.githubusercontent.com/4198311/119085675-be619a80-ba36-11eb-878f-609b2882dc35.png)
Edit `main.tex` and start to use.

**Red theme cover page**
### Template Download & Compilation

![page001](https://user-images.githubusercontent.com/4198311/119085697-c7526c00-ba36-11eb-8a70-296f8f36c2d6.png)
* Overleaf
* Download the development version by clicking "Code - Download Zip".
* Or download [the latest version](https://github.com/sjtug/SJTUBeamer/releases). Click "Source Code (zip)" to download.
* Upload to Overleaf.
* Set to "XeLaTeX" for compilation.
* Local Use
* Install TeXLive.
* Run `git clone https://github.com/sjtug/SJTUBeamer/`.
* Or download the development version by clicking "Code - Download Zip".
* Or download [the latest version](https://github.com/sjtug/SJTUBeamer/releases). Click "Source Code (zip)" to download.
* Run `latexmk -xelatex main.tex` to compile
* VSCode LaTeX Workshop: use “Recipe: latexmk (latexmkrc)” to compile

The current stable version is v2.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👍👍👍**
* `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`.
* `sjtulib-talk-maxplus-red.pdf`: `maxplus,red` version of `main.tex`.
* `sjtulib-talk-min-red.pdf`: `min,red` version of `main.tex`.
* `sample-all-covers.pdf`: all covers (title page and bottom page).
* `sjtubeamer-ctan.zip`: the installation package.
* SJTUBeamer source code.

Please use Chrome browser or Adobe Acrobat to open user guide, otherwise there could be display issues.

## Feedback & Contribution 👷

* 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`.

The development process is as follows:

* Modify `.dtx` files.
* Run `make generate` and copy the style file to the root.
* Update `main.tex`, and run `make build` for previewing modification.
* Update dev guide, and run `make build-dev` ro compile the doc and run tests.
* (Optional) Run `make format-dev` to format all the files.
* Submit a Pull Request.

New contributors could add your name to the developer list in `sjtubeamerdevguide.tex`.

## Appearance 🧐

**Normal cover page**
![cover-0](https://user-images.githubusercontent.com/4198311/132097433-3c44d6f6-47e1-4d38-95db-560252ec5817.png)
![cover-1](https://user-images.githubusercontent.com/4198311/132097442-0994886f-3eb1-4935-a8f5-34f5516fcdc3.png)
![cover-2](https://user-images.githubusercontent.com/4198311/132097445-6fbfeb22-8e19-4c48-ab1e-ba81672e7ba3.png)
![cover-3](https://user-images.githubusercontent.com/4198311/132097448-f3c44794-3834-4c4f-8a9a-769098aad8a9.png)

![page001](https://user-images.githubusercontent.com/4198311/118810621-aa0a8a00-b8de-11eb-907e-6342c156ea53.png)
## License

**Red theme slides**

![page004](https://user-images.githubusercontent.com/4198311/118810609-a70f9980-b8de-11eb-84b3-68918c905817.png)
* SJTUBeamer is licensed under Apache-2.0.
* SJTUBeamer is licensed under CC-BY-SA 4.0.
* sjtuvi and sjtucover library and related graphics is under [No commercial](https://vi.sjtu.edu.cn/index.php/articles/bulletin/16).
8 changes: 4 additions & 4 deletions src/doc/cover.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
\usepackage{pdfpages}
\includepdfset{fitpaper=true,pages=1-last}
\begin{document}
\includepdf{cover-red-dark.pdf}
\includepdf{cover-red-light.pdf}
\includepdf{cover-blue-dark.pdf}
\includepdf{cover-blue-light.pdf}
\includepdf[nup=3x3,frame=true]{cover-red-dark.pdf}
\includepdf[nup=3x3,frame=true]{cover-red-light.pdf}
\includepdf[nup=3x3,frame=true]{cover-blue-dark.pdf}
\includepdf[nup=3x3,frame=true]{cover-blue-light.pdf}
\end{document}

0 comments on commit 4f765b5

Please sign in to comment.