├── chapters ├── Pre_Abstract.tex ├── Ch_Conclusion.tex ├── Pre_Dedication.tex ├── Pre_Acknowledgements.tex ├── Pre_Preface.tex ├── Ch_Introduction.tex ├── Appendix_Publications.tex ├── Appendix_Figures.tex ├── Appendix_Requirements.tex └── Ch_ExampleChapter.tex ├── docs ├── _config.yml └── index.md ├── latexmkrc ├── .github └── workflows │ ├── build.yml │ ├── test.yml │ └── release.yml ├── Makefile ├── resources └── ProjectLogo │ ├── HKUSTThesisLogoTeX.tex │ ├── redbird-raw.svg │ └── qrcode2github.svg ├── README_CN.md ├── mythesis_LoP.bib ├── .vscode └── settings.json ├── README.md ├── .gitignore ├── mythesis.bib ├── mythesis.tex └── LICENSE /chapters/Pre_Abstract.tex: -------------------------------------------------------------------------------- 1 | \begin{abstract} 2 | 3 | \blindtext[2] 4 | 5 | \end{abstract} 6 | -------------------------------------------------------------------------------- /chapters/Ch_Conclusion.tex: -------------------------------------------------------------------------------- 1 | \chapter{Conclusions}\label{chap:conclusions} 2 | 3 | Some conclusion text. 4 | -------------------------------------------------------------------------------- /chapters/Pre_Dedication.tex: -------------------------------------------------------------------------------- 1 | \begin{dedication} 2 | Dedicated to someone like you. 3 | \end{dedication} 4 | -------------------------------------------------------------------------------- /chapters/Pre_Acknowledgements.tex: -------------------------------------------------------------------------------- 1 | \begin{acknowledgements} 2 | 3 | Thank you, all the Evangelion. 4 | 5 | \end{acknowledgements} 6 | -------------------------------------------------------------------------------- /chapters/Pre_Preface.tex: -------------------------------------------------------------------------------- 1 | \begin{preface} 2 | 3 | Some preface text. 4 | 5 | \begin{flushright} 6 | Author\\ 7 | 2021. HK 8 | \end{flushright} 9 | 10 | \end{preface} 11 | -------------------------------------------------------------------------------- /chapters/Ch_Introduction.tex: -------------------------------------------------------------------------------- 1 | \chapter{Introduction}\label{chap:introduction} 2 | 3 | Please read the \href{https://github.com/HKFoggyU/hkust-thesis/releases}{latest version} of the documentation for this thesis template. -------------------------------------------------------------------------------- /docs/_config.yml: -------------------------------------------------------------------------------- 1 | title: HKUST-Thesis 2 | description: LaTeX3 Template for HKUST Thesis (Ph.D. or MPhil.) 3 | theme: jekyll-theme-slate 4 | show_downloads: true 5 | github: 6 | zip_url: https://github.com/HKFoggyU/hkust-thesis/releases/latest 7 | tar_url: https://github.com/HKFoggyU/hkust-thesis/releases/latest -------------------------------------------------------------------------------- /chapters/Appendix_Publications.tex: -------------------------------------------------------------------------------- 1 | \chapter{List of Publications} 2 | % "List of Publications" citations can be stored in `mythesis.bib` or, 3 | % another bib file, remember to add its name in `\addbibresource{}` 4 | 5 | % Journal Publications 6 | \paperlist[Journal Publications]{ 7 | ChaiACSNano2022, % check the differences between these two items 8 | LoP.ChaiACSNano2022, 9 | } 10 | 11 | % Conference Publications 12 | \paperlist[Conference Publications]{ 13 | LuConf.LasersElectro-Opt.2021Pap.SW3B12021, 14 | JehleImagingAppl.Opt.20162016Pap.IM4F22016, 15 | } 16 | 17 | % You can add customized title name in the [] 18 | -------------------------------------------------------------------------------- /latexmkrc: -------------------------------------------------------------------------------- 1 | # vim: set ft=perl: 2 | 3 | $pdf_mode = 5; 4 | 5 | $xelatex = "xelatex -shell-escape -file-line-error -halt-on-error -interaction=nonstopmode -no-pdf -synctex=1 %O %S"; 6 | $xdvipdfmx = "xdvipdfmx -q -E -o %D %O %S"; 7 | 8 | $bibtex_use = 1.5; 9 | 10 | $clean_ext = "bbl hd gls glo ilg ins loa loe lof log lol ptc run.xml synctex.gz thm xdv"; 11 | 12 | $makeindex = "makeindex %O -s gind.ist -o %D %S"; 13 | add_cus_dep('glo','gls',0,'makeindex'); 14 | sub makeindex { 15 | if ( $silent ) { 16 | system( "makeindex -q -s gglo.ist -o \"$_[0].gls\" \"$_[0].glo\"" ); 17 | } 18 | else { 19 | system( "makeindex -s gglo.ist -o \"$_[0].gls\" \"$_[0].glo\"" ); 20 | }; 21 | } 22 | $makeindex_silent_switch = "-q"; 23 | 24 | add_cus_dep('nlo', 'nls', 0, 'nlo2nls'); 25 | sub nlo2nls { 26 | system("makeindex -s nomencl.ist -o \"$_[0].nls\" \"$_[0].nlo\""); 27 | } 28 | push @generated_exts, 'nlo', 'nls'; 29 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # Adpated from https://github.com/nju-lug/NJUThesis/blob/master/.github/workflows/build.yml 2 | # This is a build workflow, it is manually triggered and provided for advanced users 3 | # You can fork the HKUST-Thesis Repo, write your thesis and organize through Github, 4 | # Compile your thesis through Github Action. 5 | name: Build Thesis 6 | 7 | on: 8 | workflow_dispatch: 9 | 10 | jobs: 11 | build_latex: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Set up Git repository 15 | uses: actions/checkout@v4 16 | 17 | - name: Github Action for LaTeX dtx to cls 18 | uses: FengChendian/latex-dtx2cls-action@4.0.1 19 | with: 20 | root_file: hkustthesis.dtx 21 | working_directory: ./ 22 | 23 | - name: Compile sample PDF 24 | uses: HermitSun/latex-action@v3 25 | with: 26 | root_file: mythesis.tex 27 | latexmk_use_xelatex: true 28 | args: "-bibtex" 29 | 30 | - name: Upload PDF 31 | uses: actions/upload-artifact@v4 32 | with: 33 | name: PDF 34 | path: | 35 | mythesis.pdf 36 | 37 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Adapated from https://github.com/sjtug/SJTUThesis/blob/master/Makefile 2 | # now the following Makefile can work on Linux, MacOS, Windows 3 | # Basename of thesis 4 | THESIS = mythesis 5 | TEMPLATE = hkustthesis 6 | 7 | # Option for latexmk 8 | LATEXMK_OPT = -quiet -file-line-error -halt-on-error -interaction=nonstopmode 9 | LATEXMK_OPT_PVC = $(LATEXMK_OPT) -pvc 10 | 11 | .PHONY : all clean FORCE_MAKE 12 | 13 | all : $(THESIS).pdf 14 | 15 | $(THESIS).pdf : $(THESIS).tex $(TEMPLATE).cls FORCE_MAKE 16 | @latexmk $(LATEXMK_OPT) $< 17 | 18 | $(TEMPLATE).cls : $(TEMPLATE).dtx 19 | xetex $(TEMPLATE).dtx 20 | 21 | clean : 22 | @rm -f \ 23 | *.acn \ 24 | *.acr \ 25 | *.alg \ 26 | *.aux \ 27 | *.bbl \ 28 | *.bcf \ 29 | *.blg \ 30 | *.fls \ 31 | *.glg \ 32 | *.glo \ 33 | *.gls \ 34 | *.gz \ 35 | *.hd \ 36 | *.idx \ 37 | *.ilg \ 38 | *.ind \ 39 | *.ins \ 40 | *.ist \ 41 | *.loa \ 42 | *.lof \ 43 | *.log \ 44 | *.lol \ 45 | *.lot \ 46 | *.nav \ 47 | *.out \ 48 | *.xdv \ 49 | *.snm \ 50 | *.toc \ 51 | *.run.xml \ 52 | *.fdb_latexmk 53 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | # adpated from https://github.com/nju-lug/NJUThesis/blob/master/.github/workflows/build.yml 2 | # This workflow is triggered by push and pull request 3 | # Success when compilation is OK. 4 | name: Test Compilation 5 | 6 | on: 7 | workflow_dispatch: 8 | 9 | # on: 10 | # push: 11 | # branches: 12 | # - main 13 | # paths-ignore: 14 | # - '*.md' 15 | # - '.gitignore' 16 | # - 'docs/**' 17 | 18 | # pull_request: 19 | # branches: 20 | # - main 21 | # paths-ignore: 22 | # - '*.md' 23 | # - '.gitignore' 24 | # - 'docs/**' 25 | 26 | 27 | jobs: 28 | build_latex: 29 | runs-on: ubuntu-latest 30 | steps: 31 | - name: Set up Git repository 32 | uses: actions/checkout@v4 33 | 34 | - name: Github Action for LaTeX dtx to cls 35 | uses: FengChendian/latex-dtx2cls-action@4.0.1 36 | with: 37 | root_file: hkustthesis.dtx 38 | working_directory: ./ 39 | 40 | - name: Compile sample PDF 41 | uses: HermitSun/latex-action@v3 42 | with: 43 | root_file: mythesis.tex 44 | latexmk_use_xelatex: true 45 | args: "-bibtex" 46 | 47 | - name: Compile documentation PDF 48 | uses: HermitSun/latex-action@v3 49 | with: 50 | root_file: hkustthesis.dtx 51 | latexmk_use_xelatex: true 52 | args: "" 53 | 54 | - name: Upload PDF 55 | uses: actions/upload-artifact@v4 56 | with: 57 | name: PDF 58 | path: | 59 | mythesis.pdf 60 | hkustthesis.pdf 61 | 62 | -------------------------------------------------------------------------------- /resources/ProjectLogo/HKUSTThesisLogoTeX.tex: -------------------------------------------------------------------------------- 1 | \documentclass{article} 2 | 3 | \usepackage{geometry,graphicx,svg,xcolor} 4 | \usepackage{fontspec} 5 | % \setmonofont{Noto Mono} 6 | % \setmonofont{Noto Sans Mono} 7 | \setmonofont{Consolas} 8 | 9 | \geometry{paperwidth=5in, paperheight=2.5in, top=0in, bottom=0in, left=0in, right=0in} 10 | \pagenumbering{gobble} 11 | \setlength{\parindent}{0pt} 12 | 13 | 14 | \begin{document} 15 | 16 | \begin{center} 17 | 18 | \begin{minipage}[c][2.5in][c]{5.0in} 19 | \begin{center} 20 | 21 | \hspace{0.1in} 22 | \begin{minipage}[c][2.3in][c]{1.4in} 23 | \includesvg[width=\linewidth]{redbird-raw} 24 | \end{minipage} 25 | \hspace{-0.7in} 26 | \begin{minipage}[c][2.3in][c]{3.8in} 27 | \vspace{0.0in} 28 | \begin{flushright} 29 | \begin{minipage}[c][1.6in][c]{3.6in} 30 | %\input{logo-text} 31 | \begin{center} 32 | {\fontsize{38}{38}\selectfont\textsc{HkustThesis}}\par 33 | \resizebox{3.5in}{1pt}{$\bullet$}\par 34 | \vspace{0.12in} 35 | {\fontsize{25}{25}\selectfont\textsc{A~\LaTeX\textcolor{red}{3}~Template}}\par 36 | \vspace{0.15in} 37 | {\hspace*{-0.3in}\fontsize{12}{12}\selectfont\texttt{@HKFoggyU}~Presents}\par 38 | \end{center} 39 | \end{minipage} 40 | \end{flushright} 41 | 42 | \vspace{-0.35in} 43 | \hspace{0.0in} 44 | %\centering 45 | %\begin{flushright} 46 | \begin{minipage}[c][0.6in][c]{3.6in} 47 | \hfill 48 | \begin{minipage}[c][0.8in][c]{0.8in} 49 | \includesvg[width=0.8in]{qrcode2github} 50 | \end{minipage} 51 | \end{minipage} 52 | %\end{flushright} 53 | \end{minipage} 54 | 55 | \end{center} 56 | 57 | \end{minipage} 58 | 59 | \end{center} 60 | 61 | \end{document} 62 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 | 5 | # LaTeX3 Template for HKUST Thesis 6 | 7 | ## Introduction 8 | 9 | This project provides a LaTeX3 template for HKUST Thesis to fulfill the requirements for Ph.D. and MPhil. graduation. 10 | 11 | ## Getting started 12 | 13 | ### For general users 14 | 15 | 1. Download the zip file `hkust-thesis-v*.zip` from the [latest release](https://github.com/HKFoggyU/hkust-thesis/releases/latest/). 16 | 1. Read the PDF documentation -- `hkustthesis.pdf` and follow the sample thesis file -- `mythesis.tex` in the release. 17 | 1. We recommend ``Visual Studio Code`` with ``LaTeX Workshop`` extention as the editor. Then, run the `build_mythesis` command we pre-defined to compile the thesis file. 18 | 19 | ### For command line users 20 | 21 | After downloading the release file, you can compile from command line by: 22 | 23 | - `Makefile`. 24 | ```bash 25 | make all 26 | make clean 27 | ``` 28 | - `latexmk`: 29 | ```bash 30 | latexmk 31 | latexmk -c 32 | ``` 33 | - `XeLaTeX`: 34 | ```bash 35 | xelatex mythesis.tex 36 | biber mythesis 37 | xelatex mythesis.tex 38 | xelatex mythesis.tex 39 | ``` 40 | 41 | ### For developers 42 | 43 | 1. Fork the Github repo and develop on your branch. 44 | 1. Read through the documentation `hkustthesis.pdf` including the ``implementation`` section. 45 | 1. File issues and PRs for your contribution. 46 | 47 | There's no `.cls` file in the repository and you need to compile yourself. 48 | 49 | 1. For VS Code and `LaTeX Workshop`, run the commands as `extract_dtx` before running `build_mythesis`. Then you get the documentation and sample theis. 50 | 1. For command line users: 51 | ```bash 52 | xetex hkustthesis.dtx 53 | ``` 54 | -------------------------------------------------------------------------------- /README_CN.md: -------------------------------------------------------------------------------- 1 | # HKUST Thesis 2 | 3 | [![LICENSE](https://img.shields.io/github/license/HKFoggyU/hkust-thesis)](https://www.latex-project.org/lppl/lppl-1-3c/) 4 | [![STARS](https://img.shields.io/github/stars/HKFoggyU/hkust-thesis)](https://github.com/HKFoggyU/hkust-thesis/stargazers) 5 | [![TEST](https://github.com/HKFoggyU/hkust-thesis/actions/workflows/test.yml/badge.svg)](https://github.com/HKFoggyU/hkust-thesis/actions) 6 | [![RELEASE](https://github.com/HKFoggyU/hkust-thesis/actions/workflows/release.yml/badge.svg)](https://github.com/HKFoggyU/hkust-thesis/releases) 7 | 8 | [English Readme](README.md) 9 | 10 | 以LaTeX3实现的香港科技大学研究型研究生(RPG)毕业论文模板。 11 | 12 | ## 快速上手 13 | 14 | **请仔细阅读 [PDF文档](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)。**
15 | **请仔细阅读 [PDF文档](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)。**
16 | **请仔细阅读 [PDF文档](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)。** 17 | 18 | ### 在线使用 19 | 20 | 注意：由于Overleaf免费版限制，我已无法继续在Overleaf上更新此项目。请使用GitHub Release获取最新更新，或使用TeXPage。 21 | 22 | 在[TeXPage](https://www.texpage.com/template/373737be-dc33-4df2-a7d0-a512a92715ef) (或 [Overleaf](https://www.overleaf.com/latex/templates/hkustthesis/mstwvckmhmjg), 但未更新)上体验本模板。请在编辑器设置里选择 `Compiler` 为 `XeLaTeX`，否则会无法编译。 23 | - TeXPage：在右上角的 `设置` 按钮里 24 | - Overleaf：在左上角的 `Menu` 按钮里 25 | 26 | ### 本地使用 27 | 28 | 也可以从 [Release](https://github.com/HKFoggyU/hkust-thesis/releases/latest) 页面下载 `zip` 文件在本地工作。 29 | 30 | ## 贡献 31 | 32 | 如果发现问题或有建议，可以提交issue或者PR。 33 | 34 | ## 免责声明 35 | 36 | 香港科技大学研究生院并没有为毕业论文提供任何官方模板。他们强调最终提交的毕业论文应该符合 [RPG Handbook](https://fytgs.hkust.edu.hk/academics/Academic-Regulations-and-Requirements/Handbook-for-Research-Postgraduate-Studies/guidelines-thesis-preparation) 的相关要求。 37 | 38 | 本模板尽可能地贴合上述 RPG Handbook 要求，并且参照 RPG Handbook 提供的示例页面 ([MPhil](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_mphil.pdf)/[PhD](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_phd.pdf))。但是本模板对潜在的不符合的情况不负责任。 39 | 40 | 41 | ## 许可证 42 | 43 | LaTeX Project Public License (version 1.3c) 44 | 45 | ## 致谢 46 | 47 | 本项目基于 [`` NJUThesis ``](https://github.com/nju-lug/NJUThesis) 项目开发，并得到了 [NJU-LUG](https://github.com/nju-lug) 的帮助。 48 | 49 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | # adpated from https://github.com/nju-lug/NJUThesis/blob/master/.github/workflows/build.yml 2 | # Automatic release through Github Actions. 3 | # Triggered by push with tag 'v*' 4 | name: Release Template 5 | 6 | on: 7 | push: 8 | tags: 9 | - 'v*' 10 | 11 | jobs: 12 | build_latex: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Set up Git repository 16 | uses: actions/checkout@v4 17 | 18 | - name: Github Action for LaTeX dtx to cls 19 | uses: FengChendian/latex-dtx2cls-action@4.0.1 20 | with: 21 | root_file: hkustthesis.dtx 22 | working_directory: ./ 23 | 24 | - name: Compile sample PDF 25 | uses: HermitSun/latex-action@v3 26 | with: 27 | root_file: mythesis.tex 28 | latexmk_use_xelatex: true 29 | args: "-bibtex" 30 | 31 | - name: Compile documentation PDF 32 | uses: HermitSun/latex-action@v3 33 | with: 34 | root_file: hkustthesis.dtx 35 | latexmk_use_xelatex: true 36 | args: "" 37 | 38 | - name: Upload PDF 39 | uses: actions/upload-artifact@v4 40 | with: 41 | name: PDF 42 | path: | 43 | mythesis.pdf 44 | hkustthesis.pdf 45 | 46 | release: 47 | needs: build_latex 48 | runs-on: ubuntu-latest 49 | if: startsWith(github.ref, 'refs/tags/v') 50 | steps: 51 | - name: Set up Git repository 52 | uses: actions/checkout@v4 53 | 54 | - name: Download artifact 55 | uses: actions/download-artifact@v4 56 | with: 57 | name: PDF 58 | 59 | - name: Set Version 60 | run: echo "VERSION=${GITHUB_REF##*/}" >> $GITHUB_ENV 61 | 62 | - name: Github Action for LaTeX dtx to cls 63 | uses: FengChendian/latex-dtx2cls-action@4.0.1 64 | with: 65 | root_file: hkustthesis.dtx 66 | working_directory: ./ 67 | 68 | - name: Zip Release Source 69 | run: | 70 | zip -r hkust-thesis-$VERSION.zip .vscode/ chapters/ hkustthesis.cls latexmkrc LICENSE Makefile mythesis.bib mythesis_LoP.bib mythesis.tex README.md README.zh.md 71 | - uses: "marvinpinto/action-automatic-releases@latest" 72 | with: 73 | repo_token: "${{ secrets.GITHUB_TOKEN }}" 74 | prerelease: false 75 | files: | 76 | mythesis.pdf 77 | hkustthesis.pdf 78 | hkust-thesis-v*.zip 79 | -------------------------------------------------------------------------------- /mythesis_LoP.bib: -------------------------------------------------------------------------------- 1 | @article{ChaiACSNano2022, 2 | title = {Beyond {{Metrics}}}, 3 | author = {Chai, Yang and Chen, Xiaodong and Fan, Hong Jin and Lau, Shu Ping and Li, Shuzhou and Liu, Bin and Wong, Wai-Yeung and Zhao, Ni and Zheng, Zijian}, 4 | date = {2022-08-23}, 5 | journaltitle = {ACS Nano}, 6 | shortjournal = {ACS Nano}, 7 | volume = {16}, 8 | number = {8}, 9 | pages = {11485--11486}, 10 | publisher = {American Chemical Society}, 11 | doi = {10.1021/acsnano.2c07662}, 12 | url = {https://doi.org/10.1021/acsnano.2c07662} 13 | } 14 | 15 | @article{LoP.ChaiACSNano2022, 16 | title = {Beyond {{Metrics}}}, 17 | author = {Chai, Yang and Chen, Xiaodong and Fan, Hong Jin and Lau, Shu Ping and Li, Shuzhou and Liu, Bin and Wong, Wai-Yeung and Zhao, Ni and Zheng, Zijian}, 18 | author+an = {1=highlight}, 19 | date = {2022-08-23}, 20 | journaltitle = {ACS Nano}, 21 | shortjournal = {ACS Nano}, 22 | volume = {16}, 23 | number = {8}, 24 | pages = {11485--11486}, 25 | publisher = {American Chemical Society}, 26 | doi = {10.1021/acsnano.2c07662}, 27 | url = {https://doi.org/10.1021/acsnano.2c07662} 28 | } 29 | 30 | @inproceedings{JehleImagingAppl.Opt.20162016Pap.IM4F22016, 31 | title = {Spatial {{Light Modulators}} in {{Laser Lithography Systems}}}, 32 | booktitle = {Imaging and {{Applied Optics}} 2016 (2016), Paper {{IM4F}}.2}, 33 | author = {Jehle, Achim and Diez, Steffen}, 34 | date = {2016-07-25}, 35 | pages = {IM4F.2}, 36 | publisher = {Optica Publishing Group}, 37 | doi = {10.1364/ISA.2016.IM4F.2}, 38 | url = {https://opg.optica.org/abstract.cfm?uri=ISA-2016-IM4F.2}, 39 | eventtitle = {Imaging {{Systems}} and {{Applications}}} 40 | } 41 | 42 | @inproceedings{LuConf.LasersElectro-Opt.2021Pap.SW3B12021, 43 | title = {On-{{Chip Optical Tweezers Based}} on {{Micro-Reflectors}}}, 44 | booktitle = {Conference on {{Lasers}} and {{Electro-Optics}} (2021), Paper {{SW3B}}.1}, 45 | author = {Lu, Jinsheng and Lu, Jinsheng and Yu, Shaoliang and Ginis, Vincent and Ginis, Vincent and Kheifets, Simon and Lim, Soon Wei Daniel and Qiu, Min and Gu, Tian and Hu, Juejun and Hu, Juejun and Capasso, Federico}, 46 | date = {2021-05-09}, 47 | pages = {SW3B.1}, 48 | publisher = {Optica Publishing Group}, 49 | doi = {10.1364/CLEO_SI.2021.SW3B.1}, 50 | url = {https://opg.optica.org/abstract.cfm?uri=CLEO_SI-2021-SW3B.1}, 51 | eventtitle = {{{CLEO}}: {{Science}} and {{Innovations}}} 52 | } 53 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "latex-workshop.latex.autoBuild.run": "never", 3 | "latex-workshop.message.error.show": false, 4 | "latex-workshop.message.warning.show": false, 5 | "latex-workshop.latex.recipe.default": "lastUsed", 6 | "latex-workshop.formatting.latex": "latexindent", 7 | "[latex]": { 8 | "editor.tabSize": 2 9 | }, 10 | "latex-workshop.latex.tools": [ 11 | { 12 | "name": "xelatex", 13 | "command": "xelatex", 14 | "args": [ 15 | "-synctex=1", 16 | "-interaction=nonstopmode", 17 | "-file-line-error", 18 | "%DOCFILE%" 19 | ] 20 | }, 21 | { 22 | "name": "latexmk", 23 | "command": "latexmk", 24 | "args": [ 25 | "-xelatex" 26 | ] 27 | }, 28 | { 29 | "name": "biber", 30 | "command": "biber", 31 | "args": [ 32 | "%DOCFILE%" 33 | ] 34 | }, 35 | { 36 | "name": "build_dtx", 37 | "command": "latexmk", 38 | "args": [ 39 | "-xelatex", 40 | "hkustthesis.dtx" 41 | ] 42 | }, 43 | { 44 | "name": "extract_dtx", 45 | "command": "xetex", 46 | "args": [ 47 | "hkustthesis.dtx" 48 | ] 49 | } 50 | ], 51 | "latex-workshop.latex.recipes": [ 52 | { 53 | "name": "build_mythesis", 54 | "tools": [ 55 | "latexmk" 56 | ] 57 | }, 58 | { 59 | "name": "build_dtx", 60 | "tools": [ 61 | "build_dtx" 62 | ] 63 | }, 64 | { 65 | "name": "extract_dtx", 66 | "tools": [ 67 | "extract_dtx" 68 | ] 69 | } 70 | ], 71 | "latex-workshop.latex.clean.fileTypes": [ 72 | "*.acn", 73 | "*.acr", 74 | "*.alg", 75 | "*.aux", 76 | "*.bbl", 77 | "*.bcf", 78 | "*.blg", 79 | "*.fdb_latexmk", 80 | "*.fls", 81 | "*.glg", 82 | "*.glo", 83 | "*.gls", 84 | "*.gz", 85 | "*.hd", 86 | "*.idx", 87 | "*.ilg", 88 | "*.ind", 89 | "*.ins", 90 | "*.ist", 91 | "*.lof", 92 | "*.log", 93 | "*.lot", 94 | "*.nav", 95 | "*.out", 96 | "*.run.xml", 97 | "*.snm", 98 | "*.toc", 99 | "*.xdv" 100 | ] 101 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HKUST Thesis 2 | 3 | [![LICENSE](https://img.shields.io/github/license/HKFoggyU/hkust-thesis)](https://www.latex-project.org/lppl/lppl-1-3c/) 4 | [![STARS](https://img.shields.io/github/stars/HKFoggyU/hkust-thesis)](https://github.com/HKFoggyU/hkust-thesis/stargazers) 5 | [![TEST](https://github.com/HKFoggyU/hkust-thesis/actions/workflows/test.yml/badge.svg)](https://github.com/HKFoggyU/hkust-thesis/actions) 6 | [![RELEASE](https://github.com/HKFoggyU/hkust-thesis/actions/workflows/release.yml/badge.svg)](https://github.com/HKFoggyU/hkust-thesis/releases) 7 | 8 | [中文说明](README_CN.md) 9 | 10 | HKUST Thesis template for RPG students implemented with LaTeX3. 11 | 12 | ## Getting started 13 | 14 | **Please read the [PDF documentation](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)** carefully before trial.
15 | **Please read the [PDF documentation](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)** carefully before trial.
16 | **Please read the [PDF documentation](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)** carefully before trial. 17 | 18 | ### Online 19 | 20 | Attention: Limited by Overleaf Free Plan, I cannot update this project on Overleaf anymore. Please try GitHub Release for latest update and/or TeXPage. 21 | 22 | Try this template on [TeXPage](https://www.texpage.com/template/373737be-dc33-4df2-a7d0-a512a92715ef) (or [Overleaf](https://www.overleaf.com/latex/templates/hkustthesis/mstwvckmhmjg), but outdated). Remember to change the `Compiler` to `XeLaTeX` in the settings, otherwise it may fail to compile. 23 | - for TeXPage, via the top right `Setting` button 24 | - for Overleaf, via the top left `Menu` button 25 | 26 | ### Local 27 | 28 | Alternatively, you can download the [release zip file](https://github.com/HKFoggyU/hkust-thesis/releases/latest) and try it on your local machine. 29 | 30 | ## Contributions 31 | 32 | If you find any problems or have any suggestions, please file an issue or PR. 33 | 34 | ## Disclaimer 35 | 36 | FYTGS doesn't provide any template for thesis submission. They only emphasize that the submitted PDF file should meet the requirements in the [RPG Handbook](https://fytgs.hkust.edu.hk/academics/Academic-Regulations-and-Requirements/Handbook-for-Research-Postgraduate-Studies/guidelines-thesis-preparation). 37 | 38 | This template has tried its best to follow the above requirements in the RPG Handbook and also the formatting instructions of the sample pages ([MPhil](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_mphil.pdf)/[PhD](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_phd.pdf)) provided by the RPG Handbook. However, this template takes no responsibility for any potential inconsistency. 39 | 40 | ## License 41 | 42 | LaTeX Project Public License (version 1.3c) 43 | 44 | ## Acknowledgements 45 | 46 | This project is modified from the [`` NJUThesis ``](https://github.com/nju-lug/NJUThesis) project with the help from [NJU-LUG](https://github.com/nju-lug). 47 | 48 | -------------------------------------------------------------------------------- /chapters/Appendix_Figures.tex: -------------------------------------------------------------------------------- 1 | \chapter{Supplementary figures} 2 | 3 | \begin{figure}[H] 4 | \centering 5 | \begin{tikzpicture} 6 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 7 | \end{tikzpicture} 8 | \caption{An example tikz picture with a short caption.} 9 | \label{fig:tikz-example-1} 10 | \end{figure} 11 | 12 | \begin{figure}[H] 13 | \centering 14 | \begin{tikzpicture} 15 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 16 | \end{tikzpicture} 17 | \caption{An example tikz picture with a short caption.} 18 | \label{fig:tikz-example-2} 19 | \end{figure} 20 | 21 | \begin{figure}[H] 22 | \centering 23 | \begin{tikzpicture} 24 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 25 | \end{tikzpicture} 26 | \caption{An example tikz picture with a short caption.} 27 | \label{fig:tikz-example-3} 28 | \end{figure} 29 | 30 | \begin{figure}[H] 31 | \centering 32 | \begin{tikzpicture} 33 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 34 | \end{tikzpicture} 35 | \caption{An example tikz picture with a short caption.} 36 | \label{fig:tikz-example-4} 37 | \end{figure} 38 | 39 | \begin{figure}[H] 40 | \centering 41 | \begin{tikzpicture} 42 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 43 | \end{tikzpicture} 44 | \caption{An example tikz picture with a short caption.} 45 | \label{fig:tikz-example-5} 46 | \end{figure} 47 | 48 | \begin{figure}[H] 49 | \centering 50 | \begin{tikzpicture} 51 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 52 | \end{tikzpicture} 53 | \caption{An example tikz picture with a short caption.} 54 | \label{fig:tikz-example-6} 55 | \end{figure} 56 | 57 | \begin{figure}[H] 58 | \centering 59 | \begin{tikzpicture} 60 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 61 | \end{tikzpicture} 62 | \caption{An example tikz picture with a short caption.} 63 | \label{fig:tikz-example-7} 64 | \end{figure} 65 | 66 | \begin{figure}[H] 67 | \centering 68 | \begin{tikzpicture} 69 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 70 | \end{tikzpicture} 71 | \caption{An example tikz picture with a short caption.} 72 | \label{fig:tikz-example-8} 73 | \end{figure} 74 | 75 | \begin{figure}[H] 76 | \centering 77 | \begin{tikzpicture} 78 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 79 | \end{tikzpicture} 80 | \caption{An example tikz picture with a short caption.} 81 | \label{fig:tikz-example-9} 82 | \end{figure} 83 | 84 | \begin{figure}[H] 85 | \centering 86 | \begin{tikzpicture} 87 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 88 | \end{tikzpicture} 89 | \caption{An example tikz picture with a short caption.} 90 | \label{fig:tikz-example-10} 91 | \end{figure} 92 | 93 | \begin{figure}[H] 94 | \centering 95 | \begin{tikzpicture} 96 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 97 | \end{tikzpicture} 98 | \caption{An example tikz picture with a short caption.} 99 | \label{fig:tikz-example-11} 100 | \end{figure} 101 | 102 | \begin{figure}[H] 103 | \centering 104 | \begin{tikzpicture} 105 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 106 | \end{tikzpicture} 107 | \caption{An example tikz picture with a short caption.} 108 | \label{fig:tikz-example-12} 109 | \end{figure} 110 | 111 | \begin{figure}[H] 112 | \centering 113 | \begin{tikzpicture} 114 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 115 | \end{tikzpicture} 116 | \caption{An example tikz picture with a short caption.} 117 | \label{fig:tikz-example-13} 118 | \end{figure} 119 | 120 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Custom ignores 2 | 3 | temp/ 4 | 5 | # LaTeX files generated from .dtx file 6 | *.cls 7 | *.sty 8 | *.ins 9 | 10 | # commitizen 11 | .cz.yaml 12 | .pre-commit-config.yaml 13 | 14 | # binary images 15 | *.png 16 | *.jpg 17 | *.tif* 18 | *.bmp 19 | *.raw 20 | *.psd 21 | *.ai 22 | svg-inkscape/ 23 | 24 | ## Core latex/pdflatex auxiliary files: 25 | *.aux 26 | *.hd 27 | *.lof 28 | *.log 29 | *.lot 30 | *.fls 31 | *.out 32 | *.toc 33 | *.fmt 34 | *.fot 35 | *.cb 36 | *.cb2 37 | .*.lb 38 | 39 | ## Intermediate documents: 40 | *.dvi 41 | *.xdv 42 | *-converted-to.* 43 | # these rules might exclude image files for figures etc. 44 | # *.ps 45 | # *.eps 46 | *.pdf 47 | 48 | ## Generated if empty string is given at "Please type another file name for output:" 49 | .pdf 50 | 51 | ## Bibliography auxiliary files (bibtex/biblatex/biber): 52 | *.bbl 53 | *.bcf 54 | *.blg 55 | *-blx.aux 56 | *-blx.bib 57 | *.run.xml 58 | 59 | ## Build tool auxiliary files: 60 | *.fdb_latexmk 61 | *.synctex 62 | *.synctex(busy) 63 | *.synctex.gz 64 | *.synctex.gz(busy) 65 | *.pdfsync 66 | 67 | ## Build tool directories for auxiliary files 68 | # latexrun 69 | latex.out/ 70 | 71 | ## Auxiliary and intermediate files from other packages: 72 | # algorithms 73 | *.alg 74 | *.loa 75 | 76 | # achemso 77 | acs-*.bib 78 | 79 | # amsthm 80 | *.thm 81 | 82 | # beamer 83 | *.nav 84 | *.pre 85 | *.snm 86 | *.vrb 87 | 88 | # changes 89 | *.soc 90 | 91 | # comment 92 | *.cut 93 | 94 | # cprotect 95 | *.cpt 96 | 97 | # elsarticle (documentclass of Elsevier journals) 98 | *.spl 99 | 100 | # endnotes 101 | *.ent 102 | 103 | # fixme 104 | *.lox 105 | 106 | # feynmf/feynmp 107 | *.mf 108 | *.mp 109 | *.t[1-9] 110 | *.t[1-9][0-9] 111 | *.tfm 112 | 113 | #(r)(e)ledmac/(r)(e)ledpar 114 | *.end 115 | *.?end 116 | *.[1-9] 117 | *.[1-9][0-9] 118 | *.[1-9][0-9][0-9] 119 | *.[1-9]R 120 | *.[1-9][0-9]R 121 | *.[1-9][0-9][0-9]R 122 | *.eledsec[1-9] 123 | *.eledsec[1-9]R 124 | *.eledsec[1-9][0-9] 125 | *.eledsec[1-9][0-9]R 126 | *.eledsec[1-9][0-9][0-9] 127 | *.eledsec[1-9][0-9][0-9]R 128 | 129 | # glossaries 130 | *.acn 131 | *.acr 132 | *.glg 133 | *.glo 134 | *.gls 135 | *.glsdefs 136 | *.lzo 137 | *.lzs 138 | 139 | # uncomment this for glossaries-extra (will ignore makeindex's style files!) 140 | # *.ist 141 | 142 | # gnuplottex 143 | *-gnuplottex-* 144 | 145 | # gregoriotex 146 | *.gaux 147 | *.gtex 148 | 149 | # htlatex 150 | *.4ct 151 | *.4tc 152 | *.idv 153 | *.lg 154 | *.trc 155 | *.xref 156 | 157 | # hyperref 158 | *.brf 159 | 160 | # knitr 161 | *-concordance.tex 162 | # TODO Comment the next line if you want to keep your tikz graphics files 163 | *.tikz 164 | *-tikzDictionary 165 | 166 | # listings 167 | *.lol 168 | 169 | # luatexja-ruby 170 | *.ltjruby 171 | 172 | # makeidx 173 | *.idx 174 | *.ilg 175 | *.ind 176 | 177 | # minitoc 178 | *.maf 179 | *.mlf 180 | *.mlt 181 | *.mtc[0-9]* 182 | *.slf[0-9]* 183 | *.slt[0-9]* 184 | *.stc[0-9]* 185 | 186 | # minted 187 | _minted* 188 | *.pyg 189 | 190 | # morewrites 191 | *.mw 192 | 193 | # nomencl 194 | *.nlg 195 | *.nlo 196 | *.nls 197 | 198 | # pax 199 | *.pax 200 | 201 | # pdfpcnotes 202 | *.pdfpc 203 | 204 | # sagetex 205 | *.sagetex.sage 206 | *.sagetex.py 207 | *.sagetex.scmd 208 | 209 | # scrwfile 210 | *.wrt 211 | 212 | # sympy 213 | *.sout 214 | *.sympy 215 | sympy-plots-for-*.tex/ 216 | 217 | # pdfcomment 218 | *.upa 219 | *.upb 220 | 221 | # pythontex 222 | *.pytxcode 223 | pythontex-files-*/ 224 | 225 | # tcolorbox 226 | *.listing 227 | 228 | # thmtools 229 | *.loe 230 | 231 | # TikZ & PGF 232 | *.dpth 233 | *.md5 234 | *.auxlock 235 | 236 | # todonotes 237 | *.tdo 238 | 239 | # vhistory 240 | *.hst 241 | *.ver 242 | 243 | # easy-todo 244 | *.lod 245 | 246 | # xcolor 247 | *.xcp 248 | 249 | # xmpincl 250 | *.xmpi 251 | 252 | # xindy 253 | *.xdy 254 | 255 | # xypic precompiled matrices and outlines 256 | *.xyc 257 | *.xyd 258 | 259 | # endfloat 260 | *.ttt 261 | *.fff 262 | 263 | # Latexian 264 | TSWLatexianTemp* 265 | 266 | ## Editors: 267 | # WinEdt 268 | *.bak 269 | *.sav 270 | 271 | # Texpad 272 | .texpadtmp 273 | 274 | # LyX 275 | *.lyx~ 276 | 277 | # Kile 278 | *.backup 279 | 280 | # gummi 281 | .*.swp 282 | 283 | # KBibTeX 284 | *~[0-9]* 285 | 286 | # TeXnicCenter 287 | *.tps 288 | 289 | # auto folder when using emacs and auctex 290 | ./auto/* 291 | *.el 292 | 293 | # expex forward references with \gathertags 294 | *-tags.tex 295 | 296 | # standalone packages 297 | *.sta 298 | 299 | # Makeindex log files 300 | *.lpz 301 | -------------------------------------------------------------------------------- /mythesis.bib: -------------------------------------------------------------------------------- 1 | @book{LaTeX.Companion, 2 | author = {Frank Mittelbach and Michel Goossens and Johannes Braams and David Carlisle and Chris Rowley}, 3 | title = {The {LaTeX} Companion}, 4 | year = {1993}, 5 | publisher = {Addison-Wesley}, 6 | address = {Reading, Massachusetts} 7 | } 8 | 9 | @article{KeshavACMSIGCOMMComput.Commun.Rev.2007, 10 | title = {How to Read a Paper}, 11 | author = {Keshav, S.}, 12 | date = {2007-07-20}, 13 | journaltitle = {ACM SIGCOMM Computer Communication Review}, 14 | shortjournal = {SIGCOMM Comput. Commun. Rev.}, 15 | volume = {37}, 16 | number = {3}, 17 | pages = {83--84}, 18 | doi = {10.1145/1273445.1273458}, 19 | url = {https://doi.org/10.1145/1273445.1273458} 20 | } 21 | 22 | @article{WhitesidesAdv.Mater.2004, 23 | title = {Whitesides' {{Group}}: {{Writing}} a {{Paper}}}, 24 | shorttitle = {Whitesides' {{Group}}}, 25 | author = {Whitesides, G. M.}, 26 | date = {2004}, 27 | journaltitle = {Advanced Materials}, 28 | volume = {16}, 29 | number = {15}, 30 | pages = {1375--1377}, 31 | doi = {10.1002/adma.200400767}, 32 | url = {https://onlinelibrary.wiley.com/doi/abs/10.1002/adma.200400767} 33 | } 34 | 35 | @article{ChaiACSNano2022, 36 | title = {Beyond {{Metrics}}}, 37 | author = {Chai, Yang and Chen, Xiaodong and Fan, Hong Jin and Lau, Shu Ping and Li, Shuzhou and Liu, Bin and Wong, Wai-Yeung and Zhao, Ni and Zheng, Zijian}, 38 | date = {2022-08-23}, 39 | journaltitle = {ACS Nano}, 40 | shortjournal = {ACS Nano}, 41 | volume = {16}, 42 | number = {8}, 43 | pages = {11485--11486}, 44 | publisher = {American Chemical Society}, 45 | doi = {10.1021/acsnano.2c07662}, 46 | url = {https://doi.org/10.1021/acsnano.2c07662} 47 | } 48 | 49 | @article{HermanNature2007, 50 | title = {Following the Law}, 51 | author = {Herman, Irving P.}, 52 | date = {2007-01}, 53 | journaltitle = {Nature}, 54 | volume = {445}, 55 | number = {7124}, 56 | pages = {228--228}, 57 | publisher = {Nature Publishing Group}, 58 | doi = {10.1038/nj7124-228a}, 59 | url = {https://www.nature.com/articles/nj7124-228a}, 60 | issue = {7124} 61 | } 62 | 63 | @article{WarrenSci.Adv.2022, 64 | title = {Beating the Odds for Journal Acceptance}, 65 | author = {Warren, Warren}, 66 | date = {2022-07-27}, 67 | journaltitle = {Science Advances}, 68 | volume = {8}, 69 | number = {30}, 70 | pages = {eadd9147}, 71 | publisher = {American Association for the Advancement of Science}, 72 | doi = {10.1126/sciadv.add9147}, 73 | url = {https://www.science.org/doi/10.1126/sciadv.add9147} 74 | } 75 | 76 | @inproceedings{Babu2020IEEE33rdInt.Conf.MicroElectroMech.Syst.MEMS2020, 77 | title = {Plasma-{{Treated PDMS}} as {{Intrinsically Non-Wetting Surface}} for {{Gallium-Alloy Liquid Metal Microfluidics}}}, 78 | booktitle = {2020 {{IEEE}} 33rd {{International Conference}} on {{Micro Electro Mechanical Systems}} ({{MEMS}})}, 79 | author = {Babu, Sachin and Lee, Jeong-Bong}, 80 | date = {2020-01}, 81 | pages = {1122--1125}, 82 | doi = {10.1109/MEMS46641.2020.9056134}, 83 | eventtitle = {2020 {{IEEE}} 33rd {{International Conference}} on {{Micro Electro Mechanical Systems}} ({{MEMS}})} 84 | } 85 | 86 | @inproceedings{JehleImagingAppl.Opt.20162016Pap.IM4F22016, 87 | title = {Spatial {{Light Modulators}} in {{Laser Lithography Systems}}}, 88 | booktitle = {Imaging and {{Applied Optics}} 2016 (2016), Paper {{IM4F}}.2}, 89 | author = {Jehle, Achim and Diez, Steffen}, 90 | date = {2016-07-25}, 91 | pages = {IM4F.2}, 92 | publisher = {Optica Publishing Group}, 93 | doi = {10.1364/ISA.2016.IM4F.2}, 94 | url = {https://opg.optica.org/abstract.cfm?uri=ISA-2016-IM4F.2}, 95 | eventtitle = {Imaging {{Systems}} and {{Applications}}} 96 | } 97 | 98 | @inproceedings{LuConf.LasersElectro-Opt.2021Pap.SW3B12021, 99 | title = {On-{{Chip Optical Tweezers Based}} on {{Micro-Reflectors}}}, 100 | booktitle = {Conference on {{Lasers}} and {{Electro-Optics}} (2021), Paper {{SW3B}}.1}, 101 | author = {Lu, Jinsheng and Lu, Jinsheng and Yu, Shaoliang and Ginis, Vincent and Ginis, Vincent and Kheifets, Simon and Lim, Soon Wei Daniel and Qiu, Min and Gu, Tian and Hu, Juejun and Hu, Juejun and Capasso, Federico}, 102 | date = {2021-05-09}, 103 | pages = {SW3B.1}, 104 | publisher = {Optica Publishing Group}, 105 | doi = {10.1364/CLEO_SI.2021.SW3B.1}, 106 | url = {https://opg.optica.org/abstract.cfm?uri=CLEO_SI-2021-SW3B.1}, 107 | eventtitle = {{{CLEO}}: {{Science}} and {{Innovations}}} 108 | } 109 | -------------------------------------------------------------------------------- /mythesis.tex: -------------------------------------------------------------------------------- 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 2 | %% HKUST Thesis LaTeX Template 3 | %% 4 | %% Check the project website for latest updates: 5 | %% https://github.com/HKFoggyU/hkust-thesis 6 | %% 7 | %% Contributors: 8 | %% https://github.com/HKFoggyU/hkust-thesis/graphs/contributors 9 | %% 10 | %% License: 11 | %% LaTeX Project Public License (version 1.3c) 12 | %% 13 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 14 | 15 | %% Pass options to loaded packages in `.cls` file: 16 | % \PassOptionsToPackage{separate-uncertainty=true, separate-uncertainty-units=single}{siunitx} 17 | 18 | %% The following option is to display the full name of the authors. 19 | %% It comes with the setting to display the full author names in the List of Publications 20 | \PassOptionsToPackage{giveninits=false}{biblatex} 21 | 22 | \documentclass[ 23 | % customlatinfont = windows, 24 | % custombibstyle = nature, 25 | % displaycommittee = false, 26 | % blankpage = true, 27 | ]{hkustthesis} 28 | 29 | %% Thesis information 30 | \hkustsetup { 31 | %% Please wrap the items with {}. 32 | %% If one item is not applicable, just leave it {}. 33 | %% Please do not leave any blank lines without {}. 34 | info = { 35 | degree = {phd}, %% phd / mphil 36 | title = {Goodbye\texorpdfstring{\\}{, }All of Evangelion}, 37 | keywords = {Neon, Genesis, Evangelion}, 38 | author = {Cruel Angel}, 39 | school = {School of SEELE}, 40 | department = {Department of NERV}, 41 | program = {Human Instrumentality}, 42 | major = {}, 43 | supervisor = {Prof. Adams}, 44 | %% Co-supervisor; leave it {} if not available 45 | co-supervisor = {Prof. Lilith}, 46 | submit-month = {October 2025}, % 47 | submit-date = {31 October 2025}, % 48 | defend-date = {2 November 2025}, % 49 | depthead = {Prof. Ikari Yui, Head of Department}, 50 | %% reviewers only for some departments, like ECE 51 | reviewer = {Prof. Ikari Gendo (Chairperson), 52 | Prof. Adams (Supervisor), 53 | Prof. Lilith (Co-Supervisor), 54 | Prof. DDD, 55 | Prof. EEE, 56 | Prof. FFF}, 57 | reviewerdept = {Department of Electronic and Computer Engineering, 58 | Department of ECE, 59 | Department of ECE, 60 | Department of ECE, 61 | Department of ECE, 62 | Department of Physics}, 63 | reviewerext = {Prof. FFF (External Examiner), 64 | Department of HH\\{University of UU, at VV}}, 65 | % reviewerext = {}, 66 | city = {Geo Front}, 67 | } 68 | } 69 | 70 | %% Import extra packages 71 | % \usepackage{indentfirst, xspace, xcolor} 72 | 73 | %% The following option is to set hyperref colors for preview, 74 | %% but commented by default for submission and printing 75 | % \hypersetup{ 76 | % colorlinks=true, 77 | % linkcolor=black, 78 | % urlcolor=blue, 79 | % citecolor=red, 80 | % anchorcolor=blue 81 | % } 82 | 83 | %% Add custom command 84 | % \newcommand{\todo}[1]{\textcolor{red}{TODO: #1}} 85 | \newcommand{\eg}{\textit{e.g.}, } 86 | \newcommand{\ie}{\textit{i.e.}, } 87 | 88 | %% Set the specific author in bold style. 89 | %% See https://tex.stackexchange.com/a/304968 90 | %% Need to set `author+an = {n=highlight}` for your n-th authorship in bib file. 91 | %% See more examples in the PDF manual. 92 | \renewcommand*{\mkbibnamegiven}[1]{\ifitemannotation{highlight}{\textbf{#1}}{#1}} 93 | \renewcommand*{\mkbibnamefamily}[1]{\ifitemannotation{highlight}{\textbf{#1}}{#1}} 94 | 95 | %% Remember to generate valid `bib` files, e.g., proper treatment of special characters 96 | %% The bib file for `List of Publications` 97 | \addbibresource{mythesis_LoP.bib} 98 | 99 | %% Import bib file for bibliography 100 | \addbibresource{mythesis.bib} 101 | 102 | \begin{document} 103 | 104 | %% ------------------------------------------------- 105 | %% Thesis structure: In the order of 106 | %% ------------------------------------------------- 107 | %% Titlepage -> Authorization -> Signature -> 108 | %% Acknowledgements -> 109 | %% TOC -> List of Figures -> List of Tables -> 110 | %% Abstract -> 111 | %% ------------------------------------------------- 112 | %%
-> 113 | %% ------------------------------------------------- 114 | %% References -> (Appendices) 115 | %% ------------------------------------------------- 116 | 117 | \frontmatter 118 | \maketitle 119 | 120 | %% Revision to the Guidelines on Thesis Preparation [w.e.f. Spring 2024/25] 121 | %% Abstract should be positioned immediately after the Title page 122 | \input{chapters/Pre_Abstract.tex} 123 | \authorization 124 | \signaturepage 125 | 126 | \input{chapters/Pre_Acknowledgements.tex} 127 | 128 | \tableofcontents 129 | \listoffigures 130 | \listoftables 131 | % TODO: see \cmd{\newlistofalgorithms} 132 | \newlistofalgorithms % This is to maintain the same appearance 133 | 134 | %% Dedication and Preface are optional 135 | %\input{chapters/Pre_Dedication.tex} 136 | %\input{chapters/Pre_Preface.tex} 137 | 138 | %% ------------------------------------------------- 139 | %% Main body 140 | %% ------------------------------------------------- 141 | \mainmatter 142 | 143 | \input{chapters/Ch_Introduction.tex} 144 | \input{chapters/Ch_ExampleChapter.tex} 145 | \input{chapters/Ch_Conclusion.tex} 146 | 147 | %% ------------------------------------------------- 148 | %% References 149 | %% ------------------------------------------------- 150 | 151 | \printbibliography[heading=bibintoc,title=References] 152 | 153 | %% ------------------------------------------------- 154 | %% Appendices 155 | %% ------------------------------------------------- 156 | \appendix 157 | 158 | \input{chapters/Appendix_Publications.tex} 159 | \input{chapters/Appendix_Requirements.tex} 160 | \input{chapters/Appendix_Figures.tex} 161 | 162 | \end{document} 163 | -------------------------------------------------------------------------------- /chapters/Appendix_Requirements.tex: -------------------------------------------------------------------------------- 1 | \chapter{FYTGS Requirements} 2 | \label{chap:thesis-preparation} 3 | 4 | The requirements are from the \href{https://fytgs.hkust.edu.hk/academics/Academic-Regulations-and-Requirements/Handbook-for-Research-Postgraduate-Studies/guidelines-thesis-preparation}{RPG Handbook}. 5 | 6 | \section{Components} 7 | 8 | \subsection{Order} 9 | 10 | A thesis should contain the following parts in the order shown: 11 | 12 | \begin{enumerate} 13 | \item Title page, containing in this order: 14 | \begin{enumerate} 15 | \item Thesis title 16 | \item Full name of the candidate 17 | \item Degree for which the thesis is submitted 18 | \item Name of the University, \emph{i.e.} The Hong Kong University of Science and Technology 19 | \item Month and year of submission 20 | \end{enumerate} 21 | \item Abstract ($\leq$ 300 words.) 22 | \item Authorization page 23 | \item Signature page 24 | \item Acknowledgments 25 | \item Table of contents 26 | \item Lists of figures and tables 27 | \item Thesis body 28 | \item Bibliography 29 | \item Appendices and other addenda, if any. 30 | \end{enumerate} 31 | 32 | \subsection{Abstract} 33 | 34 | Every copy of the thesis must have an English abstract, being a concise summary of the thesis, in 300 words or less. 35 | 36 | \subsection{Authorization page} 37 | 38 | On this page, students authorize the University to lend or reproduce the thesis. 39 | 40 | \begin{enumerate} 41 | \item The copyright of the thesis as a literary work vests in its author (the student). 42 | \item The authorization gives HKUST Library a non-exclusive right to make it available for scholarly research. 43 | \end{enumerate} 44 | 45 | \subsection{Signature page} 46 | 47 | This page provides signatures of the thesis supervisor(s) and Department Head confirming that the thesis is satisfactory. 48 | 49 | \subsection{Acknowledgments} 50 | 51 | The student is required to declare, in this section, the extent to which assistance has been given by his/her faculty and staff, fellow students, external bodies or others in the collection of materials and data, the design and construction of apparatus, the performance of experiments, the analysis of data, and the preparation of the thesis (including editorial help). In addition, it is appropriate to recognize the supervision and advice given by the thesis supervisor(s) and members of TSC. 52 | 53 | \subsection{Bibliography} 54 | 55 | The list of sources and references used should be presented in a standard format appropriate to the discipline; formatting should be consistent throughout. 56 | 57 | \subsection{Sample pages} 58 | Sample pages of both MPhil and PhD theses are provided here (MPhil / PhD), with specific instructions for formatting page content (centering, spacing, etc.). 59 | 60 | \section{Language, Style and Format} 61 | 62 | \subsection{Language} 63 | 64 | Theses should be written in English. 65 | 66 | Students in the School of Humanities and Social Science who are pursuing research work in the areas of Chinese Studies, and who can demonstrate a need to use Chinese to write their theses should seek prior approval from the School via their thesis supervisor and the divisional head. 67 | 68 | If approval is granted, students are also required to produce a translation of the title page, authorization page, signature page, table of contents and the abstract in English. 69 | 70 | \subsection{Pagination} 71 | 72 | \begin{enumerate} 73 | \item All pages, starting with the Title page should be numbered. 74 | \item All page numbers should be centered, at the bottom of each page. 75 | \item Page numbers of materials preceding the body of the text should be in small Roman numerals. 76 | \item Page numbers of the text, beginning with the first page of the first chapter and continuing through the bibliography, including any pages with tables, maps, figures, photographs, etc., and any subsequent appendices, should be in Arabic numerals. 77 | \item Start a new page after each chapter or section but not after a sub-section. 78 | \end{enumerate} 79 | 80 | \emph{Note: That means the Title page will be page i; the first page of the first chapter will be page 1.} 81 | 82 | \subsection{Format} 83 | 84 | \begin{enumerate} 85 | \item A conventional font, size 12-point, 10 to 12 characters per inch must be used. 86 | \item One-and-a-half line spacing should be used throughout the thesis, except for abstracts, indented quotations or footnotes where single line spacing may be used. 87 | \item All margins—top, bottom, sides—should be consistently 25mm (or no more than 30mm) in width. The same margin should be used throughout a thesis. Exceptionally, margins of a different size may be used when the nature of the thesis requires it. 88 | \end{enumerate} 89 | 90 | \subsection{Footnotes} 91 | 92 | \begin{enumerate} 93 | \item Footnotes may be placed at the bottom of the page, at the end of each chapter or after the end of the thesis body. 94 | \item Like references, footnotes should be presented in a standard format appropriate to the discipline. 95 | \item Both the position and format of footnotes should be consistent throughout the thesis. 96 | \end{enumerate} 97 | 98 | \subsection{Appendices} 99 | 100 | The format of each appended item should be consistent with the nature of that item, whether text, diagram, figure, etc., and should follow the guidelines for that item as listed here. 101 | 102 | \subsection{Figures, Tables and Illustrations} 103 | 104 | Figures, tables, graphs, etc., should be placed as close as possible to the text they illustrate. Charts, graphs, maps, and tables that are larger than a standard page should be provided as appendices. 105 | 106 | \subsection{Photographs/Images} 107 | 108 | \begin{enumerate} 109 | \item High contrast photos should be used because they reproduce well. Photographs with a glossy finish and those with dark backgrounds should be avoided. 110 | \item Images should be dense enough to provide 300 ppi for printing and 72 dpi for viewing. 111 | \end{enumerate} 112 | 113 | \subsection{Additional Materials} 114 | 115 | Raw files, datasets, media files, and high resolution photographs/images of any format can be included. 116 | 117 | \emph{Note: Students should get approval from their department head before deviating from any of the above requirements concerning paper size, font, margins, etc. } 118 | -------------------------------------------------------------------------------- /chapters/Ch_ExampleChapter.tex: -------------------------------------------------------------------------------- 1 | \chapter{Example chapter}\label{chap:sample} 2 | 3 | \section{Text}\label{chap:exp:sec:background} 4 | 5 | Small Caps font: \textsc{HkustThesis} 6 | 7 | \subsection{Cross references} 8 | 9 | You can use \lstinline|\cref{}| to automatically setup the cross reference name; instead, you can always use \lstinline|\ref{}| to customize the appearance of the cross reference. 10 | 11 | Chapter \ref{chap:introduction} tells you to read the latest PDF documentation. 12 | 13 | \cref{chap:conclusions} is a conclusion. 14 | 15 | \subsection{Citation and bibliography} 16 | 17 | Use \lstinline|biber| as \hologo{BibTeX} backend. 18 | 19 | Cite a book\cite{LaTeX.Companion}, some papers\cite{KeshavACMSIGCOMMComput.Commun.Rev.2007, WhitesidesAdv.Mater.2004}, and a conference\cite{, Babu2020IEEE33rdInt.Conf.MicroElectroMech.Syst.MEMS2020}. 20 | 21 | \subsubsection{Citation database} 22 | 23 | Bibliography entries (database) are stored in \lstinline|mythesis.bib|. You can use Zotero (or similar software) to generate \lstinline|another.bib| file. You can add multiple database files by adding their filenames one-by-one in the following commands in \lstinline|mythesis.tex|: 24 | 25 | \begin{lstlisting}[language=TeX] 26 | \addbibresource{mythesis.bib} 27 | \addbibresource{another.bib} 28 | \end{lstlisting} 29 | 30 | \subsubsection{Citation style} 31 | 32 | As described in the sample page from ECE department, the style is set to \lstinline|ieee| by default. You can modify the style in the \lstinline|hkustthesis.cls| file as you wish. 33 | 34 | \section{Math} 35 | 36 | \subsection{Symbols} 37 | 38 | \begin{itemize} 39 | \item Calligraphic letters: $\mathcal{A}$ 40 | \item Mathbb letters: $\mathbb{A}$ 41 | \item Mathfrak letters: $\mathfrak{A}$ 42 | \item Math Sans serif letters: $\mathsf{A}$ 43 | \item Math bold letters: $\mathbf{A, \alpha, \Sigma}$ \, (\lstinline|\mathbf|) 44 | \item Math bold letters: $\symbfup{A, \alpha, \Sigma}$ \, (\lstinline|\symbfup|) 45 | \item Math bold italic Greek letters\footnote{Avoid using \lstinline|bm| package as it conflicts with \lstinline|unicode-math| and it is outdated for \hologo{XeLaTeX}. You can alias some math commands by \lstinline|\\newcommand| or \lstinline|\\renewcommand| anyway.}: $\bm{\alpha}$ 46 | \item Math bold italic Greek letters in upper case: $\mathbi{A}$ 47 | \end{itemize} 48 | 49 | \subsection{Equations} 50 | 51 | \begin{equation} 52 | E^2 = m^2 + p^2\label{eq:mass-energy} 53 | \end{equation} 54 | 55 | \cref{eq:mass-energy} or Equation (\ref{eq:mass-energy}) gives the mass-energy relationship. 56 | 57 | \subsection{Theorem} 58 | 59 | \begin{definition} 60 | LCL is orange juice. 61 | \end{definition} 62 | 63 | \begin{proof} 64 | They are both orange. 65 | \end{proof} 66 | 67 | \begin{algorithm}[htbp] 68 | \caption{Temp} 69 | \begin{algorithmic}[1] 70 | \STATE Temp 71 | \end{algorithmic} 72 | \end{algorithm} 73 | 74 | Available theorem environments are listed below: 75 | 76 | algorithm, assumption, axiom, conclusion, condition, corollary, definition, example, lemma, proof, property, proposition, remark, theorem. 77 | 78 | \section{Figure} 79 | An example image is shown in \cref{fig:tikz example} or Figure (\ref{fig:tikz example}). 80 | 81 | \begin{figure}[H] 82 | \centering 83 | \begin{tikzpicture} 84 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 85 | \end{tikzpicture} 86 | \caption{An example tikz picture with a short caption.} 87 | \label{fig:tikz example short} 88 | \end{figure} 89 | 90 | \begin{figure}[H] 91 | \centering 92 | \begin{tikzpicture} 93 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 94 | \end{tikzpicture} 95 | \caption{An example tikz picture with breakline and\\ a very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very long caption.} 96 | \label{fig:tikz example} 97 | \end{figure} 98 | 99 | \section{Table} 100 | 101 | An example table is shown in \cref{tab:environment} or Table (\ref{tab:environment}). 102 | 103 | \begin{table}[H] 104 | \centering 105 | \caption{A table with a short caption.} 106 | \label{tab:table_short} 107 | \begin{tabular}{lll} 108 | \toprule 109 | OS & TeX environment & Test \\ 110 | \midrule 111 | Overleaf & \hologo{TeX}\,Live 2021$\sim$4 & Pass \\ 112 | Windows 10 & \hologo{TeX}\,Live 2020 & \color{red}{\verb|ltxhook| problem} \\ 113 | Ubuntu 20.04 & \hologo{TeX}\,Live 2021 & Pass \\ 114 | \bottomrule 115 | \end{tabular} 116 | \end{table} 117 | 118 | \begin{table}[H] 119 | \centering 120 | \caption{Test result on different platforms with breakline and\\ a very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very long caption.} 121 | \label{tab:environment} 122 | \begin{tabular}{lll} 123 | \toprule 124 | OS & TeX environment & Test \\ 125 | \midrule 126 | Overleaf & \hologo{TeX}\,Live 2021$\sim$4 & Pass \\ 127 | Arch Linux (2024.10) & \hologo{TeX}\,Live & Pass \\ 128 | Windows 10/11 & \hologo{TeX}\,Live 2021 & Pass \\ 129 | macOS 10.15 & \hologo{TeX}\,Live 2021 & Pass \\ 130 | Windows 10 & \hologo{TeX}\,Live 2020 & \color{red}{\verb|ltxhook| problem} \\ 131 | Ubuntu 20.04 & \hologo{TeX}\,Live 2021 & Pass \\ 132 | Termux & \hologo{TeX}\,Live 2021 & Pass \\ 133 | Windows 11 & \hologo{MiKTeX} 4.9 & Pass \\ 134 | Windows 10 & \hologo{MiKTeX} 4.4 & Pass \\ 135 | \bottomrule 136 | \end{tabular} 137 | \end{table} 138 | 139 | \section{Code} 140 | 141 | \subsection{Inline code} 142 | Use \lstinline$\lstinline||$ to print code snippets. The \lstinline$||$ marks delimit 143 | the code and can be replaced by any character not in the code; 144 | \eg \lstinline|\lstinline$$| gives the same result. 145 | 146 | \subsection{Code environment} 147 | The code to draw the \cref{fig:tikz example} is listed below: 148 | \begin{lstlisting}[caption={\hologo{LaTeX} code for inserting a figure}] 149 | \begin{figure}[htb] 150 | \begin{tikzpicture} 151 | \draw (0,0) -- (1, 0) -- (1, 1) -- cycle; 152 | \end{tikzpicture} 153 | \caption{An example picture with long caption: \blindtext\\\blindtext} 154 | \label{fig:tikz example} % this is a comment 155 | \end{figure} 156 | \end{lstlisting} 157 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The LaTeX Project Public License 2 | =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- 3 | 4 | LPPL Version 1.3c 2008-05-04 5 | 6 | Copyright 1999 2002-2008 LaTeX3 Project 7 | Everyone is allowed to distribute verbatim copies of this 8 | license document, but modification of it is not allowed. 9 | 10 | 11 | PREAMBLE 12 | ======== 13 | 14 | The LaTeX Project Public License (LPPL) is the primary license under 15 | which the LaTeX kernel and the base LaTeX packages are distributed. 16 | 17 | You may use this license for any work of which you hold the copyright 18 | and which you wish to distribute. This license may be particularly 19 | suitable if your work is TeX-related (such as a LaTeX package), but 20 | it is written in such a way that you can use it even if your work is 21 | unrelated to TeX. 22 | 23 | The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', 24 | below, gives instructions, examples, and recommendations for authors 25 | who are considering distributing their works under this license. 26 | 27 | This license gives conditions under which a work may be distributed 28 | and modified, as well as conditions under which modified versions of 29 | that work may be distributed. 30 | 31 | We, the LaTeX3 Project, believe that the conditions below give you 32 | the freedom to make and distribute modified versions of your work 33 | that conform with whatever technical specifications you wish while 34 | maintaining the availability, integrity, and reliability of 35 | that work. If you do not see how to achieve your goal while 36 | meeting these conditions, then read the document `cfgguide.tex' 37 | and `modguide.tex' in the base LaTeX distribution for suggestions. 38 | 39 | 40 | DEFINITIONS 41 | =========== 42 | 43 | In this license document the following terms are used: 44 | 45 | `Work' 46 | Any work being distributed under this License. 47 | 48 | `Derived Work' 49 | Any work that under any applicable law is derived from the Work. 50 | 51 | `Modification' 52 | Any procedure that produces a Derived Work under any applicable 53 | law -- for example, the production of a file containing an 54 | original file associated with the Work or a significant portion of 55 | such a file, either verbatim or with modifications and/or 56 | translated into another language. 57 | 58 | `Modify' 59 | To apply any procedure that produces a Derived Work under any 60 | applicable law. 61 | 62 | `Distribution' 63 | Making copies of the Work available from one person to another, in 64 | whole or in part. Distribution includes (but is not limited to) 65 | making any electronic components of the Work accessible by 66 | file transfer protocols such as FTP or HTTP or by shared file 67 | systems such as Sun's Network File System (NFS). 68 | 69 | `Compiled Work' 70 | A version of the Work that has been processed into a form where it 71 | is directly usable on a computer system. This processing may 72 | include using installation facilities provided by the Work, 73 | transformations of the Work, copying of components of the Work, or 74 | other activities. Note that modification of any installation 75 | facilities provided by the Work constitutes modification of the Work. 76 | 77 | `Current Maintainer' 78 | A person or persons nominated as such within the Work. If there is 79 | no such explicit nomination then it is the `Copyright Holder' under 80 | any applicable law. 81 | 82 | `Base Interpreter' 83 | A program or process that is normally needed for running or 84 | interpreting a part or the whole of the Work. 85 | 86 | A Base Interpreter may depend on external components but these 87 | are not considered part of the Base Interpreter provided that each 88 | external component clearly identifies itself whenever it is used 89 | interactively. Unless explicitly specified when applying the 90 | license to the Work, the only applicable Base Interpreter is a 91 | `LaTeX-Format' or in the case of files belonging to the 92 | `LaTeX-format' a program implementing the `TeX language'. 93 | 94 | 95 | 96 | CONDITIONS ON DISTRIBUTION AND MODIFICATION 97 | =========================================== 98 | 99 | 1. Activities other than distribution and/or modification of the Work 100 | are not covered by this license; they are outside its scope. In 101 | particular, the act of running the Work is not restricted and no 102 | requirements are made concerning any offers of support for the Work. 103 | 104 | 2. You may distribute a complete, unmodified copy of the Work as you 105 | received it. Distribution of only part of the Work is considered 106 | modification of the Work, and no right to distribute such a Derived 107 | Work may be assumed under the terms of this clause. 108 | 109 | 3. You may distribute a Compiled Work that has been generated from a 110 | complete, unmodified copy of the Work as distributed under Clause 2 111 | above, as long as that Compiled Work is distributed in such a way that 112 | the recipients may install the Compiled Work on their system exactly 113 | as it would have been installed if they generated a Compiled Work 114 | directly from the Work. 115 | 116 | 4. If you are the Current Maintainer of the Work, you may, without 117 | restriction, modify the Work, thus creating a Derived Work. You may 118 | also distribute the Derived Work without restriction, including 119 | Compiled Works generated from the Derived Work. Derived Works 120 | distributed in this manner by the Current Maintainer are considered to 121 | be updated versions of the Work. 122 | 123 | 5. If you are not the Current Maintainer of the Work, you may modify 124 | your copy of the Work, thus creating a Derived Work based on the Work, 125 | and compile this Derived Work, thus creating a Compiled Work based on 126 | the Derived Work. 127 | 128 | 6. If you are not the Current Maintainer of the Work, you may 129 | distribute a Derived Work provided the following conditions are met 130 | for every component of the Work unless that component clearly states 131 | in the copyright notice that it is exempt from that condition. Only 132 | the Current Maintainer is allowed to add such statements of exemption 133 | to a component of the Work. 134 | 135 | a. If a component of this Derived Work can be a direct replacement 136 | for a component of the Work when that component is used with the 137 | Base Interpreter, then, wherever this component of the Work 138 | identifies itself to the user when used interactively with that 139 | Base Interpreter, the replacement component of this Derived Work 140 | clearly and unambiguously identifies itself as a modified version 141 | of this component to the user when used interactively with that 142 | Base Interpreter. 143 | 144 | b. Every component of the Derived Work contains prominent notices 145 | detailing the nature of the changes to that component, or a 146 | prominent reference to another file that is distributed as part 147 | of the Derived Work and that contains a complete and accurate log 148 | of the changes. 149 | 150 | c. No information in the Derived Work implies that any persons, 151 | including (but not limited to) the authors of the original version 152 | of the Work, provide any support, including (but not limited to) 153 | the reporting and handling of errors, to recipients of the 154 | Derived Work unless those persons have stated explicitly that 155 | they do provide such support for the Derived Work. 156 | 157 | d. You distribute at least one of the following with the Derived Work: 158 | 159 | 1. A complete, unmodified copy of the Work; 160 | if your distribution of a modified component is made by 161 | offering access to copy the modified component from a 162 | designated place, then offering equivalent access to copy 163 | the Work from the same or some similar place meets this 164 | condition, even though third parties are not compelled to 165 | copy the Work along with the modified component; 166 | 167 | 2. Information that is sufficient to obtain a complete, 168 | unmodified copy of the Work. 169 | 170 | 7. If you are not the Current Maintainer of the Work, you may 171 | distribute a Compiled Work generated from a Derived Work, as long as 172 | the Derived Work is distributed to all recipients of the Compiled 173 | Work, and as long as the conditions of Clause 6, above, are met with 174 | regard to the Derived Work. 175 | 176 | 8. The conditions above are not intended to prohibit, and hence do not 177 | apply to, the modification, by any method, of any component so that it 178 | becomes identical to an updated version of that component of the Work as 179 | it is distributed by the Current Maintainer under Clause 4, above. 180 | 181 | 9. Distribution of the Work or any Derived Work in an alternative 182 | format, where the Work or that Derived Work (in whole or in part) is 183 | then produced by applying some process to that format, does not relax or 184 | nullify any sections of this license as they pertain to the results of 185 | applying that process. 186 | 187 | 10. a. A Derived Work may be distributed under a different license 188 | provided that license itself honors the conditions listed in 189 | Clause 6 above, in regard to the Work, though it does not have 190 | to honor the rest of the conditions in this license. 191 | 192 | b. If a Derived Work is distributed under a different license, that 193 | Derived Work must provide sufficient documentation as part of 194 | itself to allow each recipient of that Derived Work to honor the 195 | restrictions in Clause 6 above, concerning changes from the Work. 196 | 197 | 11. This license places no restrictions on works that are unrelated to 198 | the Work, nor does this license place any restrictions on aggregating 199 | such works with the Work by any means. 200 | 201 | 12. Nothing in this license is intended to, or may be used to, prevent 202 | complete compliance by all parties with all applicable laws. 203 | 204 | 205 | NO WARRANTY 206 | =========== 207 | 208 | There is no warranty for the Work. Except when otherwise stated in 209 | writing, the Copyright Holder provides the Work `as is', without 210 | warranty of any kind, either expressed or implied, including, but not 211 | limited to, the implied warranties of merchantability and fitness for a 212 | particular purpose. The entire risk as to the quality and performance 213 | of the Work is with you. Should the Work prove defective, you assume 214 | the cost of all necessary servicing, repair, or correction. 215 | 216 | In no event unless required by applicable law or agreed to in writing 217 | will The Copyright Holder, or any author named in the components of the 218 | Work, or any other party who may distribute and/or modify the Work as 219 | permitted above, be liable to you for damages, including any general, 220 | special, incidental or consequential damages arising out of any use of 221 | the Work or out of inability to use the Work (including, but not limited 222 | to, loss of data, data being rendered inaccurate, or losses sustained by 223 | anyone as a result of any failure of the Work to operate with any other 224 | programs), even if the Copyright Holder or said author or said other 225 | party has been advised of the possibility of such damages. 226 | 227 | 228 | MAINTENANCE OF THE WORK 229 | ======================= 230 | 231 | The Work has the status `author-maintained' if the Copyright Holder 232 | explicitly and prominently states near the primary copyright notice in 233 | the Work that the Work can only be maintained by the Copyright Holder 234 | or simply that it is `author-maintained'. 235 | 236 | The Work has the status `maintained' if there is a Current Maintainer 237 | who has indicated in the Work that they are willing to receive error 238 | reports for the Work (for example, by supplying a valid e-mail 239 | address). It is not required for the Current Maintainer to acknowledge 240 | or act upon these error reports. 241 | 242 | The Work changes from status `maintained' to `unmaintained' if there 243 | is no Current Maintainer, or the person stated to be Current 244 | Maintainer of the work cannot be reached through the indicated means 245 | of communication for a period of six months, and there are no other 246 | significant signs of active maintenance. 247 | 248 | You can become the Current Maintainer of the Work by agreement with 249 | any existing Current Maintainer to take over this role. 250 | 251 | If the Work is unmaintained, you can become the Current Maintainer of 252 | the Work through the following steps: 253 | 254 | 1. Make a reasonable attempt to trace the Current Maintainer (and 255 | the Copyright Holder, if the two differ) through the means of 256 | an Internet or similar search. 257 | 258 | 2. If this search is successful, then enquire whether the Work 259 | is still maintained. 260 | 261 | a. If it is being maintained, then ask the Current Maintainer 262 | to update their communication data within one month. 263 | 264 | b. If the search is unsuccessful or no action to resume active 265 | maintenance is taken by the Current Maintainer, then announce 266 | within the pertinent community your intention to take over 267 | maintenance. (If the Work is a LaTeX work, this could be 268 | done, for example, by posting to comp.text.tex.) 269 | 270 | 3a. If the Current Maintainer is reachable and agrees to pass 271 | maintenance of the Work to you, then this takes effect 272 | immediately upon announcement. 273 | 274 | b. If the Current Maintainer is not reachable and the Copyright 275 | Holder agrees that maintenance of the Work be passed to you, 276 | then this takes effect immediately upon announcement. 277 | 278 | 4. If you make an `intention announcement' as described in 2b. above 279 | and after three months your intention is challenged neither by 280 | the Current Maintainer nor by the Copyright Holder nor by other 281 | people, then you may arrange for the Work to be changed so as 282 | to name you as the (new) Current Maintainer. 283 | 284 | 5. If the previously unreachable Current Maintainer becomes 285 | reachable once more within three months of a change completed 286 | under the terms of 3b) or 4), then that Current Maintainer must 287 | become or remain the Current Maintainer upon request provided 288 | they then update their communication data within one month. 289 | 290 | A change in the Current Maintainer does not, of itself, alter the fact 291 | that the Work is distributed under the LPPL license. 292 | 293 | If you become the Current Maintainer of the Work, you should 294 | immediately provide, within the Work, a prominent and unambiguous 295 | statement of your status as Current Maintainer. You should also 296 | announce your new status to the same pertinent community as 297 | in 2b) above. 298 | 299 | 300 | WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE 301 | ====================================================== 302 | 303 | This section contains important instructions, examples, and 304 | recommendations for authors who are considering distributing their 305 | works under this license. These authors are addressed as `you' in 306 | this section. 307 | 308 | Choosing This License or Another License 309 | ---------------------------------------- 310 | 311 | If for any part of your work you want or need to use *distribution* 312 | conditions that differ significantly from those in this license, then 313 | do not refer to this license anywhere in your work but, instead, 314 | distribute your work under a different license. You may use the text 315 | of this license as a model for your own license, but your license 316 | should not refer to the LPPL or otherwise give the impression that 317 | your work is distributed under the LPPL. 318 | 319 | The document `modguide.tex' in the base LaTeX distribution explains 320 | the motivation behind the conditions of this license. It explains, 321 | for example, why distributing LaTeX under the GNU General Public 322 | License (GPL) was considered inappropriate. Even if your work is 323 | unrelated to LaTeX, the discussion in `modguide.tex' may still be 324 | relevant, and authors intending to distribute their works under any 325 | license are encouraged to read it. 326 | 327 | A Recommendation on Modification Without Distribution 328 | ----------------------------------------------------- 329 | 330 | It is wise never to modify a component of the Work, even for your own 331 | personal use, without also meeting the above conditions for 332 | distributing the modified component. While you might intend that such 333 | modifications will never be distributed, often this will happen by 334 | accident -- you may forget that you have modified that component; or 335 | it may not occur to you when allowing others to access the modified 336 | version that you are thus distributing it and violating the conditions 337 | of this license in ways that could have legal implications and, worse, 338 | cause problems for the community. It is therefore usually in your 339 | best interest to keep your copy of the Work identical with the public 340 | one. Many works provide ways to control the behavior of that work 341 | without altering any of its licensed components. 342 | 343 | How to Use This License 344 | ----------------------- 345 | 346 | To use this license, place in each of the components of your work both 347 | an explicit copyright notice including your name and the year the work 348 | was authored and/or last substantially modified. Include also a 349 | statement that the distribution and/or modification of that 350 | component is constrained by the conditions in this license. 351 | 352 | Here is an example of such a notice and statement: 353 | 354 | %% pig.dtx 355 | %% Copyright 2005 M. Y. Name 356 | % 357 | % This work may be distributed and/or modified under the 358 | % conditions of the LaTeX Project Public License, either version 1.3 359 | % of this license or (at your option) any later version. 360 | % The latest version of this license is in 361 | % http://www.latex-project.org/lppl.txt 362 | % and version 1.3 or later is part of all distributions of LaTeX 363 | % version 2005/12/01 or later. 364 | % 365 | % This work has the LPPL maintenance status `maintained'. 366 | % 367 | % The Current Maintainer of this work is M. Y. Name. 368 | % 369 | % This work consists of the files pig.dtx and pig.ins 370 | % and the derived file pig.sty. 371 | 372 | Given such a notice and statement in a file, the conditions 373 | given in this license document would apply, with the `Work' referring 374 | to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being 375 | generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' 376 | referring to any `LaTeX-Format', and both `Copyright Holder' and 377 | `Current Maintainer' referring to the person `M. Y. Name'. 378 | 379 | If you do not want the Maintenance section of LPPL to apply to your 380 | Work, change `maintained' above into `author-maintained'. 381 | However, we recommend that you use `maintained', as the Maintenance 382 | section was added in order to ensure that your Work remains useful to 383 | the community even when you can no longer maintain and support it 384 | yourself. 385 | 386 | Derived Works That Are Not Replacements 387 | --------------------------------------- 388 | 389 | Several clauses of the LPPL specify means to provide reliability and 390 | stability for the user community. They therefore concern themselves 391 | with the case that a Derived Work is intended to be used as a 392 | (compatible or incompatible) replacement of the original Work. If 393 | this is not the case (e.g., if a few lines of code are reused for a 394 | completely different task), then clauses 6b and 6d shall not apply. 395 | 396 | 397 | Important Recommendations 398 | ------------------------- 399 | 400 | Defining What Constitutes the Work 401 | 402 | The LPPL requires that distributions of the Work contain all the 403 | files of the Work. It is therefore important that you provide a 404 | way for the licensee to determine which files constitute the Work. 405 | This could, for example, be achieved by explicitly listing all the 406 | files of the Work near the copyright notice of each file or by 407 | using a line such as: 408 | 409 | % This work consists of all files listed in manifest.txt. 410 | 411 | in that place. In the absence of an unequivocal list it might be 412 | impossible for the licensee to determine what is considered by you 413 | to comprise the Work and, in such a case, the licensee would be 414 | entitled to make reasonable conjectures as to which files comprise 415 | the Work. 416 | 417 | -------------------------------------------------------------------------------- /resources/ProjectLogo/redbird-raw.svg: -------------------------------------------------------------------------------- 1 | 2 | 18 | 20 | 21 | 23 | image/svg+xml 24 | 26 | 27 | 28 | 29 | 30 | 57 | 64 | 71 | 78 | 85 | 86 | 88 | 259 | 266 | 270 | 274 | 278 | 282 | 286 | 290 | 291 | 299 | 303 | 307 | 311 | 315 | 319 | 320 | 328 | 332 | 336 | 340 | 344 | 348 | 352 | 356 | 357 | 364 | 372 | 376 | 380 | 384 | 388 | 389 | 397 | 401 | 405 | 409 | 413 | 417 | 421 | 425 | 429 | 430 | 437 | 445 | 449 | 453 | 457 | 461 | 465 | 469 | 470 | 477 | 481 | 485 | 486 | 493 | 497 | 501 | 505 | 509 | 513 | 517 | 521 | 525 | 529 | 533 | 537 | 538 | 545 | 549 | 553 | 554 | 561 | 565 | 569 | 573 | 574 | 581 | 585 | 589 | 590 | 597 | 604 | 608 | 612 | 613 | 620 | 627 | 631 | 635 | 639 | 640 | 647 | 651 | 655 | 659 | 663 | 667 | 671 | 675 | 679 | 683 | 687 | 688 | 695 | 699 | 703 | 707 | 708 | 716 | 720 | 724 | 728 | 732 | 736 | 737 | 745 | 749 | 753 | 757 | 761 | 762 | 770 | 774 | 778 | 782 | 786 | 790 | 794 | 798 | 799 | 806 | 814 | 818 | 822 | 826 | 830 | 831 | 839 | 843 | 847 | 851 | 855 | 859 | 863 | 867 | 871 | 872 | 879 | 887 | 891 | 895 | 899 | 903 | 907 | 911 | 912 | 913 | 916 | 922 | 928 | 929 | 930 | -------------------------------------------------------------------------------- /resources/ProjectLogo/qrcode2github.svg: -------------------------------------------------------------------------------- 1 | 2 | 15 | 36 | 38 | 44 | 45 | 49 | 56 | 63 | 70 | 77 | 84 | 91 | 98 | 105 | 112 | 119 | 126 | 133 | 140 | 147 | 154 | 161 | 168 | 175 | 182 | 189 | 196 | 203 | 210 | 217 | 224 | 231 | 238 | 245 | 252 | 259 | 266 | 273 | 280 | 287 | 294 | 301 | 308 | 315 | 322 | 329 | 336 | 343 | 350 | 357 | 364 | 371 | 378 | 385 | 392 | 399 | 406 | 413 | 420 | 427 | 434 | 441 | 448 | 455 | 462 | 469 | 476 | 483 | 490 | 497 | 504 | 511 | 518 | 525 | 532 | 539 | 546 | 553 | 560 | 567 | 574 | 581 | 588 | 595 | 602 | 609 | 616 | 623 | 630 | 637 | 644 | 651 | 658 | 665 | 672 | 679 | 686 | 693 | 700 | 707 | 714 | 721 | 728 | 735 | 742 | 749 | 756 | 763 | 770 | 777 | 784 | 791 | 798 | 805 | 812 | 819 | 826 | 833 | 840 | 847 | 854 | 861 | 868 | 875 | 882 | 889 | 896 | 903 | 910 | 917 | 924 | 931 | 938 | 945 | 952 | 959 | 966 | 973 | 980 | 987 | 994 | 1001 | 1008 | 1015 | 1022 | 1029 | 1036 | 1043 | 1050 | 1057 | 1064 | 1071 | 1078 | 1085 | 1092 | 1099 | 1106 | 1113 | 1120 | 1127 | 1134 | 1141 | 1148 | 1155 | 1162 | 1169 | 1176 | 1183 | 1190 | 1197 | 1204 | 1211 | 1218 | 1225 | 1232 | 1239 | 1246 | 1253 | 1260 | 1267 | 1274 | 1281 | 1288 | 1295 | 1302 | 1309 | 1316 | 1323 | 1330 | 1337 | 1344 | 1351 | 1358 | 1365 | 1372 | 1379 | 1386 | 1393 | 1400 | 1407 | 1414 | 1421 | 1428 | 1435 | 1442 | 1449 | 1456 | 1463 | 1470 | 1477 | 1484 | 1491 | 1498 | 1505 | 1512 | 1519 | 1526 | 1533 | 1540 | 1547 | 1554 | 1561 | 1568 | 1575 | 1582 | 1589 | 1596 | 1603 | 1610 | 1617 | 1624 | 1631 | 1638 | 1645 | 1652 | 1659 | 1666 | 1673 | 1680 | 1687 | 1694 | 1701 | 1708 | 1715 | 1722 | 1729 | 1736 | 1743 | 1750 | 1757 | 1764 | 1771 | 1778 | 1785 | 1792 | 1799 | 1806 | 1813 | 1820 | 1827 | 1834 | 1841 | 1848 | 1855 | 1862 | 1869 | 1876 | 1883 | 1890 | 1897 | 1904 | 1911 | 1918 | 1925 | 1932 | 1939 | 1946 | 1953 | 1960 | 1967 | 1974 | 1981 | 1988 | 1995 | 2002 | 2009 | 2016 | 2023 | 2030 | 2037 | 2044 | 2051 | 2058 | 2065 | 2072 | 2079 | 2086 | 2093 | 2100 | 2107 | 2114 | 2121 | 2128 | 2135 | 2142 | 2149 | 2156 | 2163 | 2170 | 2177 | 2184 | 2191 | 2198 | 2205 | 2212 | 2219 | 2226 | 2233 | 2240 | 2247 | 2254 | 2261 | 2268 | 2275 | 2282 | 2289 | 2296 | 2303 | 2310 | 2317 | 2324 | 2331 | 2338 | 2345 | 2352 | 2359 | 2366 | 2373 | 2380 | 2387 | 2394 | 2401 | 2408 | 2415 | 2422 | 2429 | 2436 | 2443 | 2450 | 2457 | 2464 | 2471 | 2478 | 2485 | 2492 | 2499 | 2506 | 2513 | 2520 | 2527 | 2534 | 2541 | 2548 | 2555 | 2562 | 2569 | 2576 | 2583 | 2590 | 2597 | 2604 | 2611 | 2618 | 2625 | 2632 | 2639 | 2646 | 2653 | 2660 | 2667 | 2674 | 2681 | 2688 | 2695 | 2702 | 2709 | 2716 | 2723 | 2730 | 2737 | 2744 | 2751 | 2758 | 2765 | 2772 | 2779 | 2786 | 2793 | 2800 | 2807 | 2814 | 2821 | 2828 | 2835 | 2842 | 2849 | 2856 | 2863 | 2870 | 2877 | 2884 | 2891 | 2898 | 2905 | 2912 | 2919 | 2926 | 2933 | 2940 | 2947 | 2954 | 2961 | 2968 | 2975 | 2976 | 2978 | 2979 | --------------------------------------------------------------------------------