Skip to content

UNamurCSFaculty/ThesisTemplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PhD thesis template for Computer Science Faculty of the University of Namur


UNamur Computer Science Faculty

Description

This repository contains a proposed template intended for PhD students writing their doctoral thesis in the Computer Science Faculty at the University of Namur. This template is designed to be plug-and-play. You only need to follow the instructions and write your content text. All layout aspects are already set up, but you are free to adapt them. The template is also well-commented to make its handling and understanding easy. Finally, the template is accompanied by several examples (e.g., tables, listings, algorithms, SVG images, enumeration styles, glossary entry styles, hyphenations, etc.).

👀 See what it looks like with the PDF preview

Recent examples of theses. These theses were published in previous years and can serve as examples. Please note that everyone is free to use the approach they wish, so some theses may not have used this model.

Disclaimer

Keep in mind that this version is a proposal. This is not an official template that has to be used. You can use your own template. Or, you can also adapt this one (see License).

Getting started

Basically, you have two main options.

Overleaf

  1. Download the zip file of the source code: green button at the top Code > Download ZIP
  2. Login on Overleaf
  3. Use New project > Upload project and drop the ZIP you downloaded

Local

  1. Download the source code and set up your own LaTeX environment on your local host: git clone https://github.com/UNamurCSFaculty/ThesisTemplate.git
  2. Make sure the dependencies are installed, generally you need pdflatex, make and a TeX distribution (texlive-full contains all the dependencies needed for this project)
  3. Compile with make, this creates the file main.pdf and other temporary files
  4. Clean with make clean (this also removes main.pdf)

Once in the template source code, you can locate and follow the % TODO for replacing them with your content.

Using git submodules for including this template in your own thesis repository

If you are using Git for version control of your thesis, it might be useful to use Git submodules to include this template repository inside your own thesis repository. git submodules allow you to include the template repository inside your own thesis repository and keep it up to date when changes are made to the template. To add this template as a submodule to your own thesis repository, run the following command in the root of your thesis repository:

git submodule add https://github.com/UNamurCSFaculty/ThesisTemplate.git

This will create a new directory called ThesisTemplate in your thesis repository containing the template files.

copy the following files and folders from the ThesisTemplate submodule to your thesis repository root:

  • figures/
  • chapters/
  • main.tex

In your main.tex, apply the following changes to refers to the template files, now in submodule:

View changes to make

1. Document Class Path

  • Location: At the top of your main.tex file (first 2 lines).

  • Action: Find the two lines beginning with \documentclass. You need to add ThesisTemplate/ before style/umemoir in both lines.

    • Change: style/umemoir
    • To: ThesisTemplate/style/umemoir

2. Index Style Path

  • Location: In the "CONFIGURATION" section.

  • Action: Update the path for the index style sheet (.ist) inside the \makeindex command.

    • Before:
      \makeindex[columns=2, options= -s style/index.ist, intoc]
    • After:
      \makeindex[columns=2, options= -s ThesisTemplate/style/index.ist, intoc]

3. PUN Resource Path

  • Location: In the "PUN" section.

  • Action: Update the path for the \input command.

    • Before:
      \input{resources/presse_universitaire_namur}
    • After:
      \input{ThesisTemplate/resources/presse_universitaire_namur}

You can now update your main.tex file and write your thesis content in the chapters/ folder as usual.

When you want to update the template to the latest version, run the following commands in your thesis repository:

git submodule update --remote --merge ThesisTemplate

