TechCheck.cls

%=================================================================
% MIT LICENSE
%=================================================================
% Copyright (c) 2023 Techneatium
%
% 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.
%=================================================================

\NeedsTeXFormat{LaTeX2e}
\LoadClass[10pt,usenames,dvipsnames,twoside]{book}
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{TechCheck}[2023/01/14]

%-----------------------------------------------------------------
% GENERAL PACKAGES
%-----------------------------------------------------------------
\RequirePackage{geometry}
\RequirePackage[]{datetime2} % change date format
\DTMnewstyle{yymmdd}{ % create new date style
	\renewcommand*\DTMdisplaydate[4]{%
		\DTMtwodigits{##1}\DTMtwodigits{##2}\DTMtwodigits{##3}% 
	}
	\renewcommand*{\DTMDisplaydate}{\DTMdisplaydate}%
}{}{}{}
\DTMsetstyle{yymmdd} % set new style as default
\RequirePackage[shortlabels]{enumitem} % pause/resume lists
\RequirePackage{multicol} % multi column format
\RequirePackage{graphicx} % used for figures
\graphicspath{{images/}} % put figures inside folder 'images'  in same folder as .tex
\RequirePackage{subcaption} % used for subfigures
\RequirePackage[dvipsnames]{xcolor} %colors, dvips -> extra premade colors
\RequirePackage[explicit]{titlesec} % formating of titles
\RequirePackage{siunitx} % SI units
\RequirePackage{tikz} % shapes, figures
\RequirePackage{tikzpagenodes} % points for tikz
\usetikzlibrary{calc} % used for hyperlinked nodes
\RequirePackage[hidelinks]{hyperref} % used for hyperlinked nodes
\RequirePackage{cleveref} % better referencing
\RequirePackage[document]{ragged2e} % left ragged text
% \RequirePackage{atbegshi}  % special commands that apply tikz to all pages
\RequirePackage{fancyhdr} % custom header/footer
\RequirePackage{etoolbox} % Boolean and if/else
\RequirePackage{calc} % math inside other commands
\RequirePackage{booktabs} % fancy tables
\RequirePackage{multirow} % more fancy tables
\RequirePackage{longtable} % multi page tables
\RequirePackage{tocloft} % TOC formatting
\RequirePackage{minitoc} % chapter tocs
\RequirePackage[auto]{chappg}
\RequirePackage{tcolorbox} % for rounded boxes
\tcbuselibrary{skins, breakable}
\RequirePackage{luatex85} % required to make changebar work with lualatex
\RequirePackage[pdftex, color, outerbars]{changebar} % what it says
\RequirePackage{xkeyval} % allows defining keys for macros

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% O P T I O N S   S T A R T
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%-----------------------------------------------------------------
% FONT OPTIONS
%-----------------------------------------------------------------
% Declare toggles for each font option
\newtoggle{fontHelvet}
\newtoggle{loadfontspec}
\newtoggle{fontJost}
\newtoggle{fontSpartan}
\newtoggle{fontMetropolis}
\newtoggle{fontInter}

% Default pdflatex helvetica clone
\DeclareOption{fontHelvet}{
  	\toggletrue{fontHelvet}
}

% Futura Clone -- pointy 
\DeclareOption{fontJost}{
	\toggletrue{loadfontspec}
	\toggletrue{fontJost}
	% toggle other fonts false
	\togglefalse{fontSpartan}
	\togglefalse{fontMetropolis}
	\togglefalse{fontInter}
}

% Futura DemiBold Clone
\DeclareOption{fontSpartan}{
	\toggletrue{loadfontspec}
	\toggletrue{fontSpartan}
	% toggle other fonts false
	\togglefalse{fontJost}
	\togglefalse{fontMetropolis}
	\togglefalse{fontInter}
}

% Gotham Clone 
\DeclareOption{fontMetropolis}{
	\toggletrue{loadfontspec}
	\toggletrue{fontMetropolis}
	% toggle other fonts false
	\togglefalse{fontJost}
	\togglefalse{fontSpartan}
	\togglefalse{fontInter}
}

% Helvetica clone
\DeclareOption{fontInter}{
	\toggletrue{loadfontspec}
	\toggletrue{fontInter}
	% toggle other fonts false
	\togglefalse{fontJost}
	\togglefalse{fontSpartan}
	\togglefalse{fontMetropolis}
}

%-----------------------------------------------------------------
% GEOMETRY OPTIONS
%-----------------------------------------------------------------
% if print will add corner rounding and tabs
\newtoggle{print}

% Basic paper geometry
\newlength{\TC@paperh}
\newlength{\TC@paperw}

% margins, input here as variable for ROUNDING
\newlength{\TC@inmar}
\newlength{\TC@outmar}
\newlength{\TC@topmar}
\newlength{\TC@botmar}
\newlength{\TC@footmar}
\setlength\TC@topmar{1.2cm}
\setlength\TC@botmar{0.8cm}
\setlength\TC@footmar{0.5cm}

% indendtation for chevrons on front page
\newlength{\TC@chevin}

% tab dimensions
\newlength{\TC@tabwidth}
\newlength{\TC@tabdepth}

% Number of sections
\newcounter{tabnumber}
\setcounter{tabnumber}{6}

% determines width of tab based on number of tabs
\setlength\TC@tabwidth{\textheight/\thetabnumber}

% Nominal A5 paper size -- 210x148mm
\DeclareOption{a5}{
	\setlength\TC@paperh{210mm}
	\setlength\TC@paperw{148mm}
	\setlength\TC@inmar{10mm}
	\setlength\TC@outmar{10mm}
	\setlength{\TC@chevin}{\TC@outmar-33mm}
	\setlength\TC@tabdepth{8mm}
    \togglefalse{print}
}

% A5 paper with 8mm extra for tabs -- 210x(148+8)mm
\DeclareOption{a5print}{ 
	\setlength\TC@paperh{210mm}
	\setlength\TC@paperw{156mm}
	\setlength\TC@inmar{16mm}
	\setlength\TC@outmar{12mm}
	\setlength\TC@chevin{\TC@outmar-35mm}
	\setlength\TC@tabdepth{8mm}
	\toggletrue{print}
}

% A5 paper with 9.5mm extra for 4x3 aspect -- 210x(148+9.5)mm
\DeclareOption{4x3print}{ 
	\setlength\TC@paperh{210mm}
	\setlength\TC@paperw{157.5mm}
	\setlength\TC@inmar{16mm}
	\setlength\TC@outmar{13.5mm}
	\setlength\TC@chevin{\TC@outmar-36.5mm}
	\setlength\TC@tabdepth{9.5mm}
	\toggletrue{print}
}


% Nominal A4 paper size -- 297x210mm
\DeclareOption{a4}{
	\setlength\TC@paperh{297mm}
	\setlength\TC@paperw{210mm}
	\setlength\TC@inmar{14mm}
	\setlength\TC@outmar{14mm}
	\setlength{\TC@chevin}{\TC@outmar-31mm}
	\setlength\TC@tabdepth{8mm}
    \togglefalse{print}
}

% A4 paper with offset margins for printing -- 297x210mm
\DeclareOption{a4print}{
	\setlength\TC@paperh{297mm}
	\setlength\TC@paperw{210mm}
	\setlength\TC@inmar{16mm}
	\setlength\TC@outmar{12mm}
	\setlength{\TC@chevin}{\TC@outmar-29mm}
	\setlength\TC@tabdepth{8mm}
	\toggletrue{print}
}

%-----------------------------------------------------------------
% COLOR OPTIONS
%-----------------------------------------------------------------
% color1 - main color
% color2 - highlight color
% color3 - alternate highlight color

\DeclareOption{colorful}{
	\colorlet{color1}{black}
	% \definecolor{color1}{HTML}{222222}
	\colorlet{color2}{NavyBlue}
	\colorlet{color3}{NavyBlue}
	\definecolor{color4}{HTML}{FFE534} % bf2042yellow
}

\DeclareOption{b/w}{
	\colorlet{color1}{black}
	\colorlet{color2}{black}
	\colorlet{color3}{black}
	\definecolor{color4}{HTML}{FFE534} % bf2042yellow
}

%-----------------------------------------------------------------
% TECHHATCHTABS OPTIONS
%-----------------------------------------------------------------
\DeclareOption{squaretabs}{
    \PassOptionsToPackage{squaretabs}{techhatchtabs}
}

% turns off thumbtab indentation (for cutting out)
\DeclareOption{nothumbtabindent}{
    \PassOptionsToPackage{thumbtabindent=false}{techhatchtabs}
}

% turns off thumbnar 'indentation' by tabwidth
\DeclareOption{nothumbnarindent}{
    \PassOptionsToPackage{thumbnarindent=false}{techhatchtabs}
}

% turns off automatic thumbnar'ing
\DeclareOption{manthumbnar}{
  	\PassOptionsToPackage{autothumbnar=false}{techhatchtabs}
}

% turns off automatic generation of thumbback node on page
% after thumbtab
\DeclareOption{manthumbback}{
    \PassOptionsToPackage{autothumbback=false}{techhatchtabs}
}

% deactivates all page rounding and indentation
\DeclareOption{noround}{
    \PassOptionsToPackage{round=false}{techhatchtabs}
}

% deactivates all hatching
\DeclareOption{nohatch}{
    \PassOptionsToPackage{hatch=false}{techhatchtabs}
}

%-----------------------------------------------------------------
% DEV OPTIONS
%-----------------------------------------------------------------

% Geometry showframe
\DeclareOption{showframe}{
  	\PassOptionsToPackage{showframe}{geometry}
}

%-----------------------------------------------------------------
% PROCESS OPTIONS
%-----------------------------------------------------------------
\ExecuteOptions{fontSpartan, a5print, colorful}
\ProcessOptions*\relax

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% GLOBAL FORMATTING
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%-----------------------------------------------------------------
% APPLY PAGE GEOMETRY
%-----------------------------------------------------------------
\geometry{
	paperheight=\TC@paperh,
	paperwidth=\TC@paperw,
	margin=1mm,
	top=\TC@topmar,
	bottom=\TC@botmar,
	headsep=5mm,
	headheight=5mm,
	footskip=\TC@footmar,
	inner=\TC@inmar,
	outer=\TC@outmar,
	centering
}

%-----------------------------------------------------------------
% CUSTOM PACKAGES
%-----------------------------------------------------------------
\iftoggle{print}{
    % if true no action necessary, defaults to printable behavior
}{
    % if false turns of rounding completely
    % leaves 'autothumbback' on!
    \PassOptionsToPackage{
        round=false,
    }{techhatchtabs}
}

\RequirePackage[
    top=\TC@topmar,
    bottom=\TC@botmar,
    inner=\TC@inmar,
    outer=\TC@outmar,
    tabwidth=\TC@tabwidth,
    tabdepth=\TC@tabdepth,
    chevin=\TC@chevin,
]{techhatchtabs} % custom page hatching 

\RequirePackage{technumitem} % custom enumitem like environments

%-----------------------------------------------------------------
% OPTIONAL PACKAGES
%-----------------------------------------------------------------
\iftoggle{fontHelvet}{
	\RequirePackage[T1]{fontenc}
	\RequirePackage{helvet}
	\renewcommand{\familydefault}{\sfdefault}
}{}

\iftoggle{loadfontspec}{
	\RequirePackage{fontspec}
}{}

\iftoggle{fontJost}{
	\setmainfont[
		Path=./fonts/,
		Ligatures=TeX,
		UprightFont=*-Regular,
		ItalicFont=*-Italic,
		BoldFont=*-Bold,
		BoldFeatures={LetterSpace=2.5}
	]{Jost}
	\newfontfamily\tightfont{Jost-Bold}[Path=./fonts/, Ligatures=TeX, BoldFeatures={LetterSpace=0.0}] % used for `---` in page numbering
	\newfontfamily\titlefont{Jost-Bold}[Path=./fonts/, Ligatures=TeX, LetterSpace=4.0]
}{}

\iftoggle{fontSpartan}{
	\setmainfont[
		Path=./fonts/,
		Ligatures=TeX,
		UprightFont=*-Medium,
		LetterSpace=2.0,
		ItalicFont=*-Medium Italic,
		ItalicFeatures={Scale=1.0},
		BoldFont=*-Bold,
		BoldFeatures={LetterSpace=5.0},
	]{Spartan MB}
	\newfontfamily\tightfont{Spartan MB-Bold}[Path=./fonts/, Ligatures=TeX, BoldFeatures={LetterSpace=0.0}] % used for `---` in page numbering
	\newfontfamily\titlefont{Spartan MB-Bold}[Path=./fonts/, Ligatures=TeX, LetterSpace=4.0]
}{}

\iftoggle{fontMetropolis}{
	\setmainfont[
		Path=./fonts/,
		Ligatures=TeX,
		UprightFont=*-Regular,
		ItalicFont=*-Regular Italic,
		BoldFont=*-Semi Bold,
		BoldFeatures={LetterSpace=3.0},
	]{Metropolis}
	\newfontfamily\tightfont{Metropolis-Bold}[Path=./fonts/, Ligatures=TeX, BoldFeatures={LetterSpace=0.0}] % used for `---` in page numbering
	\newfontfamily\titlefont{Metropolis-Bold}[Path=./fonts/, Ligatures=TeX, LetterSpace=4.0]
}{}

\iftoggle{fontInter}{
	\setmainfont[
		Path=./fonts/,
		Ligatures=TeX,
		UprightFont=*-Regular,
		BoldFont=*-Bold,
		ItalicFont=Jost-Italic,
	]{Inter}
	\newfontfamily\tightfont{Spartan MB-Bold}[Path=./fonts/, Ligatures=TeX, BoldFeatures={LetterSpace=0.0}] % used for `---` in page numbering
	\newfontfamily\titlefont{Spartan MB-Bold}[Path=./fonts/, Ligatures=TeX, LetterSpace=4.0]
}{}

%-----------------------------------------------------------------
% GLOBAL PARAMETER COMMANDS
%-----------------------------------------------------------------
% Set label for title page
\newcommand*\aircraftlong{FULL A/C NAME}
\newcommand*{\setaircraftlong}[1]{\renewcommand*\aircraftlong{#1}}
% Set label for header
\newcommand*\aircraftshort{F-XX}
\newcommand*{\setaircraftshort}[1]{\renewcommand*\aircraftshort{#1}}

% Set number of tabs in preable
\newcommand{\settabnumber}[1]{
	\setcounter{tabnumber}{#1}
	\setlength\TC@tabwidth{\textheight/\thetabnumber}
}

%-----------------------------------------------------------------
% HEADER/FOOT FORMATTING
%-----------------------------------------------------------------
% remove header and foot
\pagestyle{empty}
% fancy header with section title in hatching
\pagestyle{fancy}
\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ -- #1}{}}
\fancypagestyle{superempty}{
	% clear defaults
	\fancyhf{}
	\fancyhead[LE,LO]{
        \hatch
    }
}

\fancypagestyle{empty}{
	% clear defaults
	\fancyhf{}
	% page number in footer
	\fancyfoot[LE, RO]{{\tightfont\quad\textbf{\thepage}\quad}}% LE,RO or C
	% Version nbumber in footer
	\fancyfoot[RE, LO]{{\titlefont\textbf{REV: \today}}}
	% Aircraft name in footer
	\fancyfoot[C]{{\titlefont\textbf{\aircraftshort}}}
	\fancyhead[LE,LO]{
		\hatch
	}
	\fancyhead[RO]{
        \thumbnar
	}
}

\fancypagestyle{plain}{
	% clear defaults
	\fancyhf{}
	% page number in footer
	\fancyfoot[LE, RO]{{\tightfont\quad\textbf{\thepage}\quad}}% LE,RO or C
	% Version nbumber in footer
	\fancyfoot[RE, LO]{{\titlefont\textbf{REV: \today}}}
	% Aircraft name in footer
	\fancyfoot[C]{{\titlefont\textbf{\aircraftshort}}}
	\fancyhead[LE,LO]{
        \hatch
	}
}

\fancypagestyle{body}{
	% clear defaults
	\fancyhf{}
	% page number in footer
	\fancyfoot[LE, RO]{{\tightfont\quad\textbf{\thepage}\quad}}% LE,RO or C
	% Version nbumber in footer
	\fancyfoot[RE, LO]{{\titlefont\textbf{REV: \today}}}
	% Aircraft name in footer
	\fancyfoot[C]{{\titlefont\textbf{\aircraftshort}}}
	% Header
	\fancyhead[RO]{
		\colorbox{color1}{
			\textcolor{white}{\titlefont\Large\textbf{\rightmark}}
		}
        \thumbnar
	}
	\fancyhead[RE]{
		\colorbox{color1}{
			\textcolor{white}{\titlefont\Large\textbf{\rightmark}}
		}
  	}
	\fancyhead[LE,LO]{
        \hatch
		\colorbox{color1}{
			\textcolor{white}{\titlefont\Large\textbf{\leftmark}}
		}
  	}
	\renewcommand{\headrulewidth}{0pt} % header rule width
	\renewcommand{\footrulewidth}{0pt} % footer rule width
}
\pagestyle{body}

%-----------------------------------------------------------------
% ENUMITEM FORMATTING
%-----------------------------------------------------------------
% spacing within lists
\setlist[enumerate, 1]{itemsep=1pt, parsep=0pt, label=(\alph*)}
\setlist[enumerate, 2]{itemsep=1pt, parsep=0pt}
\setlist[itemize, 1]{itemsep=1pt, parsep=0pt, label=\textbf{\textbullet}}
\setlist[itemize, 2]{itemsep=1pt, parsep=0pt}

%-----------------------------------------------------------------
% OTHER FORMATTING
%-----------------------------------------------------------------
% indent for paragraph
\setlength{\parindent}{0pt}
% space between paragraphs
\setlength{\parskip}{0.3em}

% space between columns
\setlength{\columnsep}{2mm}
% create lines between columns and define color of columns
\setlength{\columnseprule}{0pt} %set thickness default 1pt
\def\columnseprulecolor{\color{color1}}

%-----------------------------------------------------------------
% CHANGEBAR SETTINGS
%-----------------------------------------------------------------
\cbcolor{color1}
\setlength{\changebarwidth}{2mm}
\setlength{\changebarsep}{2mm}

%-----------------------------------------------------------------
% TOCLOFT FORMATTING
%-----------------------------------------------------------------
% change distance between section number and title
% default: 1.55em
\tocloftpagestyle{empty}

%-----------------------------------------------------------------
% MINITOC FORMATTING
%-----------------------------------------------------------------
\mtcsetfont{minitoc}{section}{\normalfont\small}
\mtcsetrules{minitoc}{off}

%-----------------------------------------------------------------
% TITLE FORMATTING
%-----------------------------------------------------------------
% \titleformat{<command>}[<shape>]{<format>}{<label>}{<sep>}{<before-code>}[<after-code>]

% formatting of chapter
\titleformat{\chapter}[display] % command
	{\titlefont\huge\bfseries} % format
	{\chaptertitlename\ \thechapter} % label
	{20pt} % sep
	{\hatch\Huge #1} % before-code
	[] % after code

% formatting of section
\titleformat{\section} % command
	{\color{color1}\titlefont\large\bfseries} % format
	{\color{color1}\thesection} % label
	{1em} % sep
	{#1} % before-code
	[{\titlerule[2pt]}] % after-code

% formatting of subsection [full width]
\titleformat{\subsection} % command
	{\normalfont\bfseries} % format
	{\color{color1}} % label
	{0em} % sep
	{\colorbox{black}{\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\textcolor{white}{\titlefont\thesubsection\quad#1}}}} % before-code

\titleformat{name=\subsection,numberless} % command
	{\normalfont\bfseries} % format
	{\color{color1}} % label
	{0em} % sep
	{\colorbox{black}{\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\textcolor{white}{#1}}}} % before-code

% 1st number is weird, 2nd is spacing before, 3rd is spacing after subsection title
\titlespacing*{\chapter}{0pt}{50pt}{40pt}
\titlespacing{\section}{0pt}{5pt}{2pt}
\titlespacing{\subsection}{0pt}{2pt}{2pt}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% CUSTOM COMMANDS / ENVIRONEMNTS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%-----------------------------------------------------------------
% CUSTOM COMMANDS
%-----------------------------------------------------------------
% command to create blue, bold mini-titles
\newcommand{\blue}[1]{
	\textbf{\textcolor{color2}{#1}}
}

% command to create bold, white-on-blue, mini titles
\newcommand{\dblue}[1]{
	\colorbox{color3}{
		\textbf{\textcolor{white}{#1}}
	}
}

\newcommand{\yellow}[1]{
	\colorbox{color4}{
		\textbf{\textcolor{black}{#1}}
	}
}

\newcommand{\notebox}[1]{
	\begin{tcolorbox}[
		enhanced,
		colback=white,
		colframe=color1,
		sharp corners,
		frame hidden,
		colbacktitle=white,
		coltitle=color1,
        fonttitle=\titlefont\bfseries,
		attach boxed title to top center,
		boxed title style={
		sharp corners,
		% drop shadow=color1!100
		},
		title=\large NOTE,
	]
		{#1}
	\end{tcolorbox}
}

\newcommand{\warningbox}[1]{
	\begin{tcolorbox}[
		enhanced,
		colback=white,
		colframe=color1,
		sharp corners,
		frame hidden,
		colbacktitle=white,
		coltitle=color1,
        fonttitle=\titlefont\bfseries,
		attach boxed title to top center,
		boxed title style={
		sharp corners,
		drop shadow=color1!100,
		},
		title=\large WARNING
	]
		{#1}
	\end{tcolorbox}
}