Code Monkey home page Code Monkey logo

hagenbergthesis's Introduction

Hagenberg Thesis Document Collection (LaTeX)

What You Find Here

This is a collection of modern LaTeX classes, style files, and example documents for authoring Bachelor, Master, or Diploma theses and related academic manuscripts in English and German. Pre-configured English and German documents are available, easy to use even for LaTeX beginners, and compatible with LaTeX distributions for Windows, Mac OS, and Linux. The document classes are immediately usable and convenient to customize.

The main document, HgbThesisTutorialEN or HgbThesisTutorialDE, serves both as a template and tutorial for authoring a bachelor, master, or diploma thesis with LaTeX. Developed initially as an internal standard at the Upper Austria University of Applied Sciences in Hagenberg, this setup has become popular at several other (mostly German-speaking) institutions over the last few years.

This site is the main repository for the hagenberg-thesis package, which is also available on CTAN and shared by popular package repositories such as MikTeX and TexLive. Note that the most recent versions are always found here, while only periodic releases are submitted to CTAN.

How to Use

Checkout (Local LaTeX Installation)

To open a sample document on your computer, use the appropriate download (ZIP) link in the table below. Unzip the downloaded archive to a suitable location and open the main.tex file in your TeX editor. Make sure you have a current LaTeX environment installed.

Online Usage (Single-click Authoring)

The sample documents can also be edited in a web browser without installing LaTeX on your computer. Use the create links in the table below to open the document on Overleaf.

Sample Documents

Each sample document is based on a custom LaTeX document class (e.g., hgbthesis.cls) and various style files (hgb.sty, ...). The style files can also be used independently for other kinds of documents. The following sample documents (with numerical citations using numeric-comp) are currently available:

Name Document Type Language PDF ZIP Overleaf*
HgbThesisTutorialEN Thesis Template and Tutorial English preview download create
HgbThesisTutorialDE Thesis Template and Tutorial German preview download create
HgbThesisEN Minimal Thesis Template English preview download create
HgbThesisDE Minimal Thesis Template German preview download create
HgbInternshipReport Internship Report German preview download create
HgbLabReportEN Lab Report (weekly assignments) English preview download create
HgbLabReportDE Lab Report (weekly assignments) German preview download create
HgbTermReport Term/Project Report (full semester) English preview download create
HgbArticle Journal Article English preview download create
HgbThesisEN-proposal Thesis Proposal (Exposé) English preview download create
HgbThesisDE-proposal Thesis Proposal (Exposé) German preview download create

APA Style Documents

To use the APA 7th edition style for citations and references, the option apa can be used in the document's preamble. Two separate sample documents are already prepared for the use of the APA style:

Name Document Type Language PDF ZIP Overleaf*
HgbThesisEN-APA Minimal Thesis Template (APA-style) English preview download create
HgbThesisDE-APA Minimal Thesis Template (APA-style) German preview download create

*Note: A (free) account is required to open documents on Overleaf.

PDF/A Generation and Validation

All documents in this collection are set up to optionally create PDF/A-compliant output files (PDF/A-2b, to be exact). Note that while the original documents are indeed PDF/A-compliant, any derived document may not be so. It is, therefore, important to validate the resulting PDF file before submission using one of the options listed below. Most violations of the PDF/A standard arise from the inclusion of other PDF files, particularly graphics. Typical issues are related to using non-embedded fonts and incorrect or unwanted color spaces. This setup assumes sRGB colors, which should also be used when creating your own illustrations. Here are some PDF/A validation software and services:

Additional Features

The hagenberg-thesis classes and styles try to provide as much functionality out-of-the-box as possible while still being easy to use. Additional functionality that did not permanently find its way into the files is documented in the wiki for this repository.

Further Information

hagenbergthesis's People

Contributors

d4muck avatar fabiandev avatar hochleitner avatar imagingbook avatar koppor avatar mikewzr avatar tassadarius avatar vtjnash 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  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  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

hagenbergthesis's Issues

Fix 'algorithmicx' indentation problems

The current (2005!) version of the algorithmicx package has several flaws regarding the indentation of lines. I suggest to pack all fixes into a new style file (e.g., hgbalgo.sty).

