项目作者: trivvz

项目描述 :
PG LaTeX thesis template
高级语言: TeX
项目地址: git://github.com/trivvz/pg-latex.git
创建时间: 2020-11-19T21:49:50Z
项目社区:https://github.com/trivvz/pg-latex

开源协议:The Unlicense

下载


PG LaTeX thesis template

The intention of this repo is to provide a working LaTeX template for
writing bachelor and master theses for students of Politechnika Gdańska
(Gdańsk University of Technology). The template was prepared to be
compliant with editorial guidelines from the year 2018 which are
available on the university
website

(document contains guidelines in Polish and English). Some inspiration
was taken also from the guidelines from the year
2014

which are more detailed than the latest version. The template is also
very likely to be compliant with the newest guidelines from 2022
but this wasn’t throughly verified.

Supported languages

The only supported language is Polish, however it shouldn’t be very hard
to adjust the template for writing in English. Polish requires
additional options, so some of the changes is just removing
Polish-specific settings.

Then why is this readme in English?

Mostly out of habit, as I’ve never experienced any
addBag/dodajWorek:tm: issues during my studies, so I always tend to
write code and documentation in English even if Polish here makes more
sense.

Setup

Clone the repo, and make sure that main.tex compiles into a PDF on
your system. The template was successfully tested against TeXLive 2022.

Overleaf

If you prefer working in Overleaf, here you can access the files for
this template: https://www.overleaf.com/read/mngqxzfvdhpk.

How to use?

This repo should be treated as a sample project, so you’re supposed to copy
the files and edit them freely. The most of the actual settings live in
config/preamble.sty. To be compliant with PG, you probably don’t want
to modify existing settings there unless you’re fixing something (pull
request is welcomed in this case).

Depending on your needs, you might want to include more packages and
settings in this file to get access to some more niche LaTeX features
provided by packages not included in the template by default.

Structure and conventions

The below diagram describes all important parts of the template. You
should also take a look at the notes in the example chapter which
describes how to add figures, tables, and citations along with some good
practices. It’s a good idea to analyze both the raw TeX, and the
generated PDF (you can get the PDF easily from the Overleaf linked
above).

  1. main.tex
  2. \_ Entry point of the template, start here to understand how the rest
  3. of the files is referenced
  4. config
  5. \_ preamble.sty # The heart of the template with most settings
  6. \_ bibliography.bib # Put your bibliography positions here
  7. \_ macros.sty # Define your macros here
  8. chapters # A TeX file per chapter
  9. \_ 01.tex
  10. \_ 02.tex
  11. figures
  12. \_ Graphics, images etc.
  13. misc
  14. \_ TeX files which are not chapters but are part of the thesis
  15. pdf
  16. \_ Here you should put PDFs which will be included as separate pages
  17. into your thesis
  18. tables
  19. \_ Big and complex tables can be defined here and with `\input{}`
  20. included in chapters

Misc

In some places, you can notice a bit strange formatting with LaTeX
comments % at the end of lines. This was done to prevent automatic
wrapping of lines by stkb/Rewrap VS
Code extension.

See also

  • jachoo/pg-beamer\
    A PG template for creating LaTeX presentations

  • splaw1k/PG_LaTeX_Templates\
    Another PG thesis template available on GitHub

  • typografia.info\
    Writing a thesis is not writing a book, but some typographic knowledge
    is nice to have if you decided to be a LaTeX guy (some people really
    prefer Word)

  • James-Yu/LaTeX-Workshop\
    If you’re new to LaTeX and already familiar with VS Code, you can try
    this extension before installing full-fledged LaTeX “IDE”

Contributing

All fixes, proposed updates, or comments are welcome!