Frequently Asked Questions

  • Once I've finished my thesis, what should I do?

    • Once your thesis_v42_PromoterOK_JuryCheck_AliceBobCorrect_FinalVersion_GoFinal_Done_FINAL_THIS_TIME.pdf ready, you can contact Presses Universitaires de Namur (PUN) ([email protected]), ⚠️ 3-4 weeks in advance ⚠️, by e-mail and explain that you would like to publish your thesis. The entire procedure will then be explained to you in reply to this e-mail. The /documents folder already gives you an overview of the forms (Submission form (FR/EN), Cover details form (FR/EN)) that you may receive to fill out. ⚠️ These may be updated. The current version is for informational purposes only. Please only fill out the documents you receive from the PUN. The PUN works with Ciaco, located Louvain-la-Neuve, for the actual printing for a neat impression, in 16 x 24 cm format with welded binding (like a book). Further instructions are given in the Memento (FR).
    • At the same time, you will be asked to complete this form for the BUMP deposit. You can use this form for extracting the list of your publications for helping you in completing the "Article" section asking you to reference the list of your publications that are eventually in your thesis.
  • What do I need to pay attention to during final proofreading before printing?

    • During final proofreading, in addition to checking content and spelling, pay attention to layout and colors. Check that no content exceeds the defined margins or is misplaced. Also, check that black and white pages do not contain small colored symbols or stylistic elements. Don't forget that a color page costs around six times as much as a black-and-white page. Please note that it is important to check these elements before sending the PDF version to the printer for print proofing. Once the print proof has been launched, no modifications are permitted on the PDF (not even the correction of a spelling error, a symbol change, a color change, etc.). Any modification will require a new proof, which may take longer.
  • How to select only colored pages to optimize printing costs?

    • To optimize the printing price, it's a good idea to specify the pages to be printed only in black & white and the ones in color. In fact, printing all in color by default would be an unnecessary waste of money, as pages filled only with black text would be printed under the color tarif package. Since the budget for printing is limited, this would considerably reduce the number of copies that can be printed. As a reminder, the price of a color page is six times higher than the price of a black & white page. To facilitate this task of selecting color pages only and avoid manual counting (with the risk of making mistakes), a script has been coded to perform this page selection work automatically. All you have to do is submit the PDF and the script will return, in the correct format, the selection of colored pages (e.g. 1, 5, 12, 14-19, 25-26, 79, ...). The script is located at /utils/return_color_pages.py. Instructions for executing it are detailed there.
  • Do I have to create my own cover page?

    • No, the cover page follows a template managed by Presses Universitaires de Namur. The only elements you can define are the title, the abstract, a cover photo, a photo of yourself, etc. You will receive exact instructions after contacting them. Pay particular attention to the cover image if you want it to fit perfectly around the edges of the area provided. This area is not a perfect rectangle and looks like a page in an open book, as depicted in the UNamur logo. A wrong image, badly proportioned, badly calibrated, badly centered, badly laid out, etc. could lead to poor rendering, illegible, shifted, with undesirable margins, etc. Make sure you choose a suitable image and ask for a print preview to Presses Universitaires de Namur.

Contributing

Contributions are welcome (e.g., bug reports, bug fixes, refactoring, examples, documentation, interesting package imports, etc.).

If you want to contribute to the project, please consider the following instructions:

  • Any contribution must follow the conventions and keep the shape of previous contributions. For instance, any file, class, method, attribute must be named clearly (i.e., no abbreviations).
  • Any contribution must be documented, especially through comments in the source code and, if needed, by updating the README.md file.
  • Any contribution must be developed on a separate branch.
  • Any contribution must be approved, by a code owner (code owner lists), via the pull request mechanism.

License

You are free to:

  • Share — copy and redistribute the material in any medium or format
  • Adapt — remix, transform, and build upon the material
  • The licensor cannot revoke these freedoms as long as you follow the license
    terms.

Under the following terms:

  • Attribution — You must give appropriate credit, provide a link to the license,
    and indicate if changes were made. You may do so in any reasonable manner, but
    not in any way that suggests the licensor endorses you or your use.
  • NonCommercial — You may not use the material for commercial purposes.
  • ShareAlike — If you remix, transform, or build upon the material, you must
    distribute your contributions under the same license as the original.
  • No additional restrictions — You may not apply legal terms or technological
    measures that legally restrict others from doing anything the license permits.

More details: http://creativecommons.org/licenses/by-nc-sa/4.0/

Authors:

Contributors:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors