summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/didec/didec.doc.sty
blob: 0e5944e43fd217350ae5bbc44d06c580d2dc3167 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
% !TeX root = didec.tex
% !TeX encoding=UTF-8
%% The LaTeX package didec - version 1.0.0 (2024/02/28)
%% didec.doc.sty: style file for the documentation
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2024-2024 by Prof. Dr. Dr. Thomas F. Sturm <thomas dot sturm at unibw dot de>
%% -------------------------------------------------------------------------------------------
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%   http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This work has the LPPL maintenance status `author-maintained'.
%%
%% This work consists of all files listed in README.md
%%
% include file (style) of didec.tex (manual of the LaTeX package didec)

\def\version{1.0.0}%
\def\datum{2024/02/28}%

\IfFileExists{didec.doc.cfg}{\input{didec.doc.cfg}}{}

\renewcommand*\l@subsection{\@dottedtocline{2}{1.5em}{2.7em}}
\renewcommand*\l@subsubsection{\@dottedtocline{3}{4.2em}{3.2em}}

\RequirePackage[T1]{fontenc}
\RequirePackage[english]{babel}
\RequirePackage{lmodern,parskip,array}
\RequirePackage[svgnames,table]{xcolor}
\RequirePackage{tikz}
\RequirePackage{varioref}
\RequirePackage[makeindex]{imakeidx}
\RequirePackage[bookmarks,raiselinks,pageanchor,hyperindex,colorlinks]{hyperref}
\RequirePackage{cleveref}
\RequirePackage{varwidth,incgraph}
\RequirePackage[official]{eurosym}

\RequirePackage[a4paper,left=2.5cm,right=2.5cm,top=1.5cm,bottom=1.5cm,
    marginparsep=3mm,marginparwidth=18mm,
    headheight=0mm,headsep=0cm,
    footskip=1.5cm,includeheadfoot%,showframe
    ]{geometry}
\RequirePackage{fancyhdr}
\fancyhf{}
\fancyfoot[C]{\thepage}%
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0pt}
\pagestyle{fancy}
\tolerance=2000%
\setlength{\emergencystretch}{20pt}%

\RequirePackage{array,tabularx,booktabs}
\RequirePackage{lipsum}
\RequirePackage[extendedchars,encoding,filenameencoding=utf-8]{grffile}
\RequirePackage{siunitx,xfp}

\RequirePackage{tcolorbox}
\tcbuselibrary{skins,minted,breakable,documentation,raster}

\ifdefined\didecpackageprefix
  \RequirePackage{\didecpackageprefix didec}
\else
  \RequirePackage{didec}
\fi

\definecolor{Green_Dark}{rgb}{0.078431,0.407843,0.176471}
\definecolor{Blue_Dark}{rgb}{0.090196,0.211765,0.364706}
\definecolor{Blue_Bright}{rgb}{0.858824,0.898039,0.945098}

\colorlet{Blue_Gray}{blue!50!gray}

\tcbset{skin=enhanced,
  doc head={colback=yellow!10!white,interior style=fill},
  doc head key={colback=magenta!5!white,interior style=fill},
  color key=DarkViolet,
  color value=Teal,
  color color=Teal,
  color counter=Orange!85!black,
  color length=Orange!85!black,
  index colorize,
  index annotate,
  beforeafter example/.style={
    before skip=4pt plus 2pt minus 1pt,
    after skip=8pt plus 4pt minus 2pt
  },
  docexample/.style={bicolor,
    beforeafter example,
    arc=0.66mm,
    boxrule=0.33mm,
    fonttitle=\bfseries,
    fontlower=\footnotesize,
    colframe=Blue_Gray,
    colback=Blue_Gray!5!white,
    colbacklower=white,
    drop small lifted shadow,
    listing engine=minted,
    documentation minted options={tabsize=2,fontsize=\small,breaklines,autogobble},
    documentation minted style=colorful,
    },
}
\urlstyle{sf}

\newtcblisting{fullexample}[1]{docexample,minted style=colorful,
  listing and comment,pdf comment,freeze pdf,compilable listing,#1}

\DeclareTotalTCBox{\myverb}{ O{} v }{tile,fontupper=\ttfamily,nobeforeafter,
  tcbox raise base,boxsep=0.5mm,top=0pt,bottom=0pt,left=0pt,right=0pt,boxrule=0.3mm,
  colback=yellow!10,
  borderline horizontal={0.3mm}{0pt}{red!50},
  #1}{#2}

\renewcommand*{\tcbdocnew}[1]{\textcolor{green!50!black}{\sffamily\bfseries N} #1}
\renewcommand*{\tcbdocupdated}[1]{\textcolor{blue!75!black}{\sffamily\bfseries U} #1}

\newcommand{\formatPackageOption}[1]{package option}
\newcommand{\formatPackageOptions}[1]{Package options}

\tcbmakedocSubKey[doc key prefix=]{docDidecKey}{didec}
\tcbmakedocSubKeys[doc key prefix=]{docDidecKeys}{didec}
\tcbmakedocSubKey[doc key prefix=,
    index key formatter=\formatPackageOption,
    index keys formatter=\formatPackageOptions
]{docPackageOption}{didec}
\tcbmakedocSubKeys[doc key prefix=,
    index key formatter=\formatPackageOption,
    index keys formatter=\formatPackageOptions
]{docPackageOptions}{didec}


\tcbset{
  deprecated*/.style={%
    doc head={colback=black!1!white,interior style=fill},
    doc head key={colback=black!3!white,interior style=fill},
    color command={black!80!white},
    color option={black!60!white},
  },
  deprecated/.style={%
    deprecated*,
    before doc body command={\textcolor{black!80!white}{\textsc{Deprecated! }}}
  },
}

\ExplSyntaxOn
\NewDocumentCommand \docColorExample { m }
  {
    \color_group_begin:
    \color_select:n { #1 }
    \rule[-1mm]{5mm}{4mm}~\docColor{#1}
    \color_group_end:
  }
\ExplSyntaxOff