Giter VIP home page Giter VIP logo

hkust-thesis's Introduction

HKUST Thesis

LICENSE STARS TEST RELEASE

中文说明

HKUST Thesis template for RPG students implemented with LaTeX3.

Getting started

Try this template online on Overleaf in 1 minute! You only need to do 2 things:

  1. Remember to change the Compiler to XeLaTeX via the top left Menu button, otherwise it won't compile.
  2. Download and read carefully the PDF documentation before you edit your thesis.

Alternatively, you can download the release file and try it on your local machine.

Contributions

If you find any problems or have any suggestions, please file an issue or PR.

Disclaimer

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.

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/PhD) provided by the RPG Handbook. However, this template takes no responsibility for any potential inconsistency.

License

LaTeX Project Public License (version 1.3c)

Acknowledgements

This project is modified from the NJUThesis project with the help from NJU-LUG.

hkust-thesis's People

Contributors

atxy-blip avatar github-young avatar zybbigpy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

hkust-thesis's Issues

Blank pages

Hi @github-young , thank you very much for contributing such a great template for the UST community. I just have a question regarding the blank pages at around toc, lof, lot, etc., is it required to have these blank pages? Also, how can I remove them? I tried to remove all \clearpage and \cleardoublepage in hkustthesis.cls, but it seemed to be not working...

Thanks in advance!

Error in algorithm environment

For example, this code will have an error: algorithm.sty:96: LaTeX Error: Command \c@algorithm already defined. [\floatname]

\begin{algorithm}
\caption{1}
\label{alg:1}
\begin{algorithmic}
\end{algorithmic}
\Require 1
\Ensure 1
\end{algorithm}

Solution:
We can solve the problem by commenting the following part in hkustthesis.cls:

\declaretheorem[
    name=Algorithm,
    style=hkustthm,
    refname={algorithm,algorithms},
    Refname={Algorithm,Algorithms},
    % numberwithin=section,
]{algorithm}

Then we can add a line \listofalgorithms after

\listoffigures
\listoftables

in the front, which will have a list page of all the algorithms in the thesis, just like the list page of all the figures from \listoffigures.

One-and-a-half line spacing

The reply from GS shows that the "one-and-a-half" line spacing is based on MS Word.

  • Implement this requirement in LaTeX.
    • setspace
    • linespread
    • setstretch
  • carefully check font and line spacing in other parts after the above step:
    • abstract
    • toc
    • footnote
    • enumitem: it has different line spacing scheme: the displayed value of line spacing may not be the 1.5 line space, but the actual spacing from Acrobat is indeed the same as the main text.
    • appendix

Github Workflow Update

Hello Young,

Now, we have a nice workflow to make the things automatically run. I think we may need to split the workflow into three different files to make the whole process smooth and clear:

  1. test workflow, when contributors file a pull request, it will automatically run some tests to ensure the compilation is OK. It should be triggered automatically.
  2. build workflow, some advanced users may directly fork the repo, write their thesis and organize it through GitHub. We can provide a build workflow to construct their thesis online and return a PDF file. It can be triggered manually.
  3. release workflow, when we tag the commit as a release, GitHub Actions will help us release the new version of HKUST thesis template. It should be triggered automatically.

TODO & feature request

Please add features you think necessary in this issue.

  • lstlisting style for other languages: remove or add? Removed.
  • signature page: list of TEC names? RPG handbook does not mention this.
    I found that ECE department requires this.
  • documentation:
    • README (Pages)
    • mythesis
    • dtx
  • bib: Add an option for users to change bib style (ieee/nature/...)
  • Different requirements from departments? Issue welcomed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.