diff --git a/README.md b/README.md index 86f919a..4088558 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Write beautiful latex cheat sheets with minimal effort. ## How to use put `latex4ei` folder in `./template-files/` into the same folder as -your latex file. Specify \documentclass{latex4ei/latex4ei_sheet} and compile your code. +your latex file. Specify `\documentclass{latex4ei/latex4ei_sheet}` and compile your code. See the documentation for further details. ## Permanent installation @@ -28,7 +28,7 @@ sudo mktexlsr ln -s ./pkg /usr/local/texlive/texmf-local/tex/latex/latex4ei ``` -If you want to share your documents please refer to the license.txt -Read the changelog.txt and known_bugs.txt and check [www.latex4ei.de](http://latex4ei.de) for updates. +If you want to share your documents please refer to the LICENSE file +Read the changelog.md and known_bugs.txt and check [www.latex4ei.de](http://latex4ei.de) for updates. © 2011-2016, LaTeX4EI diff --git a/changelog.md b/changelog.md index fb823ab..4f351c6 100644 --- a/changelog.md +++ b/changelog.md @@ -1,9 +1,15 @@ -# LaTeX4EI Template +# LaTeX4EI Template Date: 2016-01-06 ## Changelog -#### Release 1.0 +### Release 1.1 + +* Added thesis class +* Added general transformation command +* Small Bugfixes + +### Release 1.0 * new box macros the boxes are now implemented as environments, which allows better error tracking. diff --git a/template-files/cheatsheet_template.tex b/template-files/cheatsheet_template.tex index c073a12..df20510 100644 --- a/template-files/cheatsheet_template.tex +++ b/template-files/cheatsheet_template.tex @@ -1,10 +1,10 @@ -% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % -% LaTeX4EI Template for Cheat Sheets Version 1.0 -% +% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % +% LaTeX4EI Template for Cheat Sheets Version 1.1 +% % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Encode: UTF-8, tabwidth = 4, newline = LF -% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % +% Encode: UTF-8, tabwidth = 4, newline = LF +% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % ====================================================================== @@ -40,19 +40,19 @@ \section{Math} \begin{sectionbox} \subsection{Sinus} - + Text goes here ... - - + + \end{sectionbox} \begin{sectionbox} \subsection{Cosinus} - + Text goes here ... - - + + \end{sectionbox} diff --git a/template-files/latex4ei/latex4ei.sty b/template-files/latex4ei/latex4ei.sty index 2b24dec..4183a07 100644 --- a/template-files/latex4ei/latex4ei.sty +++ b/template-files/latex4ei/latex4ei.sty @@ -3,10 +3,10 @@ % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD % -% © 2011-2015, LaTeX4EI +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{latex4ei/latex4ei}[2013/05/06 Macros for LaTeX4EI] @@ -44,7 +44,7 @@ %\RequirePackage{xltxtra} - + % for unicode decalarations %\let\DeclareUnicodeCharacter\newunicodechar \setmainfont{Times New Roman} % Libertinus Serif @@ -53,7 +53,7 @@ % some hacking for scientific.sty \AtBeginDocument{ - + % scale fonts to same x height \defaultfontfeatures{Scale=MatchLowercase,Mapping=tex-text} @@ -251,14 +251,14 @@ \makeatletter \providecommand{\todo}[1]{% \textcolor{red}{\bfseries ToDo:\@ifundefined{@captype}{\marginpar{\color{red}\bfseries ToDo!}}{\relax} #1} %check for float environments - } + } \makeatother % Special term \providecommand{\term}[1]{\textit{#1}} % small note - \providecommand{\note}[1]{\textit{Note: #1}} + \providecommand{\note}[1]{\textit{Note: #1}} % Related work \providecommand{\work}[1]{\textit{#1}} @@ -268,7 +268,7 @@ % References and Links % ---------------------------------------------------------------------- - + \providecommand{\sectionname}{Section} % several ref macros diff --git a/template-files/latex4ei/latex4ei_boxes.sty b/template-files/latex4ei/latex4ei_boxes.sty index 19f08da..17d093d 100644 --- a/template-files/latex4ei/latex4ei_boxes.sty +++ b/template-files/latex4ei/latex4ei_boxes.sty @@ -3,10 +3,10 @@ % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD % -% © 2011-2015, LaTeX4EI +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{latex4ei_boxes}[2015/02/06 Boxes for LaTeX4EI] diff --git a/template-files/latex4ei/latex4ei_colors.sty b/template-files/latex4ei/latex4ei_colors.sty index fe5b1fb..4cd26f4 100644 --- a/template-files/latex4ei/latex4ei_colors.sty +++ b/template-files/latex4ei/latex4ei_colors.sty @@ -3,10 +3,10 @@ % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD -% -% © 2011-2015, LaTeX4EI +% +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{latex4ei/latex4ei_colors}[2016/03/30 Colors for LaTeX4EI] @@ -29,7 +29,7 @@ % TUM Color Palette % ---------------------------------------------------------------------- - % Note: The following color definitions are copied + % Note: The following color definitions are copied % from the official TUM Styleguide % the tum logo color @@ -57,8 +57,8 @@ \definecolor{tum_purple}{RGB}{105, 8, 90} % 55%: 173, 119, 164 \definecolor{tum_purple_dark}{RGB}{15, 27, 95} % 55%: 123, 130, 167 - \definecolor{tum_blue_ocean}{RGB}{0, 119, 138} % 55%: 115, 180, 191 - \definecolor{tum_green_leaf}{RGB}{0, 124, 48} % 55%: 115, 183, 141 + \definecolor{tum_blue_ocean}{RGB}{0, 119, 138} % 55%: 115, 180, 191 + \definecolor{tum_green_leaf}{RGB}{0, 124, 48} % 55%: 115, 183, 141 \definecolor{tum_green_grass}{RGB}{103, 154, 029} % 55%: 172, 200, 131 \definecolor{tum_yellow}{RGB}{255, 220, 0} % 55%: 255, 236, 115 diff --git a/template-files/latex4ei/latex4ei_report.cls b/template-files/latex4ei/latex4ei_report.cls index 3e2235b..228d416 100644 --- a/template-files/latex4ei/latex4ei_report.cls +++ b/template-files/latex4ei/latex4ei_report.cls @@ -1,12 +1,12 @@ % -% Report class from LaTeX4EI +% Report class from LaTeX4EI % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD -% -% © 2011-2015, LaTeX4EI +% +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e}[1996/12/01] \ProvidesClass{latex4ei_report}[2015/03/15] @@ -26,7 +26,7 @@ % set default options for base class \PassOptionsToClass{a4paper, 11pt}{\baseclass} - % pass unknown options to base class + % pass unknown options to base class \DeclareOption*{% \PassOptionsToClass{\CurrentOption}{\baseclass}% } @@ -51,7 +51,7 @@ \RequirePackage{abstract} - + % ====================================================================== @@ -76,10 +76,10 @@ %\renewcommand{\sfdefault}{cmss} % cmss, phv pag - \shorthandoff{"} % don't convert "A to Ä! + \shorthandoff{"} % don't convert "A to Ä! - % calculate linespacing based on font size + % calculate linespacing based on font size % char per line: 85 \RequirePackage{setspace} \linespread{1.3}\selectfont @@ -213,7 +213,7 @@ \makeatletter \renewcommand\p@subfigure{\thefigure} - \renewcommand{\thefigure}{\@arabic\c@figure} + \renewcommand{\thefigure}{\@arabic\c@figure} \renewcommand{\thesubfigure}{\alph{subfigure})} \makeatother diff --git a/template-files/latex4ei/latex4ei_sheet.cls b/template-files/latex4ei/latex4ei_sheet.cls index 7b42782..7aa90e9 100644 --- a/template-files/latex4ei/latex4ei_sheet.cls +++ b/template-files/latex4ei/latex4ei_sheet.cls @@ -3,10 +3,10 @@ % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: CC-BY-NC-SA % -% © 2011-2015, LaTeX4EI +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e} \ProvidesClass{latex4ei_sheet}[2014/03/30 Cheet Sheet Template from LaTeX4EI] diff --git a/template-files/latex4ei/latex4ei_thesis.cls b/template-files/latex4ei/latex4ei_thesis.cls index 6f43584..045a3d8 100644 --- a/template-files/latex4ei/latex4ei_thesis.cls +++ b/template-files/latex4ei/latex4ei_thesis.cls @@ -1,12 +1,12 @@ % -% Thesis class from LaTeX4EI +% Thesis class from LaTeX4EI % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD -% -% © 2011-2015, LaTeX4EI +% +% © 2011-2018, LaTeX4EI % ToDo: @@ -33,7 +33,7 @@ % define baseclass \def\baseclass{scrreprt} - % Options + % Options \newif\ifmarginnumbers\marginnumbersfalse \DeclareOption{marginnumbers}{\marginnumberstrue} @@ -51,7 +51,7 @@ % set default options for base class \PassOptionsToClass{a4paper, 11pt}{\baseclass} - % pass unknown options to base class + % pass unknown options to base class \DeclareOption*{% \PassOptionsToClass{\CurrentOption}{\baseclass}% } @@ -94,10 +94,10 @@ % fix for footnotes in tables \RequirePackage{footnote} \makesavenoteenv{tabular} - \makesavenoteenv{table} + \makesavenoteenv{table} %\shorthandoff{"} % don't convert "A to Ä! - - + + % font %\RequirePackage[osf]{mathpazo} % old style numbering %\renewcommand{\rmdefault}{ppl} % cmr, ptm, ppl, pnc, pbk @@ -124,7 +124,7 @@ \colorlet{col_subsubsection}{tum_blue_dark2} \colorlet{col_table}{tum_blue_dark} \colorlet{col_figure}{tum_blue_dark} - + \colorlet{col_link}{tum_blue} \colorlet{col_lst}{tum_blue_dark} @@ -144,7 +144,7 @@ \RequirePackage{lettrine} - % calculate linespacing based on font size + % calculate linespacing based on font size % char per line: 85 \RequirePackage{setspace} % \setlength{\baselineskip}{3pt} @@ -166,7 +166,7 @@ %\usepackage{natbib} - %\bibliographystyle{natdin} + %\bibliographystyle{natdin} % ====================================================================== @@ -313,11 +313,11 @@ \setlength{\extrarowheight}{0em}% \renewcommand*{\glossaryheader}{}% have nothing after \begin{theglossary} \renewcommand*{\glsgroupheading}[1]{}% - \renewcommand*{\glsgroupskip}{}% have nothing between glossary groups + \renewcommand*{\glsgroupskip}{}% have nothing between glossary groups \begin{longtable}{@{}ll@{}}}{\end{longtable}}% \renewcommand*{\glossaryentryfield}[5]{% \textbf{\glstarget{##1}{##2}}% the entry name - ##4% the symbol + ##4% the symbol & ##3% the description \space\space ##5\\}% the number list } @@ -334,11 +334,11 @@ \newcommand\frontmatter{% \setcounter{page}{1} % set page counter to 1 \pagenumbering{Roman} % roman figures - \loadgeometry{frontmatter} % + \loadgeometry{frontmatter} % \pagestyle{empty} % no numbering in the frontmatter \makeatletter \let\ps@oldplain\ps@plain % backup - \let\ps@plain\ps@empty % set plain pagestyle to empty + \let\ps@plain\ps@empty % set plain pagestyle to empty \makeatother } @@ -427,7 +427,7 @@ \else %% Für Einseitig \fancyhead[OL]{\textcolor{black!70}{\leftmark --- \itshape\nouppercase{\rightmark}}} % gerade Seiten, rechts \fancyhead[OR]{\textcolor{black!70}{\thepage}} % gerade Seiten, links - \fi + \fi \renewcommand{\headrulewidth}{0pt} % Underline headers \renewcommand{\footrulewidth}{0pt} % no footer rule %\fancypagestyle{plain}{} % No chapter+section on chapter start pages @@ -566,7 +566,7 @@ \makeatletter \@removefromreset{figure}{chapter} % continous figure numbering \renewcommand\p@subfigure{\thefigure} - \renewcommand{\thefigure}{\@arabic\c@figure} + \renewcommand{\thefigure}{\@arabic\c@figure} \renewcommand{\thesubfigure}{\alph{subfigure})} \makeatother @@ -649,7 +649,7 @@ numberstyle=\tiny\sffamily\color{col_lst_number}, numbersep=1em, keepspaces=true, - breaklines=true, + breaklines=true, breakatwhitespace=true, postbreak=\postbreak, keywordstyle=\bfseries\color{tum_blue_dark}, diff --git a/template-files/latex4ei/latex4ei_unicode.sty b/template-files/latex4ei/latex4ei_unicode.sty index e02be55..8fa2702 100644 --- a/template-files/latex4ei/latex4ei_unicode.sty +++ b/template-files/latex4ei/latex4ei_unicode.sty @@ -1,12 +1,12 @@ % -% Unicode for LaTeX4EI packages +% Unicode for LaTeX4EI packages % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD -% -% © 2011-2015, LaTeX4EI +% +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e} @@ -15,7 +15,7 @@ % Already defined via textcomp: % „“”äüö -% Greek, small, capital, variants +% Greek, small, capital, variants \DeclareUnicodeCharacter{2014}{\ensuremath{\dash}} \DeclareUnicodeCharacter{03B1}{\ensuremath{\alpha}} % α \DeclareUnicodeCharacter{03B2}{\ensuremath{\beta}} % β @@ -65,7 +65,7 @@ % Symbols \DeclareUnicodeCharacter{2020}{\ensuremath{\dagger}} % † \DeclareUnicodeCharacter{2021}{\ensuremath{\ddagger}} % ‡ -\DeclareUnicodeCharacter{2113}{\ensuremath{\ell}} % ℓ +\DeclareUnicodeCharacter{2113}{\ensuremath{\ell}} % ℓ \DeclareUnicodeCharacter{2202}{\ensuremath{\partial}} % ∂ \DeclareUnicodeCharacter{2205}{\ensuremath{\emptyset}} % ∅ \DeclareUnicodeCharacter{2207}{\ensuremath{\nabla}} % ∇ @@ -206,16 +206,16 @@ \DeclareUnicodeCharacter{2260}{\neq} % ≠ \DeclareUnicodeCharacter{2261}{\equiv} % ≡ \DeclareUnicodeCharacter{2262}{\nequiv} % ≢ only in package txfonts/pxfonts/MnSymbol -%\DeclareUnicodeCharacter{27C2}{\perp} % ⟂ +%\DeclareUnicodeCharacter{27C2}{\perp} % ⟂ \DeclareUnicodeCharacter{22A5}{\perp} % ⊥ downtack -\DeclareUnicodeCharacter{2282}{\subset} % ⊂ -\DeclareUnicodeCharacter{2283}{\supset} % ⊃ +\DeclareUnicodeCharacter{2282}{\subset} % ⊂ +\DeclareUnicodeCharacter{2283}{\supset} % ⊃ % Operations -\DeclareUnicodeCharacter{2229}{\cap} % ∩ -\DeclareUnicodeCharacter{222A}{\cup} % ∪ +\DeclareUnicodeCharacter{2229}{\cap} % ∩ +\DeclareUnicodeCharacter{222A}{\cup} % ∪ \DeclareUnicodeCharacter{2227}{\ensuremath{\wedge}} % ∧ \DeclareUnicodeCharacter{2228}{\ensuremath{\vee}} % ∨ @@ -232,7 +232,7 @@ \DeclareUnicodeCharacter{2A01}{\bigoplus} % ⨁ \DeclareUnicodeCharacter{2A02}{\bigotimes} % ⨂ -\DeclareUnicodeCharacter{2218}{\circ} % ∘ +\DeclareUnicodeCharacter{2218}{\circ} % ∘ \renewcommand{\textperiodcentered}{\cdot} % · Unicode character already defined via textcomp % Modifiers @@ -242,17 +242,17 @@ \DeclareUnicodeCharacter{00B1}{\ensuremath{\pm}} % ± \DeclareUnicodeCharacter{2213}{\ensuremath{\mp}} % ∓ - -% Arrows -\DeclareUnicodeCharacter{2190}{\ensuremath{\leftarrow}} % ← -\DeclareUnicodeCharacter{2191}{\ensuremath{\uparrow}} % ↑ -\DeclareUnicodeCharacter{2192}{\ensuremath{\to}} % → -\DeclareUnicodeCharacter{2191}{\ensuremath{\downarrow}} % ↓ + +% Arrows +\DeclareUnicodeCharacter{2190}{\ensuremath{\leftarrow}} % ← +\DeclareUnicodeCharacter{2191}{\ensuremath{\uparrow}} % ↑ +\DeclareUnicodeCharacter{2192}{\ensuremath{\to}} % → +\DeclareUnicodeCharacter{2191}{\ensuremath{\downarrow}} % ↓ \DeclareUnicodeCharacter{21A6}{\ensuremath{\mapsto}} % ↦ -\DeclareUnicodeCharacter{21D0}{\ensuremath{\Leftarrow}} % ⇐ -\DeclareUnicodeCharacter{21D2}{\ensuremath{\Rightarrow}} % ⇒ -\DeclareUnicodeCharacter{21D4}{\ensuremath{\Leftrightarrow}} % ⇔ +\DeclareUnicodeCharacter{21D0}{\ensuremath{\Leftarrow}} % ⇐ +\DeclareUnicodeCharacter{21D2}{\ensuremath{\Rightarrow}} % ⇒ +\DeclareUnicodeCharacter{21D4}{\ensuremath{\Leftrightarrow}} % ⇔ @@ -274,5 +274,3 @@ %\DeclareUnicodeCharacter{}{\ensuremath{}}% %\DeclareUnicodeCharacter{}{\ensuremath{}}% %\DeclareUnicodeCharacter{}{\ensuremath{}}% - - diff --git a/template-files/latex4ei/scientific.sty b/template-files/latex4ei/scientific.sty index dbab66c..c24614c 100644 --- a/template-files/latex4ei/scientific.sty +++ b/template-files/latex4ei/scientific.sty @@ -1,12 +1,12 @@ % -% latex package with useful macros for scientific documents +% latex package with useful macros for scientific documents % % Authors: Emanuel Regnath, Martin Zellner % Contact: info@latex4ei.de -% Version: 1.0 +% Version: 1.1 % License: TBD -% -% © 2011-2015, LaTeX4EI +% +% © 2011-2018, LaTeX4EI \NeedsTeXFormat{LaTeX2e} @@ -20,32 +20,32 @@ \RequirePackage{ifxetex} \ifxetex% \relax - \else% + \else% % load following packages if and only if compiler is pdflatex - - - + + + \fi - + % load packages, order matter \RequirePackage{amsmath} % math symbols and \DeclareMathOperator \RequirePackage{esint} % more integral symbols %\RequirePackage{accents} % accents such as \vec and \ddot % additional packages - \RequirePackage{amssymb} % additional math - + \RequirePackage{amssymb} % additional math + % save old commands \let\oldvec = \vec \let\olddot = \dot \let\diameter = \O - + % formating indices \newcommand{\ir}[1]{\sf #1} % index roman - + % differential delta \newcommand{\diff}{\mathop{}\!\mathrm{\vphantom( d}} - + % ====================================================================== % SI Units @@ -106,8 +106,8 @@ % chemistry \newcommand{\chem}[1]{\ensuremath{\displaystyle{\mathrm{#1}}}} % chemistry with \chem (simple) \RequirePackage[version=3]{mhchem} % chemistry with \ce (advanced) - - + + \newcommand{\rom}[1]{\ensuremath{\underline{\overline{\textsc{#1}}}}} % roman numbers @@ -117,7 +117,7 @@ % math \providecommand{\e}{\mathrm{e}} - + % physical \providecommand{\kB}{\ensuremath{\mathrm{k}_{\text{B}}}} % Boltzman \providecommand{\Rgas}{\ensuremath{\mathrm{R}}} % Allg. Gaskonstante @@ -144,7 +144,7 @@ % ====================================================================== % Sets % ====================================================================== - + % define sets \newcommand{\iset}[2]{\ensuremath{\bigl\{ \bigl. #1 \, \bigr| \, #2 \bigr\}}} % intensional set \newcommand{\eset}[1]{\ensuremath{\bigl\{#1\bigr\}}} % extensional set @@ -175,11 +175,12 @@ \newcommand{\ftsymbol}{\mbox{\setlength{\unitlength}{0.1em} \begin{picture}(25,4) \put(3,3){\circle{4}} % empty - \put(5,3){\line(1,0){13}} + \put(5,3){\line(1,0){13}} \put(19,3){\circle*{4}} % filled \end{picture}}} % Define Transformations + \DeclareMathOperator{\T}{\overset{\scriptscriptstyle\mathcal{}}{\ftsymbol}} % General Transformation \DeclareMathOperator{\FT}{\overset{\scriptscriptstyle\mathcal{F}}{\ftsymbol}} % Fourier Transform \DeclareMathOperator{\LT}{\overset{\scriptscriptstyle\mathcal{L}}{\ftsymbol}} % Laplace Transform \DeclareMathOperator{\DFT}{\overset{\scriptscriptstyle\mathcal{DF}}{\ftsymbol}} % Discrete Fourier Transform @@ -187,7 +188,7 @@ \DeclareMathOperator{\ZT}{\overset{\scriptscriptstyle\mathcal{Z}}{\ftsymbol}} % Z-Transform % ====================================================================== -% Differential Geometry +% Differential Geometry % ====================================================================== \DeclareMathOperator{\grad}{grad} % Gradient @@ -245,4 +246,3 @@ % Ende von \input \endinput -