Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.69 KB

README.md

File metadata and controls

55 lines (37 loc) · 2.69 KB

CUHKThesis

A simple LaTeX template for CUHK thesis based on CUHK format guide.

Main features

  • Support English and Chinese fonts for Linux, MacOS, Windows, and other platforms.
  • Show titles of chapters (odd pages) and sections (even pages) in fancyhead.
  • Support glossaries and nomenclature with automatic compiler latexmk.
  • Support hyperlinks (url) and cross-reference (backref) for bibliographies.
  • Fast compiling.

Install

  1. Download or clone this repository.
  2. Install major TeX distributions with XeLaTeX or use Overleaf (recommended).

Usage

TL;DR: Run command latexmk && latexmk -c in shell.

Edit the corresponding .tex, .bib files with your favorite editor and compile thesis.tex with latexmk command. Then you will get the demo.

For fast compiling, set draftmode=1 in .latexmkrc, this will skip front-matters and Chinese fonts. For final compiling, convert to draftmode=0 (default).

To clean up auxiliary files, run latexmk -c.

Directory structure

Directory Description
add-ons/ abstract, front matters, and appendices
chapters/ major separated chapters
figures/ the suggested folder for inserted figures
tables/ the suggested folder for inserted tables
settings/ for settings and commands

Settings and commands

  • The fontsets are automatically selected in settings/fonts.tex for Windows, MacOS, Linux, and other systems.
  • You can change the formats and styles of the thesis by adjusting the settings in settings/settings.tex, e.g., change backref to false.
  • The commands for fast-typing are stored in settings/usrcmds.tex. Users can define their own commands in this file.
  • Usually we don't have to modify settings/cmds.tex since it only contains commands for outputting standard pages.

References

Any issues, discussions or pull requests are welcome.