Introduce @standard entry type

Add @standard to the biblatex entry types examples in literatur.bib and show an example. Probably using a web standard (W3C Recommendation) might be a good idea, since those are required quite often by students.

Clean up package references in thesis tutorial

In HgbThesisTutorial, check for "hagenberg-Paket" and other references, consistently replace with "hagenberg-thesis". Also check if certain third-party packages need to be mentioned at all.

Set up a Git-Remote on Overleaf

To publish the thesis template on Overleaf, the intended approach is (see https://www.overleaf.com/help/230-how-do-i-push-a-new-project-to-overleaf-via-git#.WMqDlE13HCM):

  1. create a new Latex project on Overleaf,
  2. find out its Git URL (in "share"),
  3. add this URL as an additional 'remote' in your local Git repo,
  4. merge and
  5. push to the overleaf remote.

Two limitations came up: (a) I could not merge the two repos properly, (b) there is a (undocumented) limitation of max. 60 files for free Overleaf accounts (too few for the complete template).

Change title font for article, lab report and term report

Those documents still show serif headings. We should probably change those to match the style of hgbthesis completely.

The TOC for the term report also needs to be adapted, right now the sans serif fonts for chapters only apply to hgbthesis documents.

Hinweis auf häufige Fehler im Quellenverzeichnis

  • Vorsicht beim Download von BibTeX-Daten -- die sind meistens fehlerhaft. Nicht blind übernehmen!!
  • Groß-Kleinschreibung in Titeln, Konferenznamen etc., Anordung von Konferenznamen.
  • Journal-Namen grundsätzlich ausschreiben.
  • Auf Konsistenz bei Ortsangaben, Verlagen etc. achten!

Chapter/Section Font cannot be changed

I have a problem, that I cannot change the font of the chapters/sections, even if I change all "\sffamily" parts of the .cls and .sty files to "\rmfamily" (I want to use Roman instead of Sans Serif). The text has changed into Roman, as I wanted to, but the chapters/section dont change!

Add predefined (named) colors

Load the xcolor package with a set predefined set of named colors (e.g., svgnames) or define a separate (non-conflicting) set of colors?

list of listings is not working.

When i use the program enviroment like:

\begin{program}[ht]
\begin{CppCode}[firstnumber=668]
#if defined(__arm__)
#elif defined(__x86_64__)
#endif
\end{CppCode}
\caption{foo bar batz}
\label{prog:mylabel}
\end{program}

i would like to have list of these listings, just like a list figures. Unfortunately using \lstlistoflistings just creates an empty page. How can i work around that?
Thanks!

Remove advisorpage - hyperref problem?

Hi,

thanks for sharing this great template. I've used it for a lot of my courses and now for my thesis which is almost done. I've set some modifications and tried to bundle issues with the template. Fortunately there's nothing to bundle because I've only one issue : how can I completely remove the advisorpage without mixing up the page numbering?

Thanks,

Chris

Rename praktikum.tex

Rename 'praktikum.tex' to 'internship.tex'? Or leave as is, because used in German only?

Include 'subfigure' package with proper options + example

subfigure is currently not included but authors often use it, unfortunately in a rather indifferent manner. The package has some awkward default settings that should be corrected for by the import statement. The example should demonstrate simple but proper usage.

Clear out hgb.sty

hgb.sty, hgbbib.sty, hgbheadings.sty, hgblistings.sty and hgbabbrev.sty contain many old settings that have been commented out during earlier versions and most likely have been kept for fallback reasons. Removing these lines would make the files smaller. Old settings would still be available in version control anyway.

JavaScript Listings definition outdated

The definition of JavaScript language specifics in hgblistings.sty is outdated (no ECMASCript 5 and 6 definitions, no Node.js keywords, etc.) and seems a bit wrong anyway. There are keywords that do not belong to JavaScript as far as I know.

To update the definition I suggest using the one declared in https://github.com/xgirma/latex-javaScript (it's in main.tex) as a starting point. It's a current definition and well thought-out.

Overleaf auto-import link

You can use links like:

https://www.overleaf.com/docs?snip_uri=https://github.com/user/project/archive/master.zip

to automatically import zip files into Overleaf. I suggest changing the links in the README.


/cc @hochleitner

Option twoside

Hallo,

kurze Frage: Wenn ich meine Arbeit binden lassen möchte, empfiehlt sich gleich das ganze beidseitig zu bedrucken. Ist in dem Paket der beidseitige Druck (twoside) vorgesehen, damit jeweils der linke und rechte Rand abwechselnd einen größeren Abstand zur Bindung bekommen?

Ich habe bereits gesehen, dass das Paket auf der Klasse "book" aufsetzt, allerdings passen beim setzen der twoside Option z. B. die Seitenüberschriften nicht mehr. Gibt's da eine Lösung?

[FR] Glossaries

I added a glossary to my thesis, maybe it would fit into here too, I can think of others may also integrate one.

*thesis.tex:

\RequirePackage[utf8]{inputenc}
\usepackage{hyperref}
\usepackage{color}
+\usepackage[acronym,xindy,nopostdot]{glossaries}

\graphicspath{{images/}}    % Abbildungsverzeichnis
\logofile{logo}				% Name des Logo-PDFs in images/ (\logofile{}, wenn kein Logo gewuenscht)
\bibliography{literatur}  	% Name der Biblatex-Literaturdatei (.bib)

+\clearpage\renewcommand{\glossaryname}{Glossar}
+\makeglossaries
+\loadglsentries{back/98-glossary}
....
....
%%%----------------------------------------------------------
\MakeBibliography                        % Quellenverzeichnis
+\printglossary[type=\acronymtype,title={Abk\"urzungen}]
%%%----------------------------------------------------------

back/98-glossary.tex:

\usepackage[acronym,xindy,nopostdot]{glossaries}
%%
%% Aus Kapitel Versionsverwaltung
%%
\newacronym{VCS}{VCS}{Version Control System}
\newacronym{SVN}{SVN}{Subversion}
\newacronym{SCM}{SCM}{Software configuration management}

%%
%% Aus Kapitel Open Source
%%
\newacronym{OSS}{OSS}{Open Source Software}

See https://en.wikibooks.org/wiki/LaTeX/Glossary.

BibLaTeX IEEE for Bibliography

I also gave the IEEE BibLaTeX style a go in bibliography-ieee. There's two versions though that can be set in hgbbib.sty:

  1. style=ieee sets the numeric IEEE-style. This keeps the [1]-type references but does no alphabetic ordering. References are set in the bibiography in the order of appearance.
  2. style=ieee-alphabetic sets the alphabetic versions. Refereces are the first 3 to 4 author name letters and the year, e.g. [Art07] for Artner, 2007 or [BB15] for Burger, Burge, 2015. Bibliography is then sorted alphabetically.

Compared to the issues mentioned in #31 we don't have to change any cite commends. If we want to use the alphabetic version we need to add information to some bib entries that lack for example author or year (e.g. the legislation entries). I added the year where necessary and used the label={} field to generate a label without explicitly adding an author.

Again - have a look - comments apprectiated!

Setup instructions need cleanup

Instructions for using the template under various TeX/Editor/Viewer environments are partially outdated and/or inconsistent. E.g., TexNicCenter profile file _tc_output_profile_sumatra_utf8.tco is mentioned in various places in the text but missing. I suggest to place this (and possibly others) in a new directory _setup/, e.g.,

_setup/
    win/
        texniccenter/
            output_profile_sumatra_utf8.tco
...

In addition, other (better) environments should be mentioned.
Remove all references to the old DVI/PS workflow?

Bachelor thesis: make descriptive fields more flexible

From: Teringl Nico - S1510306038
Sent: Donnerstag, 14. Dezember 2017 16:39
To: Burger Wilhelm
Subject: Bachelor Vorlage LaTeX

Sehr geehrter Herr Burger,

da uns Herr Bogner mitgeteilt hat, dass im Zuge einer Studienplanänderung die Angabe des Kurses - in dem wir unsere Bakk-Arbeit schreiben (Seminar zur Bachelorarbeit) - nicht mehr notwendig ist, wollte ich Sie fragen, wie ich das aus dem LaTeX Dokument entfernen kann?
Ich habe vergeblich versucht, die Zeile „\coursetitle{Seminar zur Bachelorarbeit}“ auszukommentieren, denn dann schreibt er dass er den Kurstitel nicht mehr findet!

Danke im Voraus,
Nico Teringl

Consider using Madoko

I found madoko:

You can:

  • output static HTML
  • output PDF
  • output tex files for publishing

You can:

  • make writing easier for new users
  • re-use most LaTeX code

Links to files in FileList environment not working correctly

One would expect that when clicking on e.g. "vorwort.tex" in

\begin{FileList}{/thesis_DE/front}
\fitem{vorwort.tex} Vorwort %
\fitem{kurzfassung.tex} Kurzfassung %
\fitem{abstract.tex} Abstract %
\end{FileList}

would link to the file /thesis_DE/front/vorwort.tex, but instead it links to /vorwort.tex.
Maybe this is intended, I don't know, but I thought it is worth mentioning here.

I tested this with the current PDF version of this repository.

PS: This code excerpt is from the file thesis_DE/back/anhang_b.tex

Biber numbers all references with "0"

When running biber/pdflatex, all the references are numbered with "0".
The links work correctly. Also the backlinks.

I am using Miktex 2.9 (with the latest updates as of today)

Changing in hgbbib.sty the option defernumbers=true to false fixed the problem:
\ExecuteBibliographyOptions{bibwarn=true,sortcites=true,defernumbers=false,isbn=false,doi=false,backref=true}

Why is this not the default? Or what options should one use in order to make the generation of references work with the original options?

Unwanted page breaks in ToC + cleanup required

The current ToC setup permits unwanted page breaks, e.g., between a parent entry and its first child entry. Suggestion: adopt the tocstyle package. Check if the (currently used) tocloft package can be removed completely.
Cleanup: hgbheadings.sty contains individual setups for various "hgb*" classes, introducing unnecessary dependencies. If necessary at all (after the suggested change) move these setups to the .class files?

Add a beamer-based slide example

Would be helpful to have a minimal example setup for beamer based slides using the hagenberg-thesis style files. At the moment there is a package clash with hyperref.

Smart quotes desirable

We see frequent mistakes related to wrong quotes, in particular the false use of straight double quotes instead of the proper (language-dependent) quote sequences. Consider the csquotes package as a possible remedy. Special measures may be needed to avoid clashes with other uses of double quotes in German.

Solution for digital content

Since burning CDs and DVDs has become quite exotic and putting SD cards or ultra-thin USB drives into a thesis is probably also not a long term solution it might be a good idea to store digital content (source code, reference material, PDF version of the thesis) online and add a link to this storage in the thesis.

While we aim to figure out the "how" and "where" on storing such files, I have proposed a simple addendum to the title pages that adds an additional field in the preamble which holds the URL to the content and uses this URL to generate a QR code as well as a link.
See branch qrcode-page to give it a try and feel free to modify this approach or suggest something completely different.

Any suggestions on where and how to store these digital files are of course welcome as well (maybe @diephuis has input on this as well).

BibLaTeX APA for Bibliography

I added the bibliography-apa branch to try APA style references. I like the look and feel though it has some consequences.

Biggest change is that authors need to be aware of different citation methods.

  • \parencite for references in parentheses, e.g. (Burger & Burge, 2015)
  • \textcite when using a reference in the text, e.g. "as mentioned by Burger & Burge (2015)..."
  • \cite when a reference is already within parentheses (to avoid double brackets), e.g. "Styles are fun (see Kopka & Daly, 2003 for more information)".

Another consequence is that every bibliography item needs an author or title and a year field. This can be difficult for URLs at times.

Other than that, APA reverts URLs back to serif, so I had to move the \urlstyle{sf} command after the biblatex include.

Have a look - comments appreciated!

Consider the "subfigure" package

For some reason, users seem to love the subfigure package (which we currently do not promote since it is not essential) but often use it in a non-reflected way. It might be helpful to (a) import the package with proper options and (b) add a small usage example to the template.

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.