Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ni-m committed Jan 8, 2024
0 parents commit 42d98e1
Show file tree
Hide file tree
Showing 13 changed files with 326 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
19 changes: 19 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Core latex/pdflatex auxiliary files:
*.aux
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.fmt
*.fot
*.cb
*.cb2
.*.lb

*.gz
*.fdb_latexmk

example.pdf

21 changes: 21 additions & 0 deletions LICENCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Marco Niederberger, [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Latex Datasheet Template

This repo provides a Latex class for a datasheet.
Use the provided [datasheet.cls](datasheet.cls) file as the class for your document.

See [example.tex](example.tex) for a short introduction on how to use the class.
See the release section of this repo for an example pdf.

![Latex datasheet template](images/overview.jpg)


## Contribution
Feel free to fork and improve this class.
118 changes: 118 additions & 0 deletions datasheet.cls
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
% LaTeX class for datasheets
%
% MIT License
%
% Copyright (c) 2024 Marco Niederberger, [email protected]
%
% Permission is hereby granted, free of charge, to any person obtaining a copy
% of this software and associated documentation files (the "Software"), to deal
% in the Software without restriction, including without limitation the rights
% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
% copies of the Software, and to permit persons to whom the Software is
% furnished to do so, subject to the following conditions:
%
% The above copyright notice and this permission notice shall be included in all
% copies or substantial portions of the Software.
%
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
% SOFTWARE.
%
% Usage: place .cls file in same directory as .tex file and reference class
% in .tex file with: \documentclass{datasheet}
%
% Marco Niederberger <[email protected]> 2024-01-08
%------------------------------------------------------------------------------%


\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{datasheet}[2024-01-08 Datasheet template by @ni-m]

\DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
\ProcessOptions\relax

\LoadClass[a4paper,12pt]{article}

\usepackage[table]{xcolor}
\usepackage{tabularx} % Table with \textwidth
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
% \usepackage[showframe]{geometry}
\usepackage{geometry}
\geometry{papersize={210mm,297mm},total={160mm,230mm},top=20mm}
\usepackage{amscd}
\usepackage{graphicx}
\usepackage{fancyhdr}
\usepackage{textcomp}
\usepackage{txfonts}
\usepackage{paralist}
\usepackage{multicol}
\usepackage{tabularx} % Table with \textwidth
\usepackage{siunitx}
\usepackage{catchfile} % used for gitHash extraction
\usepackage{xstring} % used for gitHash extraction
\usepackage{datetime2} % Use ISO 8601 for date display
\usepackage{helvet}
\renewcommand{\familydefault}{\sfdefault}

\setlength\columnsep{30pt} % This is the default columnsep for all pages
\setlength{\parindent}{0cm}
\renewcommand{\arraystretch}{1.2}%
\setlength\arrayrulewidth{0.5pt}

\gdef\@projectname{}
\newcommand{\projectname}[1]{\gdef\@projectname{#1}}

\gdef\@revision{}
\newcommand{\revision}[1]{\gdef\@revision{#1}}

\fancypagestyle{titlepage}{
\fancyhf{}
\rhead{\parbox[][\headheight][t]{5cm}{\normalsize\raggedleft \textbf{\@projectname}}}
% \rhead{\textbf{\@projectname}}
\lhead{\includegraphics[height=1.9cm]{images/logo.png}}
\rfoot{\bf \@author}
\renewcommand{\headrulewidth}{2pt}
\renewcommand{\footrulewidth}{2pt}

% headheight + headsep = constant; keeps upper edge of body on the same height in every style
\setlength{\headheight}{2cm}
\setlength{\headsep}{1.3cm}

\setlength{\abovecaptionskip}{1pt plus 3pt minus 2pt}
}

\fancypagestyle{layoutAll}{
\fancyhf{}
\lhead{\bf \@projectname}
\rhead{\includegraphics[width=3cm]{images/logo.png}}
% \lfoot{Marco Niederberger, Yanick Schoch}
\rfoot{\thepage}
\renewcommand{\headrulewidth}{2pt}
\renewcommand{\footrulewidth}{2pt}

% headheight + headsep = constant; keeps upper edge of body on the same height in every style
\setlength{\headheight}{2.3cm}
\setlength{\headsep}{1cm}

\setlength{\abovecaptionskip}{1pt plus 3pt minus 2pt}
}

\abovedisplayskip=14pt plus 3pt minus 3pt
\abovedisplayshortskip=14pt plus 3pt
\belowdisplayskip=14pt plus 3pt minus 3pt
\belowdisplayshortskip=14pt plus 3pt minus 3pt

% Git hash extraction and custom cmd
% \CatchFileDef{\headfull}{.git/HEAD}{}
% \StrGobbleRight{\headfull}{1}[\head]
% \StrBehind[2]{\head}{/}[\branch]
% \IfFileExists{.git/refs/heads/\branch}{
% \CatchFileDef{\commit}{.git/refs/heads/\branch}{}
% }{
% \newcommand{\commit}{\dots~(in \emph{packed-refs})}
% }
19 changes: 19 additions & 0 deletions example.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
\documentclass{datasheet}

\author{Marco Niederberger, Yanick Schoch}
\projectname{Datasheet template}
\revision{v0.1}

\begin{document}

\pagestyle{titlepage}
\input{sections/00-titlepage.tex}

\pagestyle{layoutAll}
\input{sections/10-ratings.tex}
\newpage
\input{sections/20-plots.tex}
\newpage
\input{sections/90-impressum.tex}

\end{document}
Binary file added images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions sections/00-titlepage.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
\newcommand\HRule{\noindent\rule{\linewidth}{2pt}}

{
\centering
\Large
\bf
\scalebox{.8}[1.0]{Two colums, Tables, Plots}\\
\scalebox{.8}[1.0]{TECHNICAL DATASHEET TEMPLATE}\\
}
\HRule

\begin{multicols}{2}
\subsubsection*{FEATURES}
\vspace{-3mm}
\begin{compactitem}
\item Two columns
\item Tables over the entire text width
\item Look and feel like a real datasheet
\end{compactitem}

\subsubsection*{APPLICATIONS}
\vspace{-3mm}
\begin{compactitem}
\item Work
\item School
\item Thesis
\end{compactitem}

\columnbreak
\subsubsection*{DESCRIPTION}
\vspace{-3mm}
This is a \LaTeX{} template for a datasheet.
The look and feel is like a normal datasheet with the common headers.
To use this datasheet, add the \texttt{datasheet.cls} file into the same folder as your main document.
Then use \texttt{documentclass{datasheet}} to load the class.


After that you may use the example sections or create a new datasheet.

\end{multicols}
\vfill
{
\centering
\includegraphics[width=\textwidth]{images/plot.png}
}
\newpage
47 changes: 47 additions & 0 deletions sections/10-ratings.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
\subsubsection*{ABSOLUTE MAXIMUM RATINGS}
\small{Over operating free-air temperature range (unless otherwise noted)}
\vspace{-3.5mm}
\begin{table}[h]
\begin{tabularx}{\textwidth}{|X|c|c|c|c|}
\hline
& \textbf{ MIN } & \textbf{ TYP } & \textbf{MAX} & \textbf{ UNIT } \\
\hline
12V Supply & -0.3 & 12 & 15 & V \\
\hline
3V3 Supply & & 3.3 & 4 & V \\
\hline
Digital IO & -0.5 & & 6.5 & V \\
\hline
Analog IO & -12 & & 12 & V \\
\hline
\end{tabularx}
\end{table}

\subsubsection*{ELECTRICAL CHARACTERISTICS}
\begin{table}[h]
\begin{tabularx}{\textwidth}{|X|c|c|c|c|}
\hline
& \textbf{ MIN } & \textbf{ TYP } & \textbf{MAX} & \textbf{ UNIT } \\
\hline
12V Supply voltage & 11.8 & 12 & 12.2 & V \\
\hline
12V Supply current & 0.5 & & & A \\
\hline
3V3 Supply voltage & 3.1 & 3.3 & 3.5 & V \\
\hline
3V3 Supply current & 1.6 & & & A \\
\hline
Threshold resolution & 16 & & & Bits \\
\hline
Threshold range & -1.5 & & 1.5 & V \\
\hline
Measurement channel & -1.5 & & 1.5 & V \\
\hline
Input impedance & & 50 & & $\Omega$ \\
\hline
Detectable pulse width & 0.5 & & & ns \\
\hline
Analog bandwidth & & & 5.3 & GHz \\
\hline
\end{tabularx}
\end{table}
24 changes: 24 additions & 0 deletions sections/20-plots.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
\subsubsection*{TYPICAL CHARACTERISTICS}
\begin{multicols}{2}
\centering
\includegraphics[width=\columnwidth]{images/plot.png}
First plot
\vspace{5pt}
\includegraphics[width=\columnwidth]{images/plot.png}
Third plot
\vspace{5pt}
\includegraphics[width=\columnwidth]{images/plot.png}
Fifth plot
\vspace{5pt}

\columnbreak
\includegraphics[width=\columnwidth]{images/plot.png}
Second plot
\vspace{5pt}
\includegraphics[width=\columnwidth]{images/plot.png}
Fourth plot
\vspace{5pt}
\includegraphics[width=\columnwidth]{images/plot.png}
Sixth plot
\vspace{5pt}
\end{multicols}
17 changes: 17 additions & 0 deletions sections/90-impressum.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
\null
\vfill
\subsubsection*{IMPRESSUM}

\begin{table}[ht]
\textbf{Date} \\
\today \\
\\
\textbf{Written by} \\
Marco Niederberger\textsuperscript{1} \\
Yanick Schoch \\
\end{table}

{
\footnotesize
\textsuperscript{1}[email protected]
}

0 comments on commit 42d98e1

Please sign in to comment.