From: greflm13 Date: Wed, 21 Mar 2018 15:45:36 +0000 (+0100) Subject: README extended X-Git-Url: https://git.htl-mechatronik.at/public/?a=commitdiff_plain;h=86aa9443dc2c0895ac046bdc71409e68409baaa9;p=diplomarbeit-mechatronik-vorlage-latex.git README extended --- diff --git a/README.md b/README.md index 0d826a3..eb9154c 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,34 @@ + Miktex Download: https://miktex.org/download + Texmaker Download: http://www.xm1math.net/texmaker/download.html ++ JabRef Download: https://www.fosshub.com/JabRef.html ### Ubuntu + Miktex Installation -``` + +```sh sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys D6BC243565B2087BC3F897C9277A7293F59E4889 echo "deb http://miktex.org/download/ubuntu xenial universe" | sudo tee /etc/apt/sources.list.d/miktex.list sudo apt update ``` -``` + +```sh sudo apt install miktex ``` Schritte auf dieser Website befolgen um Installation abzuschließen: https://miktex.org/howto/install-miktex-unx + Texmaker Installation: + +```sh +sudo apt install texmaker ``` -sudo apt install texmaker + ++ JabRef Installation + +```sh +curl -O https://www.fosshub.com/JabRef.html/JabRef-4.1.jar ``` ### Generell @@ -45,7 +55,9 @@ sudo apt install texmaker + __listings.tex__: Codestyles ### Zitierung + Setup: + + Im Texmaker: Optionen --> Texmaker konfigurieren --> Reiter: Befehle, bei Bib(la)tex: _biber %_ eingeben + Danach: Schnell Übersetzen - BibTeX - Schnell Übersetzen (2x) @@ -58,13 +70,109 @@ Bücher einfügen in der Datei _Literaturverzeichnis.bib_ (Buchtypen: https://en Abkürzungsverzeichnis in der _appendix.tex_. In der Zone acronym (\begin{acronym}...\begin{acronym}) werden die Abkürzungen definiert. -``` +```tex \begin{acronym} - %Abkürzung hinzufügen: \acro{Kürzel}{Ausgeschrieben} - \acro{WLAN}{Wireless Local Area Network} - \acro{WWW}{World Wide Web} - \acro{uC}[µC]{Mikrocontroller} + %Abkürzung hinzufügen: \acro{Kürzel}{Ausgeschrieben} + \acro{WLAN}{Wireless Local Area Network} + \acro{WWW}{World Wide Web} + \acro{uC}[µC]{Mikrocontroller} \end{acronym} ``` Abkürzungen im Text: `\ac{kürzel}` + +### Code Listings + +Code innerhalb \begin{lstlisting}..\end{lstlisting}. +Mögliche Optionen: + ++ __style:__ Vorher definierter Style (case sensitive) ++ __language:__ Sprache des Codes (case sensitive) ++ __caption:__ Name des Listings ++ __label:__ Label zum Verweisen + +Wenn style oder language angegeben ist, muss das andere nicht angegeben werden. Reihenfolge der Optionen ist egal. + +```tex +\begin{lstlisting}[style=java,caption=Java Codebeispiel,label=cCode] + ... +\end{lstlisting} +``` + +Styles werden definiert in _listings.tex_. Am besten man fragt [Onkel Google](https://google.com) oder liest in der [Dokumentation](http://users.ecs.soton.ac.uk/srg/softwaretools/document/start/listings.pdf) nach. In lstlisting sind folgende Sprachen bereits vordefiniert: + ++ C ++ C++ ++ HTML ++ Java ++ make ++ Matlab ++ Perl ++ PHP ++ Python ++ SQL ++ TeX ++ XML ++ und viele mehr (siehe [Dokumentation](http://users.ecs.soton.ac.uk/srg/softwaretools/document/start/listings.pdf)) + +Alle weiteren Sprachen müssen mit `\definelanguage{}` definiert werden. Dazu entweder die [Dokumentation](http://users.ecs.soton.ac.uk/srg/softwaretools/document/start/listings.pdf) lesen, oder [Onkel Google](https://google.com) fragen. + +### Aufzählungen + +Aufzählungen funktionieren unter LaTeX mit der Zone _itemize_ oder _enumerate_ + +```tex +\begin{itemize} + \item Standartmäßig ist ein schwarzer Punkt davor. + \item Die Länge ist nicht von Bedeutung, Zeilen werden automatisch umgebrochen. +\end{itemize} +``` + +```tex +\begin{enumerate} + \item Zählt automatisch. + \item Kann auch genestet werden. +\end{enumerate} +``` + +Weitere Informationen in der [Dokumentation](https://www.sharelatex.com/learn/Lists). + +### Bilder + +Es gibt zwei Arten, wie man Bilder einfügt. Entweder über die ganze Seite, oder mit Textumfluss. + +#### Ganze Seite + +```tex +\begin{figure}[H] + \includegraphics[width=1\textwidth]{Dateiname_Ohne_Endung} + \caption{Name des Bildes} + \label{Verweis} +\end{figure} +``` + +In den eckigen Klammern in der ersten Zeile kann man LaTeX mitteilen, wo man sein Bild plaziert haben möchte. H bedeutet _here_ platziert das Bild genau dort, wo es im Text steht. Weitere Informationen dazu in der [Dokumentation](https://www.sharelatex.com/learn/Positioning_of_Figures). + +#### Textumfluss + +```tex +\begin{wrapfigure}{r}{0.6\textwidth} +\vspace{10pt} + \begin{center} + \includegraphics[width=0.55\textwidth]{Dateiname_Ohne_Endung} + \end{center} + \caption{Name des Bildes} + \label{Verweis} + \vspace{-10pt} +\end{wrapfigure} +``` + +In der zweiten geschwungenen Klammer in der ersten Zeile gibt man ann, ob man das Bild links (l) oder rechts (r) platziert haben möchte. In der dritten geschwungenen Klammer gibt man die gewünschte Breite des Bildes an. Diese sollte gleich groß oder größer sein, wie die in Zeile 4. Mit dem `\vspace{}` Befehl kann man Abstände vor und nach dem Bild anpassen. + +### Verweise + +Ein Verweis in LaTeX erfolgt immer auf ein `\label{}`. Deswegen ist es wichtig, dass alle Überschriften, Bilder etc. Labels haben. Zum Verweisen kann man den Befehl `\ref{}` oder den Befehl `autoref{}` verwenden. Bei Ersterem wird nur die Nummerierung dargestellt, beim Anderen auch zusätzlich Abbildung oder Abschnitt. + +### Tabellen + +[Onlinegenerator](http://lmgtfy.com/?iie=1&q=Latex+Table+Generator) \ No newline at end of file diff --git a/__latexindent_temp.tex b/__latexindent_temp.tex new file mode 100644 index 0000000..aa237d7 --- /dev/null +++ b/__latexindent_temp.tex @@ -0,0 +1,76 @@ +\documentclass +[ +a4paper, %Papierformat +12pt, %Schriftgröße +twoside=true, %Zweiseitig +openright, %Neues Kapitel immer auf der rechten Seite +titlepage, %Titelseite +headinclude, %Seitengröße auch bei Kopfzeile +numbers=noenddot, %Bei Kapiteln keine abschließenden Punkte +listof=numbered, %Listingsverzeichnis +bibliography=totocnumbered, %Literaturverzeichnis +] +{scrbook} %Dokumenttyp + +\usepackage[bottom=1in,inner=1in,outer=20mm,top=20mm]{geometry} %Ganze Seite verwenden + +% Kopf und Fußzeile +\usepackage{emptypage} %Leere Seiten ohne Kopf und Fußzeile +\usepackage[headsepline]{scrlayer-scrpage} %Kopf und Fußzeile +\pagestyle{scrheadings} %Nummerierung in der Kopfzeile +\clearscrheadfoot %Kopf und Fußzeile löschen +\rehead{\headmark} %Kapitelname auf der geraden Seite innen +\ohead[\pagemark]{\pagemark} %Seitennummerierung +\lohead{} %Name auf der ungeraden Seite innen +\renewcommand*{\chapterpagestyle}{scrheadings} %Kopf und Fußzeile auf Seiten mit Überschriften anders + +%Dokumenteinstellungen und Paketimporte +\usepackage[T1]{fontenc} %Outputencoding +\usepackage{lmodern} +\usepackage[utf8]{inputenc} %UTF8 + Sonderzeichen +\usepackage[ngerman]{babel} %Deutsch +\usepackage{newtxtext,newtxmath} %font new TX (standard text) +\renewcommand{\headfont}{\rmfamily} %use new tx for headers +\setkomafont{sectioning}{\rmfamily\bfseries} %use new tx for chapters, sections, etc +\usepackage{caption} %Tabellen Listings und Figuren mit Beschriftung in Verzeichnissen +\usepackage{graphicx} %Bilder +\usepackage{float} %Plazierung von Floats (Bilder Tabellen) +\usepackage{wrapfig} %Textumfluss von Bildern, die nicht die ganze Seite brauchen +\usepackage{setspace} %Zeilenabstand +\usepackage{listings} %Listings (=Code) +\usepackage{courier} %Courier (listings) +\usepackage{times} %Schriftart Times Roman +\usepackage{courier} %Schriftart Courier +\usepackage{array,multirow} %Bessere Tabellenformatierung +\usepackage{xcolor} %Farben für Codehighlighting oder ähnliches +\usepackage{tabularx} %Bessere Tabellen +\usepackage{appendix} %Anhang Titelseite +\usepackage[printonlyused,withpage]{acronym} %Für die Verwendung von Akronymen + Verzeichnis - printonlyused: Abkürzung nur im Verzeichnis wenn auch benutzt; withpage: Seite der 1. Verwendung im Verzeichnis anzeigen + +\setlength{\parindent}{0em} %Einrücken +\setcounter{tocdepth}{5} %Tiefe der Überschriften +\setcounter{secnumdepth}{5} %Nummerierungstiefe der Überschriften + +\input{listings} %Datei importieren +\input{biber} + +\usepackage[bookmarks]{hyperref} %Automatische Lesezeichen +\usepackage[figure]{hypcap} %Bild referenzieren + +\subject{\includegraphics[scale=0.7]{fig/logoMecha}} +\title{Diplomarbeitvorlage} +\subtitle{HTBLA Kaindorf an der Sulm\\ +Grazer Straße 202, A-8430 Kaindorf an der Sulm\\ +Ausbildungsschwerpunkt Mechatronik und Automatisierungstechnik} +\author{Florian Greistorfer \and Marian Korošec} +\date{Abgabedatum: 7.3.2018} +\publishers{Betreut von:\\Dipl.-Ing. Manfred Steiner} +\begin{document} %Dokumentbeginn +\onehalfspace %Zeilenabstand +\maketitle %Titelseite +\input{opening} %Datei importieren +\tableofcontents %Inhaltsverzeichnis +\mainmatter %Seitennummerierung +\include{inhalt} %Datei importieren +\include{appendix} %Datei importieren +\end{document} \ No newline at end of file diff --git a/inhalt.tex b/inhalt.tex index 4ed09d8..07bbab2 100644 --- a/inhalt.tex +++ b/inhalt.tex @@ -33,7 +33,7 @@ Hier muss Text stehen, sonst wird von unten alles verschoben. Sollte nicht genug \paragraph{Code}\mbox{}\\ Hier muss Text stehen, sonst wird der Paragraph nicht angezeigt.\footnote{Fußnote mit URL.\\ \url{https://www.htl-mechatronik.at/}, (letzter Zugriff am 7.3.2018)} -\begin{lstlisting}[style=java,caption=Java Codebeispiel] +\begin{lstlisting}[style=java,caption=Java Codebeispiel,label=javaCode] package ue04; import ue04.Bauteil; @@ -111,7 +111,7 @@ Akronyme können mit dem \textbackslash{}ac\{\} Kommando angezeigt werden. Bei d \section{C Beispiel} \label{sec:c-beispiel} -\begin{lstlisting}[style=C,caption=C Codebeispiel] +\begin{lstlisting}[style=C,caption=C Codebeispiel,label=cCode] #include int main() diff --git a/main.pdf b/main.pdf index 0c034c1..eec5192 100644 Binary files a/main.pdf and b/main.pdf differ diff --git a/main.tex b/main.tex index aa237d7..041fa3b 100644 --- a/main.tex +++ b/main.tex @@ -29,9 +29,9 @@ bibliography=totocnumbered, %Literaturverzeichnis \usepackage{lmodern} \usepackage[utf8]{inputenc} %UTF8 + Sonderzeichen \usepackage[ngerman]{babel} %Deutsch -\usepackage{newtxtext,newtxmath} %font new TX (standard text) -\renewcommand{\headfont}{\rmfamily} %use new tx for headers -\setkomafont{sectioning}{\rmfamily\bfseries} %use new tx for chapters, sections, etc +\usepackage{newtxtext,newtxmath} %font new TX (standard text) +\renewcommand{\headfont}{\rmfamily} %use new tx for headers +\setkomafont{sectioning}{\rmfamily\bfseries} %use new tx for chapters, sections, etc \usepackage{caption} %Tabellen Listings und Figuren mit Beschriftung in Verzeichnissen \usepackage{graphicx} %Bilder \usepackage{float} %Plazierung von Floats (Bilder Tabellen) @@ -41,7 +41,7 @@ bibliography=totocnumbered, %Literaturverzeichnis \usepackage{courier} %Courier (listings) \usepackage{times} %Schriftart Times Roman \usepackage{courier} %Schriftart Courier -\usepackage{array,multirow} %Bessere Tabellenformatierung +\usepackage{array,multirow} %Bessere Tabellenformatierung \usepackage{xcolor} %Farben für Codehighlighting oder ähnliches \usepackage{tabularx} %Bessere Tabellen \usepackage{appendix} %Anhang Titelseite