Code Monkey home page Code Monkey logo

htwsaar-i-mst-vorlage's Introduction

htwsaar-i-mst-vorlage Build LaTeX document

Eine LaTeX-Vorlage für Abschlussarbeiten im Bereich Informatik/Mechatronik-Sensortechnik an der htw saar.

Details zur Installation und Konfiguration sind in der Vorlage selbst enthalten.

Das Wiki enthält Best Practices und weitere Hinweise (ist aktuell noch im Aufbau).

Hinweis zum Ausdruck des Abgabeexemplars

Bitte drucken Sie das Dokument beidseitig (doppelseitig) aus, weil dies Papier spart und professioneller aussieht.

Hinweis zu Thesen in englischer Sprache

Falls Sie die Thesis auf Englisch schreiben, müssen Sie jedoch die folgenden Teile aus juristischen Gründen in deutscher Sprache (wie in der Vorlage) belassen:

  • Titelseite
  • Selbständigkeitserklärung
  • Sperrvermerk (falls verwendet)

Hinweis zu Absätzen und Zeilenumbrüchen

Gedankengänge bitte durch Absätze trennen, das ist im LaTeX-Quelltext eine Leerzeile. Leerzeilen nicht in Kombination mit \\ bzw. \newline verwenden. Idealerweise \\ bzw. \newline gar nicht verwenden. 😇

htwsaar-i-mst-vorlage's People

Contributors

amiede avatar

Stargazers

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

Watchers

 avatar  avatar  avatar

Forkers

9r2by bmo-at

htwsaar-i-mst-vorlage's Issues

Improve PDF build and add deployment feature

Hi team 👋

For my own purpose I updated the Github Action script so that it can deploy the builded PDF on the Github Pages service. The idea is that on each push to the main branch, the pdf is build and made accessible online with a simple URL. Here is the updated action:

name: Build and Deploy
on:
  push:
    branches:
      - main
permissions: 
  contents: write
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: 🛎️ Checkout
        uses: actions/checkout@v3

      - name: 🤖 Compile LaTeX document
        uses: xu-cheng/latex-action@v2
        with:
          root_file: my-file.tex
          post_compile: "mkdir build && mv my-file.pdf build"

      - name: 🚀 Deploy
        uses: JamesIves/[email protected]
        with:
          branch: gh-pages
          folder: build

You can have a look at the working example https://github.com/johannchopin/master-degree-thesis-paper.

If you like the idea I will submit a PR.

Define Latex repo template as a GitHub template

With GitHub you can specify a repo as being a template so you and others can generate new repositories with the same directory structure, branches, and files.

This may help students to understand that you can write your thesis as a git project which allows many features like:

  • version history
  • cloud based document thanks
  • multiple proposals creation thanks to branches

If you agree on that here are the steps to achieve the specification: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository

Fehlendes Leerzeichen bei Anführungszeichen

In der Selbstständigkeitserklärung erzeugt die Vorlage den Satz: "Darüber hinaus ist mir bekannt, dass die Unrichtigkeit dieser Erklärung eine Benotung
der Arbeit mit der Note „nicht ausreichend“zur Folge hat und einen Ausschluss von der
Erbringung weiterer Prüfungsleistungen zur Folge haben kann."

Nach dem schließenden Anführungszeichen fehlt also das Leerzeichen. Kann man wohl beheben, wenn man aus dem \grqq ein \grqq{} macht. In Abbildungen.tex Zeile 67 kommt es auch nochmal vor, aber die Datei sollte ja kein Teil der fertigen Arbeit sein. Wäre aber vielleicht eine geeignete Stelle, um auf den korrekten Umgang mit den Anführungszeichen hinzuweisen.

Inhalte auf Aktualität überprüfen

Die Vorlage ist inzwischen schon seit einigen Jahren im Einsatz, die Inhalte sind ggf. nicht mehr alle aktuell. Dies ist zu überprüfen und zu korrigieren.

Korrekte Kopfzeile bei mehrseitigem Table of Contents, List of Acronyms, etc.?

In Abbreviations.tex wurde \markboth{Abkürzungsverzeichnis}{} eingefügt, damit die Kopfzeile auch bei mehrseitiger List of Acronyms korrekt ist. Prüfen, ob dies Nebenwirkungen hat.

Prüfen, ob dies auch auf Contents.tex zu übertragen ist und ob das dort auch in unterschiedlichen Szenarien funktioniert.

Wo sonst noch?

Feature Request: Adding Diagrams

It should be possible to add diagrams.

I added diagrams in my thesis, the following way:

