summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dbshow/dbshow-doc.tex
blob: 02332a125755101d271e4d03db2995b0d29b2ec0 (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
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
\documentclass[full]{l3doc}
\usepackage[scheme=plain]{ctex}
\usepackage{zhlineskip}
\usepackage{enumitem}
\usepackage{indentfirst}
\usepackage{titling}
\usepackage{geometry}
\usepackage{tabularray}
\usepackage{xcolor}
\usepackage{tcolorbox}
\tcbuselibrary{listings, skins, raster, breakable}
\usepackage{tabularray}

\IndexPrologue
  {
    \section*{Index}
    \markboth{Index}{Index}
    \addcontentsline{toc}{section}{Index}
    The~italic~numbers~denote~the~pages~where~the~
    corresponding~entry~is~described,~
    numbers~underlined~point~to~the~definition,~
    all~others~indicate~the~places~where~it~is~used.
  }

\newcommand\tikzmark[1]{\tikz \coordinate[overlay, remember picture] (#1);}

\geometry{
  left=4.5cm,
  right=2cm,
  top=2cm,
  bottom=2cm,
}
\hypersetup {
  CJKbookmarks,
  bookmarksopen,
  bookmarksopenlevel=3,
  pdfstartview=FitH,
  pdfinfo = {
   Title = The package 'dbshow' ,
   Subject = A LaTeX package ,
   Author = Li Changkai
 }
}

\DoNotIndex{\begin, \end}
\setlength{\parskip}{\medskipamount}
\DeclareDocumentEnvironment { note } { +b } {
  \par\textbf{\textsf{NOTE:~}}#1\par
} {}

\AtEndDocument{
  \newgeometry{
    left=2cm,
    right=2cm,
    top=2cm,
    bottom=2cm
  }
  \PrintIndex
}

\ExplSyntaxOn
\NewDocumentCommand { \strcs } { m } {
  \texttt{\tl_to_str:n { #1 }}
}

\dim_new:N \l__my_syntax_dim
\box_new:N \g__my_syntax_box
\NewDocumentEnvironment { Syntax } { s }
  {
    \dim_set:Nn \l__my_syntax_dim
      { \textwidth }
    \hbox_gset:Nw \g__my_syntax_box
      \small \ttfamily
      \begin{minipage}[t]{\l__my_syntax_dim}
        \raggedright\obeyspaces\obeylines
  }
  {
      \end{minipage}
    \hbox_gset_end:
    \IfValueF { #1 } { \smallskip }
    \box_use_drop:N \g__my_syntax_box
    \smallskip
  }

\DeclareDocumentEnvironment { Description } { o +b } {
  \hbox_set:Nn \l_tmpa_box { #1 }
  \dim_set:Nn \l_tmpa_dim { \box_wd:N \l_tmpa_box }
  \begin{itemize}[labelwidth=\l_tmpa_dim, align=left]
    #2
  \end{itemize}
} {  }

\keys_define:nn { dbshow/doc } {
  opt .tl_set:N = \l_opt_tl,
  desc .tl_set:N = \l_desc_tl,
  init .tl_set:N = \l_init_tl,
  init .initial:n = init-none,
}

\box_new:N \l__option_box
\NewDocumentEnvironment { option } { m +b } {
  \keys_set:nn { dbshow/doc } { #1 }
  \hbox_set:Nw \l__option_box
    \small \ttfamily
    \begin{minipage}[t]{\textwidth}
      \obeyspaces\obeylines
      \textcolor{red}{
        \l_opt_tl
        \exp_args:Nx\SpecialOptionIndex{\l_opt_tl}
      }
      {~}\l_desc_tl
      \hfill(
      \tl_if_eq:NnTF \l_init_tl { init-none } { no~value }
        { initially~\texttt{\l_init_tl} }
      )
    \end{minipage}
  \hbox_gset_end:
  \box_use_drop:N \l__option_box
  #2
  \medskip
} {  }

\DeclareDocumentCommand \opt { O{} m }
  { \__codedoc_cmd:no {#1} { #2 } }
\ExplSyntaxOff


\begin{document}
\title{
  \pkg{dbshow} 宏包
  \protect\footnote{\url{https://github.com/ZhiyuanLck/dbshow}}
  \rlap{\makebox[4cm][r]{
    \normalsize $\Longrightarrow$ \color{red}
    \protect\hyperlink{en}{English Version}
    \protect\hypertarget{zh}{}
  }}
}
\author{\textit{李昌锴} \texttt{<lichangkai225@qq.com>}}
\date{2022年1月7日}
\maketitle

\tableofcontents

\begin{documentation}

\section{引言}
编写本宏包的动机来源于当前没有一个很好的错题本宏包,可以方便的根据各种条件对错
题进行筛选、排序,然后以自定义的样式展示出来。\pkg{dbshow} 宏包实现了四个核心
功能:数据存储和使用、数据筛选、数据排序、数据展示。

数据只需要存储一次,就可以通过预定义的筛选、排序条件和样式展示部分或全部的数据。
如上所述,本宏包其实实现了一个非常简单的数据库,复习错题的功能只是其中一个应用,
和其他数据库宏包比如 \pkg{datatool} 相比,\pkg{dbshow} 更专注于非图表类型的数
据展示。

宏包基于 \pkg{expl3} 的基础类型构建了6种类型:
\begin{Description}[\texttt{clist}]
  \item[\texttt{date}]
    基于宏包 \pkg{datetime2} 的日期类型,以iso标准存储,支持大小比较,排序(转
    换成字符串)。默认值为 \cs{Today}。
  \item[\texttt{str}]
    字符串类型,支持正则匹配,英文排序。默认值为空。
  \item[\texttt{tl}]
    \meta{token list}类型,支持正则匹配。默认值为空。
  \item[\texttt{int}]
    整数类型,支持大小比较,排序。默认值为0。
  \item[\texttt{fp}]
    浮点数类型,支持大小比较,排序。默认值为0。
  \item[\texttt{clist}]
    逗号分隔的列表类型。默认值为空列表。
\end{Description}

\section{接口文档}
\subsection{\cs{dbNewDatabase}}
\begin{function}{\dbNewDatabase, \dbNewDatabase*}
  \begin{syntax}
    \cs{dbNewDatabase} \oarg{base database} \marg{database} \{ \\
    ~~\meta{attr1} = \meta{type spec1}, \\
    ~~\meta{attr2} = \meta{type spec2}, \\
    ~~\ldots{} \\
    \} \\
    \cs{dbNewDatabase}* \marg{database} \{ \\
    ~~\meta{attr1} = \meta{type spec1}, \\
    ~~\meta{attr2} = \meta{type spec2}, \\
    ~~\ldots{} \\
    \} \\
  \end{syntax}

\end{function}

  新建一个数据库,不带星号的版本可以指定一个数据库来继承其属性设置,该版本总是
  会舍弃掉之前的定义。

  带星号的版本不会舍弃之前已有的定义,而是将新的选项添加到后面。

  \meta{attr} 为属性名称,\meta{type spec} 负责声明属性类型和属性默认值:

  \noindent\begin{tblr}{
    colspec = {ll},
    column{1} = {font = \ttfamily}
  }
    \meta{attr} = \meta{type} &
    将 \meta{attr} 声明为 \meta{type} 类型 \\
    \meta{attr} = \meta{type}\textbar\meta{default} &
    将 \meta{attr} 声明为 \meta{type} 类型,并且将默认值设置为 \meta{default}。
    \\
  \end{tblr}

  \begin{note}
    每个数据库都有一个默认的属性 |id| 用来存储数据的索引。
  \end{note}

  下面是定义一个错题数据库的示例,|question| 和 |answer| 属性用来存储问题和答
  案,|date| 属性存储日期,|info| 属性存储额外信息,|labels| 存储题目标签。
\begin{verbatim}
  \dbNewDatabase{ques}{
    question = tl,
    answer = tl,
    date = date,
    info = tl,
    labels = clist
  }
\end{verbatim}

\subsection{\cs{dbNewStyle} 和样式选项}

\begin{function}{\dbNewStyle}
  \begin{syntax}
    \cs{dbNewStyle} \oarg{base styles} \marg{style} \marg{database} \marg{opts}
  \end{syntax}

  为 \meta{database} 定义一个新的样式 \meta{style},该样式可以基于已有的样式
  \meta{base styles},比如 |\dbNewStyle[base1, base2]{new-style}{ques}{}|。
\end{function}

\bigskip

\begin{option}{opt=filter, desc={= \meta{filter}}, init=-none-}
  为当前样式设置由 \cs{dbCombineFilters} 所定义的过滤器
\end{option}

\begin{option}{opt=raw-filter, desc={= \meta{cond combination}}}
  用已定义的条件为当前样式设置匿名过滤器。下面两个例子的作用是等同的。
\end{option}

\begin{verbatim}
  % method 1
  \begin{dbFilters}{db}
    \dbNewConditional{cond1}{int-attr}{\rval > 1}
    \dbNewConditional*{cond2}{str-attr}{\d+}
  \end{dbFilters}
  \dbNewStyle{style}{db}{raw-filter={cond1 && cond2}}
  % method 2
  \begin{dbFilters}{db}
    \dbNewConditional{cond1}{int-attr}{\rval > 1}
    \dbNewConditional*{cond2}{str-attr}{\d+}
    \dbCombineFilters{filter}{cond1 && cond2}
  \end{dbFilters}
  \dbNewStyle{style}{db}{filter=filter}
\end{verbatim}

\begin{option}{
  opt = sort,
  desc = {= \{ \meta{attr spec1}, \meta{attr spec2}, \ldots{} \}},
}
  为当前样式设置排序规则。支持根据 |str|,|date|,|int|,|fp| 类型的数据进行排
  序,支持多级排序。\meta{attr} 表示增序,\meta{attr}* 表示降序。下面例子中,
  使用 |sort-style| 展示数据时的顺序为先按 |level| 降序,|level| 相同的再按出
  生日期 |birth| 增序,以此类推。
\end{option}

\begin{verbatim}
  \dbNewDatabase{sort-example}{
    name = str,
    birth = date,
    level = int,
    weight = fp,
  }
  \dbNewStyle{sort-style}{sort-example}{
    sort = { level*, birth, name, weight }
  }
\end{verbatim}

\begin{option}{
  opt = before-code,
  desc = {= \meta{before code}}
}
  该选项用来设置在展示整个数据库之前需要执行的代码。
\end{option}

\begin{option}{
  opt = after-code,
  desc = {= \meta{after code}}
}
  该选项用来设置在展示整个数据库之后需要执行的代码。
\end{option}

\begin{option}{
  opt = item-code,
  desc = {= \meta{item code}}
}
  该选项用来设置展示数据库中每条记录的代码。你可以使用 \cs{dbuse} 来展示属性的
  值。
\end{option}

\begin{option}{
  opt = {\meta{attr}/before-code},
  desc = {= \meta{before code}}
}
  该选项用来设置展示数据库中属性 \meta{attr} 对应数据之前需要执行的代码。
  \cs{dbuse} 会在展示属性数据前执行此代码。
\end{option}

\begin{option}{
  opt = {\meta{attr}/after-code},
  desc = {= \meta{after code}}
}
  该选项用来设置展示数据库中属性 \meta{attr} 对应数据之后需要执行的代码。
  \cs{dbuse} 会在展示属性数据后执行此代码。
\end{option}

\begin{option}{
  opt = {\meta{attr}/sep},
  desc = {= \meta{sep spec}},
  init = {,~\~}
}
\begin{Syntax}
  \meta{attr}/sep = \meta{separator} \\
  \meta{attr}/sep = \{ \\
  ~~\meta{separator between two}, \\
  ~~\meta{separator between more than two}, \\
  ~~\meta{separator between final two} \\
  \}
\end{Syntax}

  该选项只适用于类型为 |clist| 的属性,用来设置列表间元素的间隔。第一个版本接
  受一个参数,将所有的元素间隔设置为 \meta{separator}。第二个版本接受逗号分隔
  的三个参数,分别用来设置只有两个元素时的分隔符 \meta{separator between two},
  超过两个元素时的分隔符 \meta{separator between more than two},和最后两个元
  素之间的分隔符 \meta{separator between final two}。

\end{option}

\begin{option}{
  opt = item-before-code,
  desc = {= \meta{before code}}
}
  该选项只适用于类型为 |clist| 的属性,用来设置展示列表每个元素前需要执行的代
  码。
\end{option}

\begin{option}{
  opt = item-after-code,
  desc = {= \meta{after code}}
}
  该选项只适用于类型为 |clist| 的属性,用来设置展示列表每个元素后需要执行的代
  码。
\end{option}

\subsection{使用 \cs{dbNewReviewPoints} 定义复习点}

\begin{function}{\dbNewReviewPoints}
  \begin{syntax}
    \cs{dbNewReviewPoints} \marg{name} \marg{points}
  \end{syntax}

  定义名为 \meta{name} 的复习点。这是专门为错题本或复习所定制的功能,
  \meta{points}是一系列整数,现在假设每道错题你都将写错时的日期记录在了 |date|
  属性中,并且你希望每隔2,5,15天复习一次。下面的代码给出了一个实现示例。
\begin{verbatim}
  \dbNewReviewPoints{review-point}{2, 5, 15}            % 定义复习点
  \begin{dbFilters}
    \dbNewConditional{cond1}{date}{review-point|\Today} % 定义复习条件
    \dbCombineConditionals{filter1}{cond1}              % 定义过滤器
  \end{dbFilters}
  \dbNewStyle{review-style}{ques}{filter=filter1}       % 定义展示样式
\end{verbatim}
\end{function}

\subsection{在 \env{dbFilters} 环境中定义过滤器}

\noindent\DescribeEnv{dbFilters}
\begin{Syntax}*
  |\begin{dbFilters}|\marg{database} \\
  ~~\meta{code}
  |\end{dbFilters}| \\
\end{Syntax}

\env{dbFilters}用来定义过滤器,此环境中定义了 \cs{dbNewConditional} 命令用来定
义条件和 \cs{dbCombineConditionals} 命令用来组合条件定义过滤器。过滤器独立于每
个 \meta{database},这意味着你可以在不同数据库中定义名称相同的过滤条件和过滤器。

\begin{function}{\dbNewConditional, \dbNewConditional*}
  \begin{syntax}
    \cs{dbNewConditional}  \marg{name}        \marg{attr} \marg{cond spec} \\
    \cs{dbNewConditional}* \marg{name}        \marg{attr} \marg{cond spec} \\[2pt]
    \cs{dbNewConditional}  \marg{name} \marg{int/fp attr} \marg{relation} \\
    \cs{dbNewConditional}* \marg{name} \marg{int/fp attr} \marg{relation} \\
    \cs{dbNewConditional}  \marg{name} \marg{str/tl attr} \marg{regex expr} \\
    \cs{dbNewConditional}* \marg{name} \marg{str/tl attr} \marg{regex expr} \\
    \cs{dbNewConditional}  \marg{name}  \marg{clist attr} \marg{val list} \\
    \cs{dbNewConditional}* \marg{name}  \marg{clist attr} \marg{val list} \\
    \cs{dbNewConditional}  \marg{name}   \marg{date attr} \{\meta{review points}\textbar\meta{date}\} \\
    \cs{dbNewConditional}* \marg{name}   \marg{date attr} \marg{relation}
  \end{syntax}

  \cs{dbNewConditional} 用来定义名为 \meta{name} 的条件,\meta{attr} 指定条件
  所绑定的属性,在 \meta{cond spec} 中可以用 \cs{dbval} 指代属性的值。
\end{function}

  对于类型为 |int| 和 |fp| 的属性,两个版本的定义是一致的,\meta{relation} 可
  以是单个关系式,比如 |\dbval > 3|,也可以是组合关系式,比如
  |\dbval > 3 && \dbval < 10.2|。支持的操作符有 |<, >, =, ==, !=, >=, <=, !|。

  对于类型为 |str| 和 |tl| 的属性,\meta{regex} 为正则表达式,
  \cs{dbNewConditional} 表示部分匹配,\cs{dbNewConditional*} 表示整体匹配。
\begin{verbatim}
  \dbNewConditional{cond1}{str-attr}{abc}  % 匹配 abc, abcd, 1abc, =abc= 等
  \dbNewConditional*{cond2}{str-attr}{abc} % 只匹配 abc
\end{verbatim}

  对于类型为 |clist| 的属性,使用 \cs{dbNewConditional} 定义的条件只要
  \meta{val list} 中的任意一个元素在属性值(列表)中则条件成立;使用
  \cs{dbNewConditional*} 定义的条件只有 \meta{val list} 中每一个值都在属性值
  (列表)中条件才成立。

\begin{verbatim}
  \dbNewConditional{cond1}{clist-attr}{a, b, c}  % a, b, d 满足条件
  \dbNewConditional*{cond2}{clist-attr}{a, b, c} % a, b, d 不满足条件
\end{verbatim}

  对于类型为 |date| 的属性,\cs{dbNewConditional} 使用复习点来定义过滤条件,
  \meta{review points} 是 \cs{dbNewReviewPoints} 定义的复习点,\meta{date} 是
  用来比较的日期;\cs{dbNewConditional*} 使用\textbf{单个}关系式来定义过滤条件。
  支持的操作符有 |<, >, =, ==, !=, >=, <=|。

\begin{function}{\dbCombineConditionals}
  \begin{syntax}
    \cs{dbCombineConditionals} \marg{name} \marg{cond combination} \oarg{info}
  \end{syntax}

  \cs{dbCombineConditionals} 定义名为 \marg{name} 的过滤器,并将
  \cs{dbNewConditional} 定义的条件组合起来,比如
  \verb=\dbCombineConditionals{filter}{(cond1 && cond2) || !cond3}=。
  \meta{cond combination} 中可以使用的关系操作符为 \verb=&&, ||, !=。
  可以将 \opt{filter} 选项设置为 \meta{name} 来应用过滤器。\meta{info} 为过滤
  器的相关信息,在展示数据库的时候可以用 \cs{dbFilterInfo} 指代。
\end{function}

\subsection{使用 \env{dbitem} 环境存储数据}

\noindent\DescribeEnv{dbitem}
\begin{Syntax}*
  |\begin{dbitem}|\marg{database}[ \\
  ~~\meta{attr1} = \meta{val1}, \\
  ~~\meta{attr2} = \meta{val2}, \\
  ~~\ldots{} \\
  ] \\
  ~~\meta{code} \\
  |\end{dbitem}|
\end{Syntax}

  \env{dbitem} 环境用来存储数据。有两种存储数据的方法,较短的数据可以在选项列
  表中通过键值对设置值,较长的数据可以在 \meta{code} 中使用 \cs{dbsave} 存储。
  \cs{dbsave}会覆盖选项中设置的值。没有设置的值将会被设置为全局默认值,下面给
  出一个存储示例。

\begin{verbatim}
  \begin{dbitem}[date=2022-01-01, info=测试]
    \dbsave{question}{这是一个测试问题}
    \dbsave{answer}{这是一个测试答案}
  \end{dbitem}
\end{verbatim}

\subsection{\cs{dbsave} 和 \cs{dbuse}}

\begin{function}{\dbsave, \dbuse}
  \begin{syntax}
    \cs{dbsave} \marg{attr} \marg{data} \\
    \cs{dbuse}  \marg{attr} \\
  \end{syntax}

  \cs{dbsave} 用来存储数据,只能在 \env{item} 环境中使用。\cs{dbuse} 用来使用
  数据,只能在 \opt{item-code} 选项中使用。
\end{function}

\subsection{使用 \cs{dbshow} 展示数据库}

\begin{function}{\dbshow}
  \begin{syntax}
    \cs{dbshow} \marg{style} \marg{database}
  \end{syntax}

  使用 \meta{style} 样式来展示 \meta{database}。
\end{function}

\subsection{条件判别式}

\begin{function}{\dbIfEmptyT, \dbIfEmptyF, \dbIfEmptyTF}
  \begin{syntax}
    \cs{dbIfEmptyTF} \marg{true code} \marg{false code} \\
    \cs{dbIfEmptyT} \marg{true code} \\
    \cs{dbIfEmptyF} \marg{false code}
  \end{syntax}

  该判别式用来判断当前数据库是否为空。下面的示例展示了如何预防空的列表环境。
\end{function}

\begin{verbatim}
  \dbNewStyle{style-cond1}{database-test}{
    before-code = {\dbIfEmptyF{\begin{enumerate}}},
    after-code = {\dbIfEmptyF{\end{enumerate}}},
    item-code = {\item \dbuse{attr-test}}
  }
\end{verbatim}

\begin{function}{\dbItemIfEmptyT, \dbItemIfEmptyF, \dbItemIfEmptyTF}
  \begin{syntax}
    \cs{dbItemIfEmptyTF} \marg{true code} \marg{false code} \\
    \cs{dbItemIfEmptyT} \marg{true code} \\
    \cs{dbItemIfEmptyF} \marg{false code}
  \end{syntax}

  该判别式用来判断当前元素是否为空。下面的示例展示了如何在展示 |database-test|
  数据库中 |text| 属性的元素时在元素非空的时候前后都加上 |*|。
\end{function}

\begin{verbatim}
  \dbNewStyle{style-cond2}{database-test}{
    text/before-code = {\dbItemIfEmptyF{*}},
    text/after-code = {\dbItemIfEmptyF{*}},
  }
\end{verbatim}

\begin{function}{\dbClistItemIfEmptyT, \dbClistItemIfEmptyF, \dbClistItemIfEmptyTF}
  \begin{syntax}
    \cs{dbClistItemIfEmptyTF} \marg{true code} \marg{false code} \\
    \cs{dbClistItemIfEmptyT} \marg{true code} \\
    \cs{dbClistItemIfEmptyF} \marg{false code}
  \end{syntax}

  该判别式用来判断列表属性中的元素是否为空。下面的示例展示了如何在展示
  |database-test| 数据库中 |labels| 属性(标签列表)的元素时在标签非空的时候前
  后都加上 |*|。
\end{function}

\begin{verbatim}
  \dbNewDatabase{database-test}{labels=clist}
  \dbNewStyle{style-cond3}{database-test}{
    labels/item-before-code = {\dbClistItemIfEmptyF{*}},
    labels/item-after-code = {\dbClistItemIfEmptyF{*}},
  }
\end{verbatim}

\subsection{特殊命令}

\pkg{dbshow} 定义了一些特殊的命令,会根据语境展开为不同的内容。

\DescribeMacro{\dbval}当前属性的值,只能在 \cs{dbNewConditional} 中使用

\DescribeMacro{\dbDatabase}数据库名称

\DescribeMacro{\dbFilterName}过滤器名称

\DescribeMacro{\dbFilterInfo}过滤器信息

\DescribeMacro{\dbIndex}原始数据索引,等同于 |\dbuse{id}| 但是 \cs{dbuse} 是不可展开的

\DescribeMacro{\dbarabic}用数字表示的查询集数据计数

\DescribeMacro{\dbalph}用小写字母表示的查询集数据计数

\DescribeMacro{\dbAlph}用小写字母表示的查询集数据计数

\DescribeMacro{\dbroman}用小写罗马数字表示的查询集数据计数

\DescribeMacro{\dbRoman}用大写罗马数字表示的查询集数据计数

\section{错题本示例}
见第 \ref{sec:example} 节。

\title{
  Package \pkg{dbshow}
  \protect\footnote{\url{https://github.com/ZhiyuanLck/dbshow}}
  \rlap{\makebox[4cm][r]{
    \normalsize $\Longrightarrow$ \color{red}
    \protect\hyperlink{zh}{中文版本}
    \protect\hypertarget{en}{}
  }}
}
\author{Li Changkai \texttt{<lichangkai225@qq.com>}}
\date{2022/01/07}
\maketitle

\section{Introduction}

The initial motivation to write this package is that I want to write a
template, which can collect questions you gave the wrong answer and can
display those questions you would like to review by some conditionals, such as
questions with certain label, questions you have answered uncorrectly for
certain times or questions having not been reviewed for certain days. So this
package provides a database to do such thing.

The package provides four core functions: data storage and display, data
filtering, data sorting and data display. All data is saved once and then you
can display these data with custom filters, orders and styles.

The package constructs 6 types based on the internal typed of \pkg{expl3}:
\begin{Description}[\texttt{clist}]
  \item[\texttt{date}]
    date based on \pkg{datetime2} in iso format, supports comparison,
    sorting (converting to |str|), default \cs{Today}.
  \item[\texttt{str}]
    string,supports regex match and sorting, default empty.
  \item[\texttt{tl}]
    token list, supports regex match, default empty.
  \item[\texttt{int}]
    integer, supports comparison and sorting, default 0.
  \item[\texttt{fp}]
    floating point, supports comparison and sorting, default 0.
  \item[\texttt{clist}]
    comma list, default empty.
\end{Description}

\section{Interfaces}

\subsection{\cs{dbNewDatabase}}

\begin{function}{\dbNewDatabase, \dbNewDatabase*}
  \begin{syntax}
    \cs{dbNewDatabase} \oarg{base database} \marg{database} \{ \\
    ~~\meta{attr1} = \meta{type spec1}, \\
    ~~\meta{attr2} = \meta{type spec2}, \\
    ~~\ldots{} \\
    \} \\
    \cs{dbNewDatabase}* \marg{database} \{ \\
    ~~\meta{attr1} = \meta{type spec1}, \\
    ~~\meta{attr2} = \meta{type spec2}, \\
    ~~\ldots{} \\
    \} \\
  \end{syntax}

\end{function}

Create a new database named \meta{database}, unstarred form provides the optional
\meta{base database} from which current database inherit the attributes settings.
The unstarred form always replace the old definition, while starred form
appends the new options.

\begin{Syntax}
  \meta{attr} = \meta{type} \\
  \meta{attr} = \meta{type}\textbar\meta{default}
\end{Syntax}

The first form defines the \meta{attr} as \meta{type}, and the second also
sets the default value.

\begin{note}
  Every database has a default attribute |id| to store the index of the item.
\end{note}

The example below define a database named |ques|.
\begin{verbatim}
  \dbNewDatabase{ques}{
    question = tl, % store question
    answer = tl,   % store corresponding answer
    date = date,   % store the date when you were wrong
    info = tl,     % store extra info
    labels = clist % store question labels
  }
\end{verbatim}

\subsection{\cs{dbNewStyle} and Style Options}

\begin{function}{\dbNewStyle}
  \begin{syntax}
    \cs{dbNewStyle} \oarg{base styles} \marg{style} \marg{database} \marg{opts}
  \end{syntax}

Define a new \meta{style} that binds to \meta{database}. The style can inherit
from a list of \meta{base styles} such as
|\dbNewStyle[base1, base2]{new-style}{ques}{}|.
\end{function}

\bigskip

\begin{option}{opt=filter, desc={= \meta{filter}}, init=-none-}
  Set the \meta{filter} defined by \cs{dbCombineFilters}.
\end{option}

\begin{option}{opt=raw-filter, desc={= \meta{cond combination}}}
  Set anonymous with defined conditionals. Two examples below perform the same
  function.
\end{option}

\begin{verbatim}
  % method 1
  \begin{dbFilters}{db}
    \dbNewConditional{cond1}{int-attr}{\rval > 1}
    \dbNewConditional*{cond2}{str-attr}{\d+}
  \end{dbFilters}
  \dbNewStyle{style}{db}{raw-filter={cond1 && cond2}}
  % method 2
  \begin{dbFilters}{db}
    \dbNewConditional{cond1}{int-attr}{\rval > 1}
    \dbNewConditional*{cond2}{str-attr}{\d+}
    \dbCombineFilters{filter}{cond1 && cond2}
  \end{dbFilters}
  \dbNewStyle{style}{db}{filter=filter}
\end{verbatim}

\begin{option}{
  opt = sort,
  desc = {= \{ \meta{attr spec1}, \meta{attr spec2}, \ldots{} \}},
}
  Set sorting rules. Attributes of type |str, date, int, fp| is supported to
  sort.  Multi-level sort is allowed. \meta{attr} represents for ascending
  order, and \meta{attr}* represents for descending order. The example below
  use four fields to determine the order of the records. It sorts on |level|
  in descending order first and if two |levels| are same then sorts on |birth|
  in ascending order and so on.
\end{option}

\begin{verbatim}
  \dbNewDatabase{sort-example}{
    name = str,
    birth = date,
    level = int,
    weight = fp,
  }
  \dbNewStyle{sort-style}{sort-example}{
    sort = { level*, birth, name, weight }
  }
\end{verbatim}

\begin{option}{
  opt = before-code,
  desc = {= \meta{before code}}
}
  Set the \meta{before code} that is executed before displaying the database.
\end{option}

\begin{option}{
  opt = after-code,
  desc = {= \meta{after code}}
}
  Set the \meta{after code} that is executed after displaying the database.
\end{option}

\begin{option}{
  opt = item-code,
  desc = {= \meta{item code}}
}
  Set the code that show a single record. You can use \cs{dbuse} to display
  certian attribute.
\end{option}

\begin{option}{
  opt = {\meta{attr}/before-code},
  desc = {= \meta{before code}}
}
  Set the \meta{before code} that is executed by \cs{dbuse} before displaying
  certain attribute.
\end{option}

\begin{option}{
  opt = {\meta{attr}/after-code},
  desc = {= \meta{after code}}
}
  Set the \meta{after code} that is executed by \cs{dbuse} after displaying
  certain attribute.
\end{option}

\begin{option}{
  opt = {\meta{attr}/sep},
  desc = {= \meta{sep spec}},
  init = {,~\~}
}
\begin{Syntax}
  \meta{attr}/separator = \meta{separator} \\
  \meta{attr}/separator = \{ \\
  ~~\meta{separator between two}, \\
  ~~\meta{separator between more than two}, \\
  ~~\meta{separator between final two} \\
  \}
\end{Syntax}

  Only for attributes of type |clist|. Set the separator between clist items.
  The first form accept one arguments and set the seperator as \meta{sep}. The
  second form is more complicated, the following documentation is quoted from
  \pkg{interface3}:
  \begin{quote}
    If the comma list has more than two items, the \meta{separator between
    more than two} is placed between each pair of items except the last, for
    which the \meta{separator between final two} is used. If the comma list
    has exactly two items, then they are placed in the input stream separated
    by the \meta{separator between two}. If the comma list has a single item,
    it is placed in the input stream, and a comma list with no items produces
    no output.
  \end{quote}

\end{option}

\begin{option}{
  opt = item-before-code,
  desc = {= \meta{before code}}
}
  Only for attributes of type |clist|. Set the \meta{after code} that is
  excuted before displaying the item of the comma list.
\end{option}

\begin{option}{
  opt = item-after-code,
  desc = {= \meta{after code}}
}
  Only for attributes of type |clist|. Set the \meta{after code} that is
  excuted after displaying the item of the comma list.
\end{option}

\subsection{Use \cs{dbNewReviewPoints} to Define Review Points}

\begin{function}{\dbNewReviewPoints}
  \begin{syntax}
    \cs{dbNewReviewPoints} \marg{name} \marg{points}
  \end{syntax}

  Define the new \meta{points} that is specially designed for reviewing
  something. \meta{points} is a list of integers. Suppose you record the date
  when you did not answer correctly and you plan to review every 2, 5 and 15
  days. The following code give what you want.
\begin{verbatim}
  \dbNewReviewPoints{review-point}{2, 5, 15}            % define points
  \begin{dbFilters}
    \dbNewConditional{cond1}{date}{review-point|\Today} % define conditional
    \dbCombineConditionals{filter1}{cond1}              % define filter
  \end{dbFilters}
  \dbNewStyle{review-style}{ques}{filter=filter1}       % define style
\end{verbatim}
\end{function}

\subsection{Define Filters inside \env{dbFilters} Environment}

\noindent\DescribeEnv{dbFilters}
\begin{Syntax}*
  |\begin{dbFilters}|\marg{database} \\
  ~~\meta{code}
  |\end{dbFilters}| \\
\end{Syntax}

Filters are defined inside \env{dbFilters} environment, inside which,
\cs{dbNewConditional} is defined to declare conditionals and
\cs{dbCombineConditionals} is defined to combine conditionals. Filters are
independent in different databases, which means the same name of filters is
allowed in different databases.

\begin{function}{\dbNewConditional, \dbNewConditional*}
  \begin{syntax}
    \cs{dbNewConditional}  \marg{name}        \marg{attr} \marg{cond spec} \\
    \cs{dbNewConditional}* \marg{name}        \marg{attr} \marg{cond spec} \\[2pt]
    \cs{dbNewConditional}  \marg{name} \marg{int/fp attr} \marg{relation} \\
    \cs{dbNewConditional}* \marg{name} \marg{int/fp attr} \marg{relation} \\
    \cs{dbNewConditional}  \marg{name} \marg{str/tl attr} \marg{regex expr} \\
    \cs{dbNewConditional}* \marg{name} \marg{str/tl attr} \marg{regex expr} \\
    \cs{dbNewConditional}  \marg{name}  \marg{clist attr} \marg{val list} \\
    \cs{dbNewConditional}* \marg{name}  \marg{clist attr} \marg{val list} \\
    \cs{dbNewConditional}  \marg{name}   \marg{date attr} \{\meta{review points}\textbar\meta{date}\} \\
    \cs{dbNewConditional}* \marg{name}   \marg{date attr} \marg{relation}
  \end{syntax}

  Define the conditional named \meta{name} that binds to \meta{attr}. \cs{dbval}
  is replaced with the real value of the attribute inside the \meta{cond spec}.
\end{function}

For attributes of type |int| and |fp|, two forms have the same definition.
\meta{relation} can be a single relation formula, such as |\dbval > 3|, or the
combination of several relation formulas, such as |\dbval > 3 && \dbval < 10.2|.
Supported operators are |<, >, =, ==, !=, >=, <=, !|.

For attribute of type |str| and |tl|, unstarred form matches any part while
starred form matches the whole part with the \meta{regex expr}.
\begin{verbatim}
  \dbNewConditional{cond1}{str-attr}{abc}  % match abc, abcd, 1abc, =abc=, etc
  \dbNewConditional*{cond2}{str-attr}{abc} % only match abc
\end{verbatim}

For attributes of type |clist|, the conditional defined by unstarred form is
true if any item of \meta{val list} is in the comma list. While the
conditional defined by starred form is true only if every item of \meta{val
list} is in the comma list. As is showed below, for |cond1|, |a| is in
|{a, b, d}| so |cond1| is true. While |c| is not in |{a, b, d}| so |cond2| is
false.

\begin{verbatim}
  \dbNewConditional{cond1}{clist-attr}{a, b, c}  % {a, b, d} -> true
  \dbNewConditional*{cond2}{clist-attr}{a, b, c} % {a, b, d} -> false
\end{verbatim}

For attributes of type |date|, unstarred form uses \meta{review points} to
define the conditional and \meta{date} is the date to be compared. The starred
form define the conditional with \textbf{single} relation formula. Supported
operators are |<, >, =, ==, !=, >=, <=|.

\begin{function}{\dbCombineConditionals}
  \begin{syntax}
    \cs{dbCombineConditionals} \marg{name} \marg{cond combination} \oarg{info}
  \end{syntax}

  Define the filter \meta{name}, which combine the conditionals and store the
  extra \meta{info} into \cs{dbFilterInfo}. So you can write something as\\
  \verb=\dbCombineConditionals{filter}{(cond1 && cond2) || !cond3}=.\\
  Supported operators are \verb=&&, ||, !=. You can set the option \opt{filter}
  to \meta{name} to apply the filter when you display the database.
\end{function}

\subsection{Store Data with \env{dbitem} Environment}

\noindent\DescribeEnv{dbitem}
\begin{Syntax}*
  |\begin{dbitem}|\marg{database}[ \\
  ~~\meta{attr1} = \meta{val1}, \\
  ~~\meta{attr2} = \meta{val2}, \\
  ~~\ldots{} \\
  ] \\
  ~~\meta{code} \\
  |\end{dbitem}|
\end{Syntax}

The data are stored with \env{dbitem} environment in two ways. Smaller data
can be stored in the option list and the bigger data can be stored by
\cs{dbsave}, which will suppress the value set by the option list. An example
code is showned below.

\begin{verbatim}
  \begin{dbitem}[date=2022-01-01, info=test]
    \dbsave{question}{This is a test question.}
    \dbsave{answer}{This is the correct answer of the question.}
  \end{dbitem}
\end{verbatim}

\subsection{\cs{dbsave} and \cs{dbuse}}

\begin{function}{\dbsave, \dbuse}
  \begin{syntax}
    \cs{dbsave} \marg{attr} \marg{data} \\
    \cs{dbuse}  \marg{attr} \\
  \end{syntax}

  Date is stored with \cs{dbsave} and is displayed with \cs{dbuse}.  \cs{dbsave}
  can be used only inside the \env{dbitem} environment and \cs{dbuse} can be
  only used inside the option \opt{item-code}.
\end{function}

\subsection{Use \cs{dbshow} to Display the Database}

\begin{function}{\dbshow}
  \begin{syntax}
    \cs{dbshow} \marg{style} \marg{database}
  \end{syntax}

  Show the \meta{database} with \meta{style}.
\end{function}

\subsection{Conditionals}

\begin{function}{\dbIfEmptyT, \dbIfEmptyF, \dbIfEmptyTF}
  \begin{syntax}
    \cs{dbIfEmptyTF} \marg{true code} \marg{false code} \\
    \cs{dbIfEmptyT} \marg{true code} \\
    \cs{dbIfEmptyF} \marg{false code}
  \end{syntax}

  Test if the database is empty. The example below shows how to avoid an empty
  list environment.
\end{function}

\begin{verbatim}
  \dbNewStyle{style-cond1}{database-test}{
    before-code = {\dbIfEmptyF{\begin{enumerate}}},
    after-code = {\dbIfEmptyF{\end{enumerate}}},
    item-code = {\item \dbuse{attr-test}}
  }
\end{verbatim}

\begin{function}{\dbItemIfEmptyT, \dbItemIfEmptyF, \dbItemIfEmptyTF}
  \begin{syntax}
    \cs{dbItemIfEmptyTF} \marg{true code} \marg{false code} \\
    \cs{dbItemIfEmptyT} \marg{true code} \\
    \cs{dbItemIfEmptyF} \marg{false code}
  \end{syntax}

  Test if the value of the attribute is empty. The example belows shows how to
  surround the non-empty |text| attribute with the symbol *.
\end{function}

\begin{verbatim}
  \dbNewStyle{style-cond2}{database-test}{
    text/before-code = {\dbItemIfEmptyF{*}},
    text/after-code = {\dbItemIfEmptyF{*}},
  }
\end{verbatim}

\begin{function}{\dbClistItemIfEmptyT, \dbClistItemIfEmptyF, \dbClistItemIfEmptyTF}
  \begin{syntax}
    \cs{dbClistItemIfEmptyTF} \marg{true code} \marg{false code} \\
    \cs{dbClistItemIfEmptyT} \marg{true code} \\
    \cs{dbClistItemIfEmptyF} \marg{false code}
  \end{syntax}

  Test if the item of comma list is empty. The example belows shows how to
  surround the non-empty label with the symbol *.
\end{function}

\begin{verbatim}
  \dbNewDatabase{database-test}{labels=clist}
  \dbNewStyle{style-cond3}{database-test}{
    labels/item-before-code = {\dbClistItemIfEmptyF{*}},
    labels/item-after-code = {\dbClistItemIfEmptyF{*}},
  }
\end{verbatim}

\subsection{Special Macros}

Some special macros are defined to expand to different contents according to context.

\DescribeMacro{\dbval} Attribute value, only accessible in \cs{dbNewConditional}.

\DescribeMacro{\dbDatabase} Database name.

\DescribeMacro{\dbFilterName} Filter name.

\DescribeMacro{\dbFilterInfo} Filter information.

\DescribeMacro{\dbIndex} Index of original records, which is equal to |\rvuse{id}| but \cs{rvuse} is nonexpandable.


\DescribeMacro{\dbarabic} Show the counter of query set as digits.

\DescribeMacro{\dbalph} Show the counter of query set as lowercase letters.

\DescribeMacro{\dbAlph} Show the counter of query set as uppercase letters.

\DescribeMacro{\dbroman} Show the counter of query set as roman numerals.

\DescribeMacro{\dbRoman} Show the counter of query set as Roman numerals.

\section{Example of Flaw Sweeper Template}
\label{sec:example}

\begin{tcblisting}{enhanced jigsaw,lower separated=false,
leftlower=0pt,rightlower=0pt,
colframe=red!50!black,colback=yellow!10!white,
listing options={style=tcblatex,texcsstyle=*\color{red!70!black}},
listing and comment,
pdf comment,freeze pdf,
compilable listing,
breakable,
run pdflatex
}
\documentclass{article}
\usepackage{amsmath, physics}
\usepackage{geometry}
\usepackage{dbshow}
\usepackage{tikz}
\usepackage{tcolorbox}
\tcbuselibrary{skins}
\usetikzlibrary{shadings}
\usepackage[hidelinks]{hyperref}

\geometry{
  margin=2cm
}

% #1 link node #2 target node #3 text to show
\NewDocumentCommand \linktarget { m m m } {%
  \hyperlink{#1}{#3}%
  \raisebox{1em}{\hypertarget{#2}{}}%
}

% question box
\tcbset{
  base/.style={
    empty,
    frame engine=path,
    colframe=yellow!10,
    coltitle=red!70,
    fonttitle=\bfseries\sffamily,
    sharp corners,
    left=4pt,
    right=4pt,
    drop fuzzy shadow,
    drop fuzzy shadow,
    borderline west={3pt}{-3pt}{red!80},
  }
}

\newtcolorbox{mybox}[1]{%
  base, title = {#1}
}

\dbNewReviewPoints{review}{1, 3, 7, 15, 30, 60}

\dbNewDatabase{ques-book}{
  ques = tl,
  answer = tl,
  count = int|1,
  labels = clist,
  date = date,
}

\begin{dbFilters}{ques-book}
  \dbNewConditional{hard}{labels}{hard}
  \dbNewConditional{bad}{count}{\dbval > 1}
  \dbNewConditional{review}{date}{review|2022-01-07}
\end{dbFilters}

% show all questions with hyperlink to answers
\dbNewStyle{ques}{ques-book}{
  before-code = {\section{Questions}},
  item-code = {
    \begin{mybox}{%
      \linktarget{answer_\dbIndex}{ques_\dbIndex}{%
        Question \dbarabic%
        \hspace{2em}\dbuse{date}%
        \hspace{2em}\dbuse{labels}%
        \hfill\dbuse{count}%
      }%
    }
      \dbuse{ques}%
    \end{mybox}
  },
  labels/sep = /,
}

% show all questions and answers with hyperlink to questions
\dbNewStyle{answer}{ques-book}{
  before-code = {\section{Questions and Answers}},
  item-code = {
    \begin{mybox}{%
      \linktarget{ques_\dbIndex}{answer_\dbIndex}{%
        Question \dbarabic%
        \hspace{2em}\dbuse{date}%
        \hspace{2em}\dbuse{labels}%
        \hfill\dbuse{count}%
      }%
    }
      \dbuse{ques}\tcbsubtitle{Answer}\dbuse{answer}%
    \end{mybox}
  },
  labels/sep = /,
}

% show all hard questions with hyperlink to answers
\dbNewStyle{hard}{ques-book}{
  before-code = {\section{Hard Questions}},
  item-code = {
    \begin{mybox}{%
      \hyperlink{answer_\dbIndex}{%
        Question \dbarabic%
        \hspace{2em}\dbuse{date}%
        \hspace{2em}\dbuse{labels}%
        \hfill\dbuse{count}%
      }%
    }
      \dbuse{ques}%
    \end{mybox}
  },
  raw-filter = hard,
  labels/sep = /,
}

% show all hard questions that have answered incorrectly for more than one
% time with hyperlink to answers
\dbNewStyle[hard]{bad}{ques-book}{
  before-code = {\section{Bad Questions}},
  raw-filter = {bad && hard},
}
% show all questions that plan to be reviewed on 2022-01-07 with hyperlink to
% answers
\dbNewStyle[hard]{review}{ques-book}{
  before-code = {\section{Questions to be Reviewed}},
  raw-filter = {review},
}

\AtEndDocument{
  \dbshow{review}{ques-book}
  \dbshow{hard}{ques-book}
  \dbshow{bad}{ques-book}
  \dbshow{ques}{ques-book}
  \dbshow{answer}{ques-book}
}

\begin{document}

\begin{dbitem}{ques-book}[
  date=2022-01-01,
  labels={math, equation, easy},
  count=2
  ]
  \dbsave{ques}{%
    Solve the linear equation: $x + 16 = 31$.
  }
  \dbsave{answer}{%
    $x = 31 - 16 = 15$
  }
\end{dbitem}

\begin{dbitem}{ques-book}[
  date=2022-01-01,
  labels={math, equation, hard},
  count=3
  ]
  \dbsave{ques}{%
    Solve the linear equation: $2y = 16$.
  }
  \dbsave{answer}{%
    $y = 16 / 2 = 8$
  }
\end{dbitem}

\begin{dbitem}{ques-book}[
  date=2022-01-04,
  labels={math, integral, hard},
  count=1
  ]
  \dbsave{ques}{%
    Find the indefinite integral: $\int 2x \dd x$.
  }
  \dbsave{answer}{%
    $\int 2x \dd x = x^2$
  }
\end{dbitem}

\end{document}
\end{tcblisting}

\section*{Change History}
\markboth{Change History}{Change History}
\addcontentsline{toc}{section}{Change History}
\noindent
\begin{tblr}{
  colspec = {lll},
  row{1} = {font=\bfseries},
}
  Date & Ver. & Describe \\
  2022-01-05 & 1.0 & {
    First version \\
    Add macro: \cmd{\dbarabic}, \cmd{\dbalph}, \cmd{\dbAlph}, \cmd{\dbroman}, \cmd{\dbRoman}
  } \\
  2022-01-06 & & {
    Fix bug: \cmd{\dbIndex} undefined \\
    Add style option: \opt{raw-filter}
  } \\
  2022-01-07 & 1.1 & Improve example \\
\end{tblr}

\end{documentation}


\end{document}