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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
% \iffalse meta-comment
%
% Copyright (C) 2024 by Agni Datta <agnidatta.org@gmail.com>
%
% This file may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, either version 1.3c 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.3c or later is part of all distributions of LaTeX
% version 2008/05/04 or later.
%
%
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Agni Datta.
%
% This work consists of the files csthm.dtx and csthm.ins
% and the derived file csthm.sty.
%
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{csthm.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{csthm}
%<*package>
[2024/08/31 v1.2 Theorem Environments for Computer Science]
%</package>
%
%<*driver>
\documentclass{ltxdoc}
\usepackage{csthm}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{csthm.dtx}
\PrintChanges
\PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{0}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
% Digits \0\1\2\3\4\5\6\7\8\9
% Exclamation \! Double quote \" Hash (number) \#
% Dollar \$ Percent \% Ampersand \&
% Acute accent \' Left paren \( Right paren \)
% Asterisk \* Plus \+ Comma \,
% Minus \- Point \. Solidus \/
% Colon \: Semicolon \; Less than \<
% Equals \= Greater than \> Question mark \?
% Commercial at \@ Left bracket \[ Backslash \\
% Right bracket \] Circumflex \^ Underscore \_
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
%
% \changes{v1.0}{2024/08/31}{Initial version}
% \changes{v1.1}{2024/08/31}{Added cleveref support}
% \changes{v1.2}{2024/08/31}{Improved documentation and code structure}
%
% \DoNotIndex{\newcommand,\newenvironment}
%
% \providecommand*{\url}{\texttt}
% \GetFileInfo{csthm.dtx}
% \title{The \textsf{csthm} package}
% \author{Agni Datta \\ \url{agnidatta.org@gmail.com}}
% \date{\filedate}
%
% \maketitle
%
% \section{Introduction}
%
% This package provides customized theorem-like environments specifically designed for computer science documents. It offers a set of pre-defined theorem styles and environments to streamline the creation of theorems, definitions, remarks, and other common structures in computer science papers and documents.
%
% \section{Usage}
%
% Load the package with:
% \begin{verbatim}
% \usepackage{csthm}
% \end{verbatim}
%
% To use the package with cleveref support:
% \begin{verbatim}
% \usepackage[cleveref]{csthm}
% \end{verbatim}
%
% \section{Implementation}
%
% \begin{macrocode}
%<*package>
% Package options
\newif\if@csthm@loadcleveref
\DeclareOption{cleveref}{\@csthm@loadclevereftrue}
\ProcessOptions\relax
% Required packages
\RequirePackage{amsmath}
\RequirePackage{amssymb}
\RequirePackage{amsthm}
\RequirePackage{enumitem}
\RequirePackage{thmtools}
% Conditionally load cleveref if the option is set and hyperref is loaded
\if@csthm@loadcleveref
\AtBeginDocument{%
\@ifpackageloaded{hyperref}{%
\RequirePackage{cleveref}
}{%
\PackageWarning{csthm}{The 'cleveref' option was set, but 'hyperref' is not loaded. Skipping 'cleveref' loading.}
}%
}
\fi
% Define theorem styles
\declaretheoremstyle[
spaceabove=\topsep,
spacebelow=\topsep,
headfont=\scshape,
notefont=\scshape,
bodyfont=\normalfont,
postheadspace=5pt,
numberwithin=section,
qed=$\scriptstyle\star$,
headpunct={.}
]{thmstyle}
\declaretheoremstyle[
spaceabove=\topsep,
spacebelow=\topsep,
headfont=\bfseries,
notefont=\bfseries,
bodyfont=\normalfont,
postheadspace=5pt,
numberwithin=section,
qed=$\scriptstyle\maltese$,
headpunct={.}
]{defstyle}
\declaretheoremstyle[
spaceabove=\topsep,
spacebelow=\topsep,
headfont=\itshape,
notefont=\itshape,
bodyfont=\normalfont,
postheadspace=5pt,
numberwithin=section,
qed=$\scriptstyle\maltese$,
headpunct={.}
]{remarkstyle}
\declaretheoremstyle[
spaceabove=\topsep,
spacebelow=\topsep,
headfont=\sffamily\scshape,
notefont=\sffamily\scshape,
bodyfont=\normalfont\sffamily,
postheadspace=5pt,
numberwithin=section,
qed=$\scriptstyle\maltese$,
headpunct={.}
]{hltstyle}
% Define theorem environments
\declaretheorem[style=thmstyle,name=Theorem]{theorem}
\declaretheorem[style=defstyle,sibling=theorem]{fact}
\declaretheorem[style=thmstyle,sibling=theorem]{assumption}
\declaretheorem[style=thmstyle,sibling=theorem]{claim}
\declaretheorem[style=thmstyle,sibling=theorem]{conjecture}
\declaretheorem[style=thmstyle,sibling=theorem]{corollary}
\declaretheorem[style=thmstyle,sibling=theorem]{lemma}
\declaretheorem[style=thmstyle,sibling=theorem]{property}
\declaretheorem[style=thmstyle,sibling=theorem]{proposition}
% Define definition environments
\declaretheorem[style=defstyle,sibling=theorem]{definition}
\declaretheorem[style=defstyle,sibling=theorem]{example}
\declaretheorem[style=defstyle,sibling=theorem]{exercise}
\declaretheorem[style=defstyle,sibling=theorem]{problem}
\declaretheorem[style=defstyle,sibling=theorem]{question}
% Define remark environments
\declaretheorem[style=remarkstyle,sibling=theorem]{note}
\declaretheorem[style=remarkstyle,sibling=theorem]{remark}
\declaretheorem[style=remarkstyle,sibling=theorem]{solution}
% Define highlight environments
\declaretheorem[style=hltstyle,name=Important]{important}
\declaretheorem[style=hltstyle]{highlight}
\declaretheorem[style=hltstyle]{keypoint}
% Define case environment
\newlist{caseList}{enumerate}{1}
\setlist[caseList]{label=\textbf{Case~\arabic*:},leftmargin=*}
\NewDocumentEnvironment{case}{O{}}{%
\begin{caseList}[#1]%
}{%
\end{caseList}%
}
% Define axiom environment
\newlist{axiomList}{enumerate}{1}
\setlist[axiomList]{label=\textbf{Axiom~\Alph*:}, leftmargin=*}
\NewDocumentEnvironment{axiom}{O{}}{%
\begin{axiomList}[#1]%
}{%
\end{axiomList}%
}
% Custom QED symbol
\renewcommand\qedsymbol{$\scriptstyle\blacksquare$}
% Define accent color (customizable by the user)
\providecommand{\accentcolor}{black}
% Package documentation commands
\providecommand{\csthmpkg}{\textsf{csthm}}
\providecommand{\email}[1]{\href{mailto:#1}{\texttt{#1}}}
% User-level commands for customization
\newcommand{\setaccentcolor}[1]{\renewcommand{\accentcolor}{#1}}
%</package>
% \end{macrocode}
%
% \Finale
\endinput
|
