Add specification for Profile scripting language

This commit is contained in:
Mario Hüttel 2020-04-14 22:01:41 +02:00
parent bf985a9ca4
commit f7998f4c57
4 changed files with 461 additions and 0 deletions

279
temp-profile-spec/.gitignore vendored Normal file
View File

@ -0,0 +1,279 @@
# Created by https://www.gitignore.io/api/latex
# Edit at https://www.gitignore.io/?templates=latex
### LaTeX ###
## Core latex/pdflatex auxiliary files:
*.aux
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.fmt
*.fot
*.cb
*.cb2
.*.lb
## Intermediate documents:
*.dvi
*.xdv
*-converted-to.*
# these rules might exclude image files for figures etc.
# *.ps
# *.eps
# *.pdf
## Generated if empty string is given at "Please type another file name for output:"
specification.pdf
## Bibliography auxiliary files (bibtex/biblatex/biber):
*.bbl
*.bcf
*.blg
*-blx.aux
*-blx.bib
*.run.xml
## Build tool auxiliary files:
*.fdb_latexmk
*.synctex
*.synctex(busy)
*.synctex.gz
*.synctex.gz(busy)
*.pdfsync
## Build tool directories for auxiliary files
# latexrun
latex.out/
## Auxiliary and intermediate files from other packages:
# algorithms
*.alg
*.loa
# achemso
acs-*.bib
# amsthm
*.thm
# beamer
*.nav
*.pre
*.snm
*.vrb
# changes
*.soc
# comment
*.cut
# cprotect
*.cpt
# elsarticle (documentclass of Elsevier journals)
*.spl
# endnotes
*.ent
# fixme
*.lox
# feynmf/feynmp
*.mf
*.mp
*.t[1-9]
*.t[1-9][0-9]
*.tfm
#(r)(e)ledmac/(r)(e)ledpar
*.end
*.?end
*.[1-9]
*.[1-9][0-9]
*.[1-9][0-9][0-9]
*.[1-9]R
*.[1-9][0-9]R
*.[1-9][0-9][0-9]R
*.eledsec[1-9]
*.eledsec[1-9]R
*.eledsec[1-9][0-9]
*.eledsec[1-9][0-9]R
*.eledsec[1-9][0-9][0-9]
*.eledsec[1-9][0-9][0-9]R
# glossaries
*.acn
*.acr
*.glg
*.glo
*.gls
*.glsdefs
# uncomment this for glossaries-extra (will ignore makeindex's style files!)
# *.ist
# gnuplottex
*-gnuplottex-*
# gregoriotex
*.gaux
*.gtex
# htlatex
*.4ct
*.4tc
*.idv
*.lg
*.trc
*.xref
# hyperref
*.brf
# knitr
*-concordance.tex
# TODO Comment the next line if you want to keep your tikz graphics files
*.tikz
*-tikzDictionary
# listings
*.lol
# luatexja-ruby
*.ltjruby
# makeidx
*.idx
*.ilg
*.ind
# minitoc
*.maf
*.mlf
*.mlt
*.mtc[0-9]*
*.slf[0-9]*
*.slt[0-9]*
*.stc[0-9]*
# minted
_minted*
*.pyg
# morewrites
*.mw
# nomencl
*.nlg
*.nlo
*.nls
# pax
*.pax
# pdfpcnotes
*.pdfpc
# sagetex
*.sagetex.sage
*.sagetex.py
*.sagetex.scmd
# scrwfile
*.wrt
# sympy
*.sout
*.sympy
sympy-plots-for-*.tex/
# pdfcomment
*.upa
*.upb
# pythontex
*.pytxcode
pythontex-files-*/
# tcolorbox
*.listing
# thmtools
*.loe
# TikZ & PGF
*.dpth
*.md5
*.auxlock
# todonotes
*.tdo
# vhistory
*.hst
*.ver
# easy-todo
*.lod
# xcolor
*.xcp
# xmpincl
*.xmpi
# xindy
*.xdy
# xypic precompiled matrices
*.xyc
# endfloat
*.ttt
*.fff
# Latexian
TSWLatexianTemp*
## Editors:
# WinEdt
*.bak
*.sav
# Texpad
.texpadtmp
# LyX
*.lyx~
# Kile
*.backup
# KBibTeX
*~[0-9]*
# auto folder when using emacs and auctex
./auto/*
*.el
# expex forward references with \gathertags
*-tags.tex
# standalone packages
*.sta
### LaTeX Patch ###
# glossaries
*.glstex
# Version File
*.ver
*.commit
*.branch
# End of https://www.gitignore.io/api/latex

View File

@ -0,0 +1,10 @@
target=specification
.PHONY: $(target).pdf all clean
all: $(target).pdf
$(target).pdf: $(target).tex
latexmk -pdf -pdflatex="pdflatex -interaction=nostopmode -shell-escape" -use-make $^
clean:
latexmk -CA

Binary file not shown.

View File

@ -0,0 +1,172 @@
\documentclass[12pt,a4paper,oneside,notitlepage, numbers=noenddot,openany]{scrreprt}
\usepackage[a4paper]{geometry}
\geometry{verbose,tmargin=2.5cm,bmargin=4.5cm,lmargin=2.5cm,rmargin=2.5cm}
\setlength{\parindent}{0cm}
\usepackage{array}
\usepackage{textcomp}
\usepackage{float}
\usepackage{graphicx}
\usepackage{caption}
%\usepackage{subcaption}
%\usepackage{textgreek}
\usepackage{setspace}
\usepackage{nomencl}
\usepackage{listing}
\usepackage{tabularx}
\PassOptionsToPackage{hyphens}{url}
\usepackage[%
pdftitle={Temperature Profile File Specification},%
pdfauthor={Mario Huettel},%
pdfsubject={},%
pdfcreator={pdflatex, LaTeX with KOMA-Script},%
pdfpagemode=UseOutlines, % Beim Oeffnen Inhaltsverzeichnis anzeigen
pdfdisplaydoctitle=true, % Dokumenttitel statt Dateiname anzeigen.
pdflang=de, % Sprache des Dokuments.
%plainpages=false,
]{hyperref}
\immediate\write18{git describe --always --long --dirty > \jobname.ver}
\immediate\write18{git rev-parse --verify HEAD > \jobname.commit}
\immediate\write18{git rev-parse --abbrev-ref HEAD > \jobname.branch}
\usepackage[automark,headsepline,plainheadsepline,footsepline,plainfootsepline,autooneside=true]{scrlayer-scrpage}
\clearpairofpagestyles
\hypersetup{%
colorlinks=true, % Aktivieren von farbigen Links im Dokument
linkcolor=blue, % Farbe festlegen
citecolor=green,
%filecolor,
%menucolor=black,
%urlcolor=cyan,
bookmarksnumbered=true%, % Überschriftsnummerierung im PDF Inhalt anzeigen.
%hidelinks=false
}
\usepackage{CJKutf8}
\newenvironment{Japanese}{%
\CJKfamily{min}%
\CJKtilde
\CJKnospace}{}
\usepackage{booktabs}
\usepackage{color}
%\usepackage{cite}
\usepackage{blindtext}
\usepackage[utf8]{inputenc}
\usepackage{multicol}
\usepackage{lastpage}
\usepackage[american]{babel}
\usepackage{amssymb}
\usepackage{datetime}
\usepackage[withpage,printonlyused]{acronym}
\usepackage{amsmath}
\usepackage{mathtools}
\usepackage{forloop}
\usepackage{csvsimple}
\usepackage{xspace}
%\setcounter{secnumdepth}{3}
%\setcounter{tocdepth}{3}
%\usepackage{apacite}
%\usepackage{natbib}
%\usepackage[babel,german=quotes]{csquotes}
\usepackage{xspace}
\usepackage{nth}
%\usepackage[backend=biber, style=apa, natbib, bibencoding=utf8]{biblatex}
%
%
%
%\addbibresource{lit.bib}
%\DeclareLanguageMapping{ngerman}{ngerman-apa}
%
\usepackage{enumitem}
\newcounter{reqcount}
\newlist{requirements}{description}{1}
\setlist[requirements,1]{%
before={%
\renewcommand*\thereqcount{\arabic{reqcount}}},
font={\bfseries\stepcounter{reqcount}REQ-\thereqcount:}
}
\newcommand{\newreq}{\bfseries\stepcounter{reqcount}REQ-\thereqcount:~}
\usepackage{xargs} % Use more than one optional parameter in a new commands
\usepackage[colorinlistoftodos,prependcaption,textsize=tiny]{todonotes}
\newcommandx{\unsure}[2][1=]{\todo[noline,linecolor=red,backgroundcolor=red!25,bordercolor=red,#1]{#2}}
\newcommandx{\miscite}[1][1=]{\todo[noline,linecolor=black,backgroundcolor=black!25,bordercolor=black]{Missing citation! #1}}
\newcommandx{\change}[2][1=]{\todo[noline,linecolor=blue,backgroundcolor=blue!25,bordercolor=blue,#1]{#2}}
\newcommandx{\info}[2][1=]{\todo[noline,linecolor=OliveGreen,backgroundcolor=OliveGreen!25,bordercolor=OliveGreen,#1]{#2}}
\newcommandx{\improvement}[2][1=]{\todo[noline,linecolor=Plum,backgroundcolor=Plum!25,bordercolor=Plum,#1]{#2}}
\newcommandx{\thiswillnotshow}[2][1=]{\todo[disable,#1]{#2}}
%Figure, table and listing enumeration style
\captionsetup{labelfont=bf}
\usepackage{chngcntr}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clubpenalty10000
\widowpenalty10000
\displaywidowpenalty10000
%\counterwithout{figure}{part}
\ihead[Spec]{Spec}
\chead[\input{\jobname.ver}]{\input{\jobname.ver}}
\ohead{\headmark}
\ofoot[\pagemark]{\pagemark}
\cfoot[\url{https://git.shimatta.de/mhu/reflow-oven-control-sw}]{\url{https://git.shimatta.de/mhu/reflow-oven-control-sw}}
\setheadsepline{.5pt}
\setfootsepline{.5pt}
\BeforeStartingTOC{\thispagestyle{scrheadings}}
\pagestyle{scrheadings}
\thispagestyle{scrheadings}
\raggedbottom
\begin{document}
\pagenumbering{roman}
\begin{titlepage}
\begin{center}
\begin{figure}[H]
\centering
\resizebox{5cm}{!}{
\includegraphics{img/shimatta-logo}}
\end{figure}
\vspace{10em}
\begin{Huge}
\sffamily\textbf{Temperature Profile File Specification}
\end{Huge}
\vspace{1cm}
\textbf{Version: \input{\jobname.ver}}
\vspace{3em}
\small\texttt{\input{\jobname.commit}/ \input{\jobname.branch}}
\end{center}
\end{titlepage}
\tableofcontents
\newpage
\thispagestyle{scrheadings}
\pagenumbering{arabic}
\chapter{Test}
\end{document}