Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elsa-lab/nthuthesis

Typesetting theses for members of National Tsing Hua University (NTHU), Hsinchu, Taiwan.
https://github.com/elsa-lab/nthuthesis

latex nthu thesis

Last synced: about 2 months ago
JSON representation

Typesetting theses for members of National Tsing Hua University (NTHU), Hsinchu, Taiwan.

Host: GitHub
URL: https://github.com/elsa-lab/nthuthesis
Owner: elsa-lab
License: mit
Created: 2021-06-13T08:43:39.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-07-17T12:04:01.000Z (over 1 year ago)
Last Synced: 2023-10-26T22:34:03.921Z (about 1 year ago)
Topics: latex, nthu, thesis
Language: TeX
Homepage:
Size: 1.93 MB
Stars: 5
Watchers: 4
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# The NTHUthesis LaTeX Class

This README describes how to use the NTHUthesis class with LaTeX to produce high quality typeset theses that are suitable for submission to National Tsing Hua University (NTHU).

|![cover](https://i.imgur.com/XAqUXD9.png)|![chinese-abstract](https://i.imgur.com/HMlJhHu.png)|![english-abstract](https://i.imgur.com/TRXFFIa.png)|![table-of-contents](https://i.imgur.com/4ACrSq0.png)
|---|---|---|---

## Class Options

There are three class options that can be used to control the behavior of NTHUthesis. These are specified in the traditional LaTeX way. For example,

```latex
\documentclass[master]{NTHUthesis}
```

### `master`, `doctor`

NTHUthesis offers two modes for typesetting theses. The `master` mode will produce theses for a master's degree. On the other hand, the `doctor` mode will produce doctoral theses.

### `nowatermark`

By default, NTHUthesis produces theses with watermarking. However, the watermark can be omitted by specifying the `nowatermark` option. For example,

```latex
\documentclass[doctor,nowatermark]{NTHUthesis}
```

### `zhmode`

NTHUthesis offers an additional mode for typesetting theses in Chinese by specifying the `zhmode` option. For example,

```latex
\documentclass[master,zhmode]{NTHUthesis}
```

When `zhmode` is enabled, a new command `chref` is provided, allowing the user to reference a chapter number in Chinese instead of Arabic. For example,

```latex
\chapter{chapter title}
\label{chap:title}

... 第\chref{chap:title}章 ...
```

## Provided Commands

- `\makecover`: Create a cover that is suitable for submission to NTHU.
- `\maketoc`: Create a table of contents, including the list of figures and the list of tables.
- Thesis information is specified in `thesis_info.tex` through the following commands:
- `\titleZH`: Title in Chinese
- `\titleEN`: Title in English
- `\instituteZH`: Institute in Chinese
- `\studentID`: Author's student ID
- `\studentZH`: Author's name in Chinese
- `\studentEN`: Author's name in English
- `\advisorZH`: Advisor's name in Chinese
- `\advisorEN`: Advisor's name in English
- `\yearZH`: The year of the dissertation defense
- `\monthZH`: The month of the dissertation defense

## Provided Environments

- `abstractZH`: Create a chapter of the abstract in Chinese.
- `abstractEN`: Create a chapter of the abstract in English.
- `acknowledgementsZH`: Create a chapter of acknowledgements in Chinese.
- `acknowledgementsEN`: Create a chapter of acknowledgements in English.

## Minimal Working Example

### `thesis_main.tex`

This is a template for typesetting the main manuscript that is suitable for submission. One can access the output of this template through `exmaples/thesis_main.pdf`.

### `thesis_cover.tex`

This is a template for typesetting the cover without watermarking. One can access the output of this template through `exmaples/thesis_cover.pdf`.

### `thesis_abstracts.tex`

This is a template for typesetting the abstract of the main manuscript. One can access the output of this template through `exmaples/thesis_abstracts.pdf`.

## Known Issues

### Compilation Failed with `microtype`

The following two lines would cause compilation to fail when the package `microtype` is used.

```latex
\AtBeginDocument{\begin{CJK*}{UTF8}{bkai}}
\AtEndDocument{\end{CJK*}}
```

Please comment out them from `NTHUthesis.cls` and manually add them after `\begin{document}` and before `\end{document}` to resolve the issue. For example,

```latex
...
\begin{document}
\begin{CJK*}{UTF8}{bkai}
...
\end{CJK*}
\end{document}
```

### Adjusting Watermark Opacity

Please note that the watermark opacity is set to 100% in [博碩士論文上傳說明](https://www.lib.nthu.edu.tw/ETD/downloads/upload.pdf). However, without reducing its opacity, the watermark may be indistinguishable from the foreground text and thus impede reading. After the discussion in the closed issue https://github.com/elsa-lab/NTHUthesis/issues/2, we decided to leave the customization effort to the user who thinks reducing opacity is necessary. One possible modification can be done in `NTHUthesis.cls` as follows.

*Origin*:
```latex
% Watermark of NTHU
\ifdefined \nowatermark \else
\RequirePackage{draftwatermark}
\SetWatermarkAngle{0}
\SetWatermarkText{\includegraphics[width=.5\paperwidth]{nthu-logo.pdf}}
\fi
```

*Modification*:
```latex
% Watermark of NTHU
\ifdefined \nowatermark \else
\RequirePackage{draftwatermark}
\RequirePackage{transparent}
\SetWatermarkAngle{0}
\SetWatermarkText{\transparent{0.5}\includegraphics[width=.5\paperwidth]{nthu-logo.pdf}}
\fi
```

## Reference

- [View this project on Overleaf](https://www.overleaf.com/latex/templates/national-tsing-hua-university-nthu-thesis-template/yqdhswpwsqrd)
- [View this project on ELSA LaTeX](https://elsa-latex.cs.nthu.edu.tw/read/zqsbsnzfrznr)
- [國立清華大學-教務註冊組-碩博士畢業相關規定](http://registra.site.nthu.edu.tw/p/404-1211-5155.php?Lang=zh-tw)
- [國立清華大學-圖書館-博碩士論文下載區](https://www.lib.nthu.edu.tw/ETD/downloads/downloads.htm)