config: Add packages
\usepackage{pgfplotstable}
\usepackage{pgfplots}
\usepgfplotslibrary{dateplot}
tex:
\begin{figure}[ht!]
\caption{Anzahl relevanter Artikel im Zeitraum 1999/01/01 - 1999/03/31}
\label{dia:SPZ-90D}
\begin{tikzpicture}
\begin{axis}[
ybar, width = \linewidth,
% set column separator
table/col sep=tab,
xtick=data,
xticklabels from table={Datapoints/90D.tsv}{Lambda},
ylabel={Anzahl relevanter Artikel},
xlabel={Lambda-Wert},
ymax=30
]
\addplot table [
x expr=\coordindex,
y=SBERT,
] {Datapoints/90D.tsv};
\addlegendentry{NS-SBERT}
\addplot table [
x expr=\coordindex,
y=TF-IDF,
] {Datapoints/90D.tsv};
\addlegendentry{NS-TF-IDF}
\addplot table [
x expr=\coordindex,
y=SUMMARY,
] {Datapoints/90D.tsv};
\addlegendentry{NS-Summary}
\addplot table [
x expr=\coordindex,
y=WSBERT,
] {Datapoints/90D.tsv};
\addlegendentry{WIKI-SBERT}
\addplot table [
x expr=\coordindex,
y=WTF-IDF,
] {Datapoints/90D.tsv};
\addlegendentry{Wikipedia-TF-IDF}
\addplot table [
x expr=\coordindex,
y=WSUMMARY,
] {Datapoints/90D.tsv};
\addlegendentry{Wikipedia-Summary}
\end{axis}
\end{tikzpicture}
\end{figure}

Result:
Latex_Vorlage1

I also enabled a time based y axis. For this some small configurations needs to be added:
\def\removeleadingzeros#1{\if0#1 \expandafter\else#1\fi} % needed because, if number is e.g 08 you get an base-8 error

\def\transformtime#1:#2:#3!{
% \pgfkeys{/pgf/fpu=true,/pgf/fpu/output format=fixed}
\pgfmathparse{\removeleadingzeros#1*3600-\pgfkeysvalueof{/pgfplots/timeplot zero}3600+\removeleadingzeros#260+\removeleadingzeros#3}
% \pgfkeys{/pgf/fpu=false}
}

\pgfplotsset{
timeplot zero/.initial=0,
timeplot/.style={
y coord trafo/.code={\expandafter\transformtime##1!},
y coord inv trafo/.code={%
% \pgfkeys{/pgf/fpu=true,/pgf/fpu/output format=fixed,}
\pgfmathsetmacro\hours{floor(##1/3600)+\pgfkeysvalueof{/pgfplots/timeplot zero}}
\pgfmathsetmacro\minutes{floor((##1-(\hours - \pgfkeysvalueof{/pgfplots/timeplot zero})*3600)/60)}
\pgfmathsetmacro\seconds{##1-floor((##1)/60)*60}
\def\pgfmathresult{%
\pgfmathparse{ifthenelse( \hours<10,0,)}\pgfmathresult\pgfmathprintnumber{\hours}:%
\pgfmathparse{ifthenelse(\minutes<10,0,)}\pgfmathresult\pgfmathprintnumber{\minutes}:%
\pgfmathparse{ifthenelse(\seconds<10,0,)}\pgfmathresult\pgfmathprintnumber[fixed,fixed]{\seconds}%
}
% \pgfkeys{/pgf/fpu=false}
},
scaled y ticks=false,
yticklabel=\tick
}
}

Tex
\begin{figure}[ht!]
\caption{Selektionszeiten}
\label{dia:SEL-TIME}
\begin{tikzpicture}
\begin{axis}[
ybar, width = \linewidth,
nodes near coords align=below,
enlarge y limits={value=0.2,upper},
timeplot, timeplot zero=0, grid=major, grid style=dashed, % timeplot uses our configuration
table/col sep=tab,
xtick=data,
xticklabels from table={Datapoints/Validation_Master - Sel_Time.tsv}{Daterange},
x tick label style={align=left, rotate=45, font=\scriptsize, anchor=north east},
%title={Selektionszeiten},
ylabel={Selektionszeit},
ylabel style={at=(current axis.above origin), rotate=-90, anchor=south},
xlabel={Zeiträume},
xlabel style={at=(current axis.right of origin), anchor=west}
]
\addplot table [
x expr=\coordindex,
y={SBERT}
]{Datapoints/Validation_Master - Sel_Time.tsv};
\addlegendentry{SBERT}

\addplot table [
x expr=\coordindex,
y={TF-IDF}
]{Datapoints/Validation_Master - Sel_Time.tsv};
\addlegendentry{TF-IDF}
\addplot table [
x expr=\coordindex,
y={SUMMARY}
]{Datapoints/Validation_Master - Sel_Time.tsv};
\addlegendentry{SUMMARY}
\end{axis}
\end{tikzpicture}
\end{figure}

Result:
Latex_Vorlage2

If you need the tsv files.
contact me under: [email protected]

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.