summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/semantex/semantex.tex
blob: da8cfd390b0bb826ee7ab5e1ddfbb514f02be9a7 (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
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
\documentclass[a4paper,article,oneside,english,10pt]{memoir}

\makeatletter

\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{babel}
\usepackage[noDcommand,slantedGreeks]{kpfonts}

\frenchspacing

\usepackage{mathtools,etoolbox,	microtype,xspace}



\usepackage[shortlabels]{enumitem}%control lists

\usepackage[draft]{fixme}

%Setup of memoir:
\pagestyle{plain} %change to heading for running headings
\nouppercaseheads %running heads should not be capitalized
\captionnamefont{\small} %captions with small font
\captiontitlefont{\small}
\makeevenhead{headings}{\thepage}{}{\itshape\leftmark} %make headings italic instead of slanted (though we do not use headings right now)
\makeoddhead{headings}{\itshape\rightmark}{}{\thepage}

\raggedbottomsectiontrue%less harse than \raggedbottom
%\allowdisplaybreaks %long equations may break

\g@addto@macro\bfseries{\boldmath} %make math in bold text automatically bold

\usepackage[english=american]{csquotes}

\usepackage[hidelinks]{hyperref}
	
\usepackage[nameinlink]{cleveref}

\title{Seman\!\TeX: Object-oriented mathematics (v$0.1\alpha$)}
\date{\today}
\author{Sebastian Ørsted (\href{mailto:sorsted@gmail.com}{sorsted@gmail.com})}

\hypersetup{
	pdfauthor={Sebastian Ørsted},
	pdftitle={SemanTeX: Object-oriented mathematics},
	%pdfsubject={},
	%pdfkeywords={},
	%pdfproducer={Latex with hyperref, or other system},
	%pdfcreator={pdflatex, or other tool},
}




% Settup up SemanTeX:

\usepackage{semantex}

\newvariableclass{var}[
	output=var,
]

\newvar\va{a}
\newvar\vb{b}
\newvar\vc{c}
\newvar\vd{d}
\newvar\ve{e}
\newvar\vf{f}
\newvar\vg{g}
\newvar\vh{h}
\newvar\vi{i}
\newvar\vj{j}
\newvar\vk{k}
\newvar\vl{l}
\newvar\vm{m}
\newvar\vn{n}
\newvar\vo{o}
\newvar\vp{p}
\newvar\vq{q}
\newvar\vr{r}
\newvar\vs{s}
\newvar\vt{t}
\newvar\vu{u}
\newvar\vv{v}
\newvar\vw{w}
\newvar\vx{x}
\newvar\vy{y}
\newvar\vz{z}

\newvar\vA{A}
\newvar\vB{B}
\newvar\vC{C}
\newvar\vD{D}
\newvar\vE{E}
\newvar\vF{F}
\newvar\vG{G}
\newvar\vH{H}
\newvar\vI{I}
\newvar\vJ{J}
\newvar\vK{K}
\newvar\vL{L}
\newvar\vM{M}
\newvar\vN{N}
\newvar\vO{O}
\newvar\vP{P}
\newvar\vQ{Q}
\newvar\vR{R}
\newvar\vS{S}
\newvar\vT{T}
\newvar\vU{U}
\newvar\vV{V}
\newvar\vW{W}
\newvar\vX{X}
\newvar\vY{Y}
\newvar\vZ{Z}

\newvar\valpha{\alpha}
\newvar\vvaralpha{\varalpha}
\newvar\vbeta{\beta}
\newvar\vgamma{\gamma}
\newvar\vdelta{\delta}
\newvar\vepsilon{\epsilon}
\newvar\vvarepsilon{\varepsilon}
\newvar\vzeta{\zeta}
\newvar\veta{\eta}
\newvar\vtheta{\theta}
\newvar\viota{\iota}
\newvar\vkappa{\kappa}
\newvar\vlambda{\lambda}
\newvar\vmu{\mu}
\newvar\vnu{\nu}
\newvar\vxi{\xi}
\newvar\vpi{\pi}
\newvar\vvarpi{\varpi}
\newvar\vrho{\rho}
\newvar\vsigma{\sigma}
\newvar\vtau{\tau}
\newvar\vupsilon{\upsilon}
\newvar\vphi{\phi}
\newvar\vvarphi{\varphi}
\newvar\vchi{\chi}
\newvar\vpsi{\psi}
\newvar\vomega{\omega}

\newvar\vGamma{\Gamma}
\newvar\vDelta{\Delta}
\newvar\vTheta{\Theta}
\newvar\vLambda{\Lambda}
\newvar\vXi{\Xi}
\newvar\vPi{\Pi}
\newvar\vSigma{\Sigma}
\newvar\vUpsilon{\Upsilon}
\newvar\vPhi{\Phi}
\newvar\vPsi{\Psi}
\newvar\vOmega{\Omega}

\newvar\sheafF{\mathcal{F}}
\newvar\sheafG{\mathcal{G}}
\newvar\sheafO{\mathcal{O}}
\newvar\sheafHom{\mathcal{H}\!\!om}

\newvar\Hom{\operatorname{Hom}}

\usepackage{showexpl,newunicodechar}

\newunicodechar{⟨}{\textlangle}
\newunicodechar{⟩}{\textrangle}


\setupclass{var}{
	novaluekeys={
		{inverseimage}{upper={-1},nopar},
	},
}

\newcohomologyclass{cohomology}[
	parent=var,
	valuekeys={
		{arg}{argwithkeyval={#1}},
	},
	gradingpos=upper,
]

\newcohomologyclass{homology}[
	parent=cohomology,
	gradingpos=lower,
]

\newcohomology\co{H}

\newhomology\ho{H}

\makeatother

\begin{document}

\maketitle

\lstset{%
	language=[LaTeX]TeX,
	basicstyle=\ttfamily\small,
	commentstyle=\itshape\ttfamily\small,
	extendedchars=true,
	breaklines=true,
	breakindent={0pt},
	captionpos=t,
	pos=r,
	tabsize=2,
	inputencoding=utf8,
	extendedchars=true,
	explpreset={numbers=none,},
	literate={⟨}{\textlangle}1 {⟩}{\textrangle}1,
}



\newcommand*\mybs{$\backslash$}

\newcommand*\commandname[1]{\mybs\texttt{#1}}

\let\pack=\texttt

\newcommand\semantex{Seman\!\TeX\xspace}

\noindent
The \semantex package for \LaTeX\ delivers a more semantic, systematized way of writing mathematics, compared to the ordinary math syntax. The system is object-oriented and uses keyval syntax, and everything is highly customizable. At the same time, care has been taken to make it intuitive, natural, practical, and with an easy-to-use and lightweight syntax.
\textbf{Note: \semantex is still in its alpha stage and cannot be considered stable at this point. You are more than welcome to report bugs and come with suggestions!}

\begingroup
	\setupclass{var}{
		novaluekeys={
			{inverseimage}{upper={-1},nopar},
		},
		valuekeys={
			{stalk}{lower=#1},
			{res}{ return,symbolputright={|}, lower={#1} },
		},
		argvaluekeys={
			{coef}{sep={;}{#1}},
		},
	}
	
	Traditional math notation in \TeX\ is not particularly semantic -- you usually type the raw \emph{notation} rather than the underlying
	\emph{meaning} of your math.
	Take, for instance, the following equations from algebraic geometry:
	\begin{align*}
		\vf[inverseimage]{\sheafF}[spar,stalk=\vp]
		&=
		\sheafF[stalk=\vf{\vp}] ,
	\\
		\sheafO[\vU]
		&=
		\sheafO[\vX,res=\vU] ,
	\\
		\sheafHom{ \sheafF , \sheafG }{\vU}
		&=
		\Hom[\sheafO[\vU]]{ \sheafF[res=\vU] , \sheafG[res=\vU] } ,
	\\
		\co{0}{\vU,coef=\sheafO[\vX]} &= \sheafO[\vX]{\vU} 
		.
	\end{align*}
	Here, \( \sheafF \) and~\( \sheafG \)
	are sheaves on some scheme~\( \vX \),
	\( \sheafO[\vX] \)~is the structure sheaf,
	and~\( \vU \subset \vX \) an open subset.
	In traditional \TeX, you would probably define a collection of commands \lstinline!\sheafF!, \lstinline!\sheafG!, \lstinline!\sheafO!, and~\lstinline!\sheafHom! for~\( \sheafF \),~\( \sheafG \), \( \sheafO \), and~\( \sheafHom \) and then proceed
	something like
	\begin{lstlisting}
(f^{-1}\sheafF)_{p}=\sheafF_{f(p)},
\sheafO_{U} = \sheafO_{X}|_{U},
\sheafHom( \sheafF , \sheafG)(U)
	= \Hom_{\sheafO_{X} ( \sheafF|_{U} , \sheafG|_{V} ),
	H^{0}(U;\sheafF) = \sheafF(U).
	\end{lstlisting}
	For more than~90~\% of all mathematicians, this solution will be completely satisfactory; it prints what it is supposed to, and that's that.
	If this is how you feel, there is absolutely no reason for you to continue reading. This package is for the remaining less than~10~\% who would prefer to write
	something like the following instead:
	\begin{lstlisting}
\vf[inverseimage]{ \sheafF }[spar,stalk=\vp]
	= \sheafF[ stalk=\vf{\vp} ] ,
\sheafO[\vU] = \sheafO[ \vX, res=\vU ],
\sheafHom{ \sheafF , \sheafG }{\vU}
	= \Hom[\sheafO[\vU]]{ \sheafF[res=\vU],	\sheafG[res=\vU] },
\co{0}{ \vU, coef=\sheafO[\vX] } = \sheafO[\vX]{\vU}.
	\end{lstlisting}
	
	A lot of comments are in order.
	The whole syntax will be explained in later chapters, but let us take a moment to look at these examples and understand the logic.
	First of all, what is up with all the~\lstinline!v!'s in the command names \lstinline!\vf!, \lstinline!\vX!, \lstinline!\vU!? The~\lstinline!v!~stands for \textquote{variable}, and it is the prefix I recommend using for all standard variables. So for all letters in the alphabet, uppercase and lowercase, as well as the Greek ones, there will be a command: \lstinline!\va!, \lstinline!\vA!, \lstinline!\vb!, \lstinline!\vB!,~etc.
	It is not always necessary to use them; for instance, in the above example, both \lstinline!\vX! and \lstinline!\vU! could have been replaced by simply~\lstinline!X!,~\lstinline!U! without changing anything. This is because we did not apply any arguments to these symbols. However, for the sake of consistency, I prefer to switch completely to using commands instead of writing the symbols directly.
	How \emph{you} use the system is completely up to you.
	
	In \semantex, all entries are being built up from the inside and out.
	The basic syntax layout for most \semantex commands is
	\begin{lstlisting}
\command[options]{argument}
	\end{lstlisting}
	Let us try focusing on the first example from above:
	\begin{LTXexample}
$\vf[inverseimage]{\sheafF}[spar,stalk=\vp]$
	\end{LTXexample}
	You always start with a central piece: a \emph{symbol}.
	In the case of~\lstinline!\vf!, the symbol is~\( f \). After the symbol follows the options we apply to it, written in brackets~\lstinline![...]!. In this case, we the option~\lstinline!inverseimage!. This tells \semantex that we want the inverse image functor~\( \vf[inverseimage] \), so it adds a superscript~\lstinline!-1! to the symbol. After this, we apply the function~\lstinline!\vf[inverseimage]! to something, namely the sheaf~{$\sheafF$}. This is done by enclosing them in braces~\lstinline!{...}!.\footnote{You should be aware that this argument in braces~\texttt{\{...\}} is \emph{optional}. You can simply write~\texttt{$\backslash$vf[inverseimage]} if you want, and it will produce~\smash{\( \vf[inverseimage] \)}.}
	
	
	Next, we want to take the stalk of this sheaf at the point~\( \vp \). If we simply wrote~\lstinline!\vf[inverseimage]{\sheafF}[stalk=\vp]!, we would get~\smash{\( \vf[inverseimage]{\sheafF}[stalk=\vp] \)}, which looks confusing. So we want to enclose~\smash{\( \vf[inverseimage]{\sheafF} \)} in parentheses before taking the stalk. This is done with the key~\lstinline!spar! (an abbreviation for \textquote{symbol parentheses}).
	This key takes whatever has been typed so far, symbol and indices, and adds parentheses around it (of course, type and size is adjustable).
	This~\lstinline!spar! is a key you fill find yourself using a lot.
\endgroup

\chapter{Getting started}

To get started using \semantex, load down the package
with
\begin{lstlisting}
\usepackage{semantex}
\end{lstlisting}
The \semantex system is object-oriented; all entities are objects of some class. When you load the package, there
is only one class by default, which is simply called \lstinline!semantexvariable!.
You should think of this as a low-level class, the parent of all other classes. Therefore, I highly advice against using it directly or modifying it.
Instead, we create a new, more high-level variable class.
To make notations brief, we call it \lstinline!var!.
We could write \lstinline!\newvariableclass{var}!, but we choose to
pass some options to it in~\lstinline![...]!:
\begin{lstlisting}
\newvariableclass{var}[output=var]
\end{lstlisting}
This \lstinline!output=var! option will be explained better below.
Roughly speaking, it tells \semantex that everything
a variable \emph{outputs} will also be a variable.
For instance, if the function~\lstinline!\vf! (i.e.~\( \vf \)) is of class~\lstinline!var!,
then \lstinline!\vf{\vx}!~(i.e.~\( \vf{\vx} \))~will also of class~\lstinline!var!.

Now we have a class, but we do not have any objects.
When we create the class~\lstinline!var!, the system
automatically defines the command \lstinline!\newvar!
that creates a new object of class~\lstinline!var!. The syntax is
\begin{lstlisting}
\newvar\⟨variable name⟩{⟨variable symbol⟩}[options]
\end{lstlisting}
For instance, we may write
\begin{lstlisting}
\newvar\vf{f}
\newvar\vx{x}
\end{lstlisting}
to get two variables \lstinline!\vf! and~\lstinline!\vx! with symbols \( f \) resp.~\( x \).
Let us perform a stupid test to see if the variables work:
\begin{LTXexample}
$\vf$, $\vx$
\end{LTXexample}
Th general syntax of a variable-type command is
\begin{lstlisting}
\command[options]{argument}
\end{lstlisting}
Both \lstinline!options! and \lstinline!argument! are optional
arguments (they can be left out if you do not need them).
The \lstinline!options! should consist of a list of options separated by commas, using keyval syntax. On the other hand, \lstinline!argument! is the actual argument of the function.
By design, \semantex does not distinguish between variables and functions, so all variables can take arguments.
This is a design choice to make the system easier to use; after all, it is fairly common in mathematics that something is first a variable and then a moment later takes an argument.
So we may write:
\begin{LTXexample}
$\vf{1}$, $\vf{\vx}$
\end{LTXexample}

So far, we do not have very many options to write in the
\lstinline!options! position, since we have not added any keys yet. However, we do have access
to the most important of all options: the \emph{index}.
There is a simple shortcut for writing an index: You simply write the index itself in the options tag:
\begin{LTXexample}
$\vf[1]$, $\vf[\vf]$,
$\vf[1,2,\vf]{2}$
\end{LTXexample}
As long as what you write in the options tag is not recognized as a predefined key, it will be printed as the index.
Other than that, there are two important predefined keys: \lstinline!upper! and \lstinline!lower! which simply add something to the upper and lower index:
\begin{LTXexample}
$\vf[upper=2]$,
$\vf[lower=3]$
\end{LTXexample}

We are soon going to need more variables
than just \( \vf \) and~\( \vx \).
In fact, I advise you to create a variable for each letter in the Latin and Greek alphabets, both uppercase and lowercase.
This is pretty time-consuming, so I did it for you already:
\begin{lstlisting}
\newvar\va{a}
\newvar\vb{b}
\newvar\vc{c}
\newvar\vd{d}
\newvar\ve{e}
\newvar\vf{f}
\newvar\vg{g}
\newvar\vh{h}
\newvar\vi{i}
\newvar\vj{j}
\newvar\vk{k}
\newvar\vl{l}
\newvar\vm{m}
\newvar\vn{n}
\newvar\vo{o}
\newvar\vp{p}
\newvar\vq{q}
\newvar\vr{r}
\newvar\vs{s}
\newvar\vt{t}
\newvar\vu{u}
\newvar\vv{v}
\newvar\vw{w}
\newvar\vx{x}
\newvar\vy{y}
\newvar\vz{z}

\newvar\vA{A}
\newvar\vB{B}
\newvar\vC{C}
\newvar\vD{D}
\newvar\vE{E}
\newvar\vF{F}
\newvar\vG{G}
\newvar\vH{H}
\newvar\vI{I}
\newvar\vJ{J}
\newvar\vK{K}
\newvar\vL{L}
\newvar\vM{M}
\newvar\vN{N}
\newvar\vO{O}
\newvar\vP{P}
\newvar\vQ{Q}
\newvar\vR{R}
\newvar\vS{S}
\newvar\vT{T}
\newvar\vU{U}
\newvar\vV{V}
\newvar\vW{W}
\newvar\vX{X}
\newvar\vY{Y}
\newvar\vZ{Z}

\newvar\valpha{\alpha}
\newvar\vvaralpha{\varalpha}
\newvar\vbeta{\beta}
\newvar\vgamma{\gamma}
\newvar\vdelta{\delta}
\newvar\vepsilon{\epsilon}
\newvar\vvarepsilon{\varepsilon}
\newvar\vzeta{\zeta}
\newvar\veta{\eta}
\newvar\vtheta{\theta}
\newvar\viota{\iota}
\newvar\vkappa{\kappa}
\newvar\vlambda{\lambda}
\newvar\vmu{\mu}
\newvar\vnu{\nu}
\newvar\vxi{\xi}
\newvar\vpi{\pi}
\newvar\vvarpi{\varpi}
\newvar\vrho{\rho}
\newvar\vsigma{\sigma}
\newvar\vtau{\tau}
\newvar\vupsilon{\upsilon}
\newvar\vphi{\phi}
\newvar\vvarphi{\varphi}
\newvar\vchi{\chi}
\newvar\vpsi{\psi}
\newvar\vomega{\omega}

\newvar\vGamma{\Gamma}
\newvar\vDelta{\Delta}
\newvar\vTheta{\Theta}
\newvar\vLambda{\Lambda}
\newvar\vXi{\Xi}
\newvar\vPi{\Pi}
\newvar\vSigma{\Sigma}
\newvar\vUpsilon{\Upsilon}
\newvar\vPhi{\Phi}
\newvar\vPsi{\Psi}
\newvar\vOmega{\Omega}
\end{lstlisting}

Just like~\lstinline!\vf!, these can all be regarded as functions, so~\lstinline!\va{\vb}!~produces~\( \va{\vb} \).
Importantly,
\textbf{parentheses can be scaled}.
To make parentheses bigger, use the following keys:
\begin{LTXexample}
$\vf{\vx}$,
$\vf[par=\big]{\vx}$,
$\vf[par=\Big]{\vx}$,
$\vf[par=\bigg]{\vx}$,
$\vf[par=\Bigg]{\vx}$,
$\vf[par=auto]{\frac{1}{2}}$
\end{LTXexample}
Using \lstinline!par=auto! corresponds to using \lstinline!\left...\right!. Just as for ordinary math, I advice you to use manual scaling rather than automatic scaling, as \TeX\ has a tendency to scale things wrong. If you do not want parentheses at all, you can pass the key~\lstinline!nopar!:
\begin{LTXexample}
$\vf[nopar]{\vx}$
\end{LTXexample}
Primes are added via the key~\lstinline!prime!
or the keys~\lstinline!'!,~\lstinline!''! and~\lstinline!'''!:
\begin{LTXexample}
$\vf['] = \vf[prime]$,
$\vf[''] = \vf[prime,prime]$
$\vf['''] = \vf[prime,prime,prime]$
\end{LTXexample}

So far, so good, but our variables cannot really do anything yet. For this, we need to assign \emph{keys} to them. The more pieces of math notation you need, the more keys you will have to define.
Keys are being added via two different keys:
\begin{center}
	\lstinline!novaluekeys!
	\qquad\qquad and \qquad\qquad
	\lstinline!valuekeys!.
\end{center}
In short, \lstinline!novaluekeys! is for keys that do \emph{not} take a value (i.e.~keys using the syntax~\lstinline!\command[key]!), and \lstinline!valuekeys! is for keys that \emph{do} take a value
(i.e.~keys using the syntax~\lstinline!\command[key=value]!)).
We explain the syntax for using them in the next section where we show how to make keyval syntax for elementary calculus.

\chapter{Example: Elementary calculus}

One thing we might want to do to a variable
is \emph{invert} it. We therefore add a key~\lstinline!inv!
that adds an upper index~\lstinline!-1! to the symbol.
We add this key using the key \lstinline!novaluekeys!:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{inv}{ upper={-1} },
	},
}
\end{lstlisting}
\setupclass{var}{
novaluekeys={
	{inv}{ upper={-1} },
},
}
Now the key \lstinline!inv!
has been defined to be equivalent to \lstinline!upper={-1}!.
Now we can do the following:
\begin{LTXexample}
$\va[inv]$, $\vf[inv]$,
$\vg[1,2,inv]$,
$\vh[\va,\vb,inv]$
\end{LTXexample}
The key \lstinline!novaluekeys! is for keys that take no value,
like \lstinline!inv!.

Other keys might need to take a value.
For defining such, we have the command~\lstinline!valuekeys!.
%There are two different keys for adding new keys
%to a class: \lstinline!novaluekeys! and \lstinline!valuekeys!.
%The difference is that
For instance, suppose we want a command for deriving a function \( n \)~times.
For this, we add the following extra keyval key~\lstinline!der!:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{inv}{ upper={-1} },
	},
	valuekeys={
		{der}{ upper={(#1)} },
	},
}
\end{lstlisting}
\setupclass{var}{
valuekeys={
	{der}{ upper={(#1)} },
},
}
The~\lstinline!#1! will contain whatever the
user added as the value of the key.
Now we can write:
\begin{LTXexample}
$\vf[der=\vn]{\vx}$
\end{LTXexample}
Maybe we also want a more elementary operation:
raising a variable to some \emph{power}.
We could have called the key \lstinline!power!, but this is long and cumbersome, so let us simply call it \lstinline!to!:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{inv}{ upper={-1} },
	},
	valuekeys={
		{der}{ upper={(#1)} },
		{to}{ upper={#1} },
	},
}
\end{lstlisting}
\setupclass{var}{
	valuekeys={
		{to}{ upper={#1} },
	},
}
This allows us to write
\begin{LTXexample}
$\vx[to=2]$,
$\vy[1,to=2] + \vy[2,to=2]$
\end{LTXexample}
In the long run, you might want to define a command~\lstinline!squared! or~\lstinline!sq! and make it equivalent to~\lstinline!to=2!.

Let us try doing something a bit more complicated: Adding a key for restricting a function to a smaller subset.
For this, we do the following:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{inv}{ upper={-1} },
	},
	valuekeys={
		{der}{ upper={(#1)} },
		{to}{ upper={#1} },
		{res}{ return,symbolputright={|}, lower={#1} },
	},
}
\end{lstlisting}
\setupclass{var}{
	valuekeys={
		{res}{ return,symbolputright={|}, lower={#1} },
	},
}
This adds a horizonal line~\enquote{$|$}
to the right of the symbol followed by
a lower index containing whatever you passed to the key
(contained in the \mbox{command~\lstinline!#1!)}.
(There is also an extra key, \lstinline!return!, which is a bit more advanced and should be taken for granted for now. Roughly speaking, it is there to make sure that the restriction symbol is printed \emph{after} all indices that you might have added before. More details in \cref{ch:return}.)
Now we may write the following:
\begin{LTXexample}
$\vf[res=\vU]{\vx}$,
$\vg[1,res=\vY]{\vy}$,
$\vh[inv,res=\vT]{\vz}$
\end{LTXexample}

If the reader starts playing around with the \semantex functions, they will discover that whenever you apply a function to something, the result becomes a new function that can take an argument itself. This behaviour is both useful and extremely necessary in order for the package to be useful in practice. For instance, you may write
\begin{LTXexample}
$\vf[der=\vn]{\vx}{\vy}{\vz}
=\vg{\vu,\vv,\vw}[3]{
	\vx[1],\vx[2]}[8,1,der=2]{\vt}$
\end{LTXexample}
Some people prefer to be able to scale the restriction
line. I rarely do that, but for that purpose, we could do the following:
\begin{lstlisting}
\setupclass{var}{
	valuekeys={
		{bigres}{ return, symbolputright=\big\vert, lower={#1} },
		{Bigres}{ return, symbolputright=\Big\vert, lower={#1} },
		{biggres}{ return, symbolputright=\bigg\vert, lower={#1} },
		{Biggres}{ return, symbolputright=\Bigg\vert, lower={#1} },
		{autores}{ return, sparsize=auto, otherspar=.\vert,
		sparsize=normal, lower={#1} },
		% This auto scales the vertical bar. See the chapter on the spar
		% key for information about sparsize and otherspar
	},
}
\end{lstlisting}

So to sum up, we first defined a class~\lstinline!var!
via \lstinline!\newvariableclass! and then used \lstinline!\setupclass! to add keys to it. In fact, we could have done it all at once by passing these options directly to \lstinline!\newvariableclass!:
\begin{lstlisting}
	\newvariableclass{var}[
		output=var,
		novaluekeys={
			{inv}{ upper={-1} },
		},
		valuekeys={
			{der}{ upper={(#1)} },
			{to}{ upper={#1} },
			{res}{ rightreturn, symbolputright={|},
				lower={#1} },
		},
	]
\end{lstlisting}
As we proceed in this guide, we shall use \lstinline!\setupclass!
to add more and more keys to~\lstinline!var!. However, when you set up your own system, you may as well just add all of the keys like this when you create the class and then be done with it.

Let me add that it is possible to create subclasses of existing classes. You just write \lstinline!parent=myclass! in the class declaration to tell that \lstinline!myclass! is the parent class. \textbf{But a word of warning:} It is a natural idea to create different classes for different mathematical entities, each with their own keyval syntax that fits whatever class you are in; for instance, you could have one class for algebraic structures like rings and modules with keys for opposite rings and algebraic closure, and you could have another class for topological spaces with keys for closure and interior. However, as the reader can probably imagine, this becomes extremely cumbersome to work with in practice since an algebraic structure might very well also carry a topology. So at the end of the day, I advice you to use a single superclass \lstinline!var! that has all the keyval syntax and only use subclasses for further \emph{customization}. We shall see examples of this below.
\chapter{Example: Elementary algebra}

\setupclass{var}{
	novaluekeys={
		{pol}{
			par, 	% This tells semantex to use parentheses around
						% the argument in the first place, in case this
						% had been turned off
			leftpar=[,rightpar=],
		},
	},
}

Let us try to use the \semantex system to build some commands
for doing algebra.
As an algebraist, one of the first things you might want to do is to create polynomial rings~\( \vk[pol]{\vx,\vy,\vz} \). Since all variables can already be used as functions (this is a design choice we discussed earlier), all we need to do is find a way to change from using parentheses to square brackets. This can be done the following way:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{pol}{
			par, 	% This tells semantex to use parentheses around
						% the argument in the first place, in case this
						% had been turned off
			leftpar=[,rightpar=],
		},
	},
}
\end{lstlisting}
Now we may write
\begin{LTXexample}
	$\vk[pol]{\vx,\vy,\vz}$
\end{LTXexample}
It is straightforward how to do adjust this to instead write the \emph{field} generated by the variables~\( x, y, z \):
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{pol}{
			par, 	% This tells semantex to use parentheses around
						% the argument in the first place, in case this
						% had been turned off
			leftpar=[,rightpar=],
		},
		{field}{
			par,
			leftpar=(,rightpar=),
		},
	},
}
\end{lstlisting}
\setupclass{var}{
	novaluekeys={
		{field}{
			par,
			leftpar=(,rightpar=),
		},
	},
}
Now \lstinline!\vk[field]{\vx,\vy,\vz}! produces~\( \vk[field]{\vx,\vy,\vz} \). Of course, leaving out the \lstinline!field!
key would produce the same result with the current configuration of~\lstinline!var!. However, it is still best to use a key for this, both because this makes the semantics more clear, but also because you might later change some settings that would cause the default behaviour to be different.

Adding support for free algebras and fields is almost as easy, but there is a catch:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{pol}{
			par, 	% This tells semantex to use parentheses around
						% the argument in the first place, in case this
						% had been turned off
			leftpar=[,rightpar=],
		},
		{field}{
			par,
			leftpar=(,rightpar=),
		},
		{freealg}{
			par,
			leftpar=\noexpand\langle,
			rightpar=\noexpand\rangle,
		},
		{powerseries}{
			par,
			leftpar=\noexpand\llbracket,
			rightpar=\noexpand\rrbracket,
		},
		{laurent}{
			par,
			leftpar=(, rightpar=),
			prearg={\!\!\noexpand\semantexdelimsize(},
			postarg={\noexpand\semantexdelimsize)\!\!},
			% These are printed before and after the argument.
			% The command "\semantexdelimsize" is substituted
			% by \big, \Big, ..., or whatever size the
			% argument delimiters have
		},
	},
}
\end{lstlisting}
\setupclass{var}{
	novaluekeys={
		{freealg}{
			par,
			leftpar=\noexpand\langle,
			rightpar=\noexpand\rangle,
		},
		{powerseries}{
			par,
			leftpar=\noexpand\llbracket,
			rightpar=\noexpand\rrbracket,
		},
		{laurent}{
			par,
			leftpar=(, rightpar=),
			prearg={\!\!\noexpand\semantexdelimsize(},
			postarg={\noexpand\semantexdelimsize)\!\!},
			% These are printed before and after the argument.
			% The command "\semantexdelimsize" is substituted
			% by \big, \Big, ..., or whatever size the
			% argument delimiters have
		},
	},
}
For expansion reasons (which I am not completely sure of),
we need \lstinline!\noexpand! before these commands.
In general, whenever something fails, try throwing in \lstinline!\noexpand!'s in front of suspicious-looking commands,
and things will usually work out just fine. See for yourself:
\begin{LTXexample}
$\vk[freealg]{\vx}$,
$\vk[powerseries]{\vy}$,
$\vk[laurent]{\vz}$
\end{LTXexample}


Let us look at some other algebraic operations that we can control via \semantex:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{op}{upper={\noexpand\mathrm{op}}},
			% opposite groups, rings, categories, etc.
		{algclosure}{overline},
			% algebraic closure
		{conj}{overline},
			% complex conjugation
		{dual}{upper=*},
			% dual vector space
		{perp}{upper=\perp},
			% orthogonal complement
	},
	valuekeys={
		{mod}{symbolputright={/#1}},
			% for modulo notation like R/I
		{dom}{symbolputleft={#1\backslash}},
			% for left modulo notation like I\R
			% "dom" is "mod" spelled backwards
		{oplus}{upper={\oplus#1}},
			% for notation like R^{\oplus n}
		{tens}{upper={\otimes#1}},
			% for notation like R^{\otimes n}
		{localize}{symbolputright={ \relax [#1^{-1}] }},
			% localization at a multiplicative subset;
			% the \relax is necessary becauese, in some cases,
			% the [...] can be interpreted as an optional argument
		{localizeprime}{lower={#1}},
			% for localization at a prime ideal
	},
}
\end{lstlisting}
\setupclass{var}{
	novaluekeys={
		{op}{upper={\noexpand\mathrm{op}}},
			% opposite groups, rings, categories, etc.
		{algclosure}{overline},
			% algebraic closure
		{conj}{overline},
			% complex conjugation
		{dual}{upper=*},
			% dual vector space
		{perp}{upper=\perp},
			% orthogonal complement
	},
	valuekeys={
		{mod}{symbolputright={/#1}},
			% for modulo notation like R/I
		{dom}{symbolputleft={#1\backslash}},
			% for left modulo notation like I\R
			% "dom" is "mod" spelled backwards
		{oplus}{upper={\oplus#1}},
			% for notatoin like R^{\oplus n}
		{tens}{upper={\otimes#1}},
			% for notation like R^{\otimes n}
		{localize}{symbolputright={ [#1^{-1}] }},
			% localization at a multiplicative subset
		{localizeprime}{lower={#1}},
			% for localization at a prime ideal
	},
}
Let us see it in practice:
\begin{LTXexample}
$\vR[op]$, $\vk[algclosure]$,
$\vz[conj]$, $\vV[dual]$,
$\vR[mod=\vI]$,$\vR[dom=\vJ]$,
$\vR[oplus=\vn]$,
$\vV[tens=\vm]$,
$\vR[localize=\vS]$,
$\vR[localizeprime=\vI]$,
$\vk[freealg]{\vS}[op]$,
$\vV[perp]$
\end{LTXexample}

\chapter{The \texttt{spar} key}

The \lstinline!spar! key is one of the most important commands in \semantex at all. To understand why we need it, imagine you want to derive a function \( \vn \)~times and then invert it. Writing something like
\begin{LTXexample}
$\vf[der=\vn,inv]$
\end{LTXexample}
does not yield a satisfactory result. However, the \lstinline!spar! key saves the day:
\begin{LTXexample}
$\vf[der=\vn,spar,inv]$
\end{LTXexample}
So \lstinline!spar! simply adds a pair of parentheses around the current symbol, complete with all indices that you may have added to it so for. The name \lstinline!spar! stands for \enquote{symbol parentheses}. You can add as many as you like:
\begin{LTXexample}
$ \vf[1,res=\vV,spar,conj,op,spar,0,inv,spar,mod=\vI,spar,dual]{\vx} $
\end{LTXexample}
If it becomes too messy, you can scale the parentheses, too. Simply use the syntax
\lstinline!spar=\big!, \lstinline!spar=\Big!, etc.
You can also get auto-scaled parentheses base on \lstinline!\left...\right!,
using the key \lstinline!spar=auto!:
\begin{LTXexample}
$\vf[spar]$,
$\vf[spar=\big]$,
$\vf[spar=\Big]$,
$\vf[spar=\bigg]$,
$\vf[spar=\Bigg]$,
$\vf[spar=auto]$
\end{LTXexample}
So returning to the above example, we can write
\begin{LTXexample}
$\vf[1,res=\vV,spar,conj,op,spar=\big,0,inv,spar=\Big,mod=\vI,spar=\bigg,dual]{\vx}$
\end{LTXexample}
To adjust the type of parentheses, use the \lstinline!leftspar! and \lstinline!rightspar! keys:
\begin{LTXexample}
$\vf[leftspar={[},rightspar={\}},spar,spar=\Bigg]$
\end{LTXexample}
Occassionally, it is useful to be able to input a particular kind of parentheses just once,
without adjusting any settings. For this purpose, we have the (previously mentioned)
\lstinline!otherspar!~key. It uses the syntax~\lstinline!otherspar={opening parenthesis}{closing parenthesis}!:
\begin{LTXexample}
$\vf[otherspar={[}{)},otherspar={\{}{\rangle},
	spar]$
\end{LTXexample}


\chapter{The \texttt{command} key}

Above, we used the key \lstinline!overline! a couple of times:
\begin{LTXexample}
$\va[overline]$,
$\vH[overline]$
\end{LTXexample}
This command applies the command \lstinline!\overline!
to the symbol. In fact, you can create similar commands yourself via
the \lstinline!command! key.
In fact, you could have defined the \lstinline!overline! yourself as follows:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{overline}{command=\noexpand\overline},
	},
}
\end{lstlisting}
\setupclass{var}{
	novaluekeys={
		{overline}{command=\noexpand\overline},
	},
}
This is how the key \lstinline!overline! is defined internally, except it is defined on the level of the superclass \lstinline!automathvariable! instead. We need the key \lstinline!\noexpand! in order for everything to expand properly. This is only necessary for some commands, and to tell the truth, I haven't quite figured out the system of which commands need it and which ones do not. However, as usual, if something does not work, try throwing in some \lstinline!\noexpand!'s and see if it solves the problem.
Here are some more examples of predefined keys that use the command key:
\begin{lstlisting}
\setupclass{var}{ % do not add these -- they are already predefined!
	novalueskeys={
		{smash}{command=\noexpand\smash},
		{tilde}{command=\noexpand\tilde},
		{widetilde}{command=\widetilde},
		{bar}{command=\noexpand\bar},
		{bold}{command=\noexpand\mathbf},
		{roman}{command=\noexpand\mathrm},
	},
}
\end{lstlisting}
Let us test:
\begin{LTXexample}
$\va[widetilde]$,
$\va[bold]$,
$\va[roman]$,
$\va[bar]$
\end{LTXexample}

\chapter{The \texttt{return} keys}\label{ch:return}

Suppose you want to take the complex conjugate of the variable~\( \vz[1] \). Then you might write something like
\begin{LTXexample}
$\vz[1,conj]$
\end{LTXexample}
Notice that the bar has only been added over the~\( \vz \), as is standard mathematical typography; you do not normally write~\( \vz[1,return,conj] \).
This reveals a design choice that has been made in \semantex:
When you add an index or a command via the \lstinline{command} key,
it is not immediately applied to the symbol.
Rather, both commands and indices are added to a register and are then applied at the very last, right before the symbol is printed.
This allows us to respect standard mathematical typography, as shown above.

However, there are other times when this behaviour is not what you want.
For instance, if you want to comjugate the inverse of a function, the following looks wrong:
\begin{LTXexample}
$\vf[inv,conj]$
\end{LTXexample}
Therefore, there is a command \lstinline!return! that can be applied at any point to invoke the routine of adding all indices and commands to the symbol. Let us try it out:
\begin{LTXexample}
$\vf[inv,return,conj]$
\end{LTXexample}
In fact, \lstinline!return! is an umbrella key that invokes three different return routines: \lstinline!leftreturn!, \lstinline!innerreturn!, and \lstinline!rightreturn!. The command \lstinline!leftreturn! adds the left indices to the symbol (we have not discussed left indices yet, though). The command \lstinline!innerreturn! adds all commands to the symbol (those defined using the \lstinline!command!~key).
Finally, \lstinline!rightreturn! adds all right indices and arguments to the symbol.
In general, the user should probably be satisfied with just using \lstinline!return!.

\chapter{Example: Algebraic geometry}

Let us discuss how to typeset sheaves and operations on morphisms in algebraic geometry.
First of all, adding commands for sheaves is not a big deal:
\begin{lstlisting}
\newvar\sheafF{\mathcal{F}}
\newvar\sheafG}{\mathcal{G}}
\newvar\sheafH{\mathcal{H}}
\newvar\sheafO{\mathcal{O}}
\newvar\sheafHom{\mathcal{H}\!\!om}
\end{lstlisting}
You can of course add as many sheaf commands as you need.
Also, to make notations shorter, you could consider
calling the commands~\lstinline!\shF!, \lstinline!\shG!, \lstinline!\shH!, \lstinline!\shO!, and~\lstinline!\shHom! instead, as I usually do.
You may also want to have a separate command~\lstinline!shreg!
for the sheaf~\( \sheafO \)
of regular functions.

Next, for morphisms of schemes~\( \vf \colon \vX \to \vY \),
we need to be able to typeset comorphisms as well as the one hundred thousand different pullback and pushforward operations. For this, we add some keys to the \lstinline!var! key:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{comor}{upper=\#},
			% comorphisms, i.e. f^{\#}
		{inverseimage}{upper={-1},nopar},
			% inverse image of sheaves
		{shpull}{upper=*,nopar},
			% sheaf *-pullback
		{shpush}{lower=*,nopar},
			% sheaf *-pushforward
		{sh!pull}{upper=!,nopar},
			% sheaf !-pullback
		{sh!push}{lower=!,nopar},
			% sheaf !-pushforward
	},
}
\end{lstlisting}
\setupclass{var}{
	novaluekeys={
		{comor}{upper=\#},
			% comorphisms, i.e. f^{\#}
		{inverseimage}{upper={-1},nopar},
			% inverse image of sheaves
		{shpull}{upper=*,nopar},
			% sheaf *-pullback
		{shpush}{lower=*,nopar},
			% sheaf *-pushforward
		{sh!pull}{upper=!,nopar},
			% sheaf !-pullback
		{sh!push}{lower=!,nopar},
			% sheaf !-pushforward
	},
}
We have added the command \lstinline!nopar! to all pullback and pushforward commands since it is custom to write, say,~\( \vf[shpull]{\sheafF} \) rather than~\( \vf[shpull,par]{\sheafF} \). Of course, you can decide that for yourself, and in any case, you can write~\lstinline!\vf[shpull,par]{\shF}! if you want to force it to use parentheses in a particular case. Of course, since all \semantex variables can be used as functions, so can whatever these pullback and pushforward operations output. So we may write:
\begin{LTXexample}
For a morphism~$ \vf \colon
\vX \to \vY $ with
comorphism~$ \vf[comor]
\colon \sheafO[\vY] \to
\vf[shpush]{\sheafO[\vX]} $,
and for a sheaf~$ \sheafF $ on~$ \vY $, we can define the
pullback~$ \vf[shpull]{
\sheafF} $ by letting~$
\vf[shpull]{ \sheafF}{\vU} = \cdots $ and the $ ! $-pullback by letting~$
\vf[sh!pull]{\sheafF}{\vU} = \cdots $.
\end{LTXexample}
Maybe some people would write \lstinline!pull!, \lstinline!push!, etc.~instead, but there are other things in math called pullbacks, so I prefer to use the \lstinline!sh!~prefix to show that this is for sheaves.
Probably, in the long run, an algebraic geometer might also want
to abbreviate~\lstinline!inverseimage! to~\lstinline!invim!.

There are a number of other operations we might want to do for sheaves. We already defined the key~\lstinline!res! for restriction, so there is no need to define this again.
However, we might need to stalk, sheafify, take dual sheaves, and twist sheaves. Let us define keys for this:
\begin{lstlisting}
\setupclass{var}{
	valuekeys={
		{stalk}{clower={#1}},
		{twist}{return,symbolputright={(#1)}},
	},
	novaluekeys={
		{sheafify}{upper=+},
		{shdual}{upper=\vee},
	},
}
\end{lstlisting}
\setupclass{var}{
	valuekeys={
		{stalk}{clower={#1}},
		{twist}{return,symbolputright={(#1)}},
	},
	novaluekeys={
		{sheafify}{upper=+},
		{shdual}{upper=\vee},
	},
}
The key \lstinline!clower! stands for \enquote{comma-lower}.
It is like \lstinline!lower!, except that it checks whether the index
is already non-empty, and if so, it separates the new index from the previous index by a comma. There is, of course, a \lstinline!cupper!~key that does the same with the upper index.
\begin{LTXexample}
$\sheafF[res=\vU,stalk=\vp]$,
$\sheafF[res=\vU,spar,stalk=
\vp]$, 
$\sheafO[\vX,stalk=\vp]$,
$\sheafG[sheafify]$,
$\vf[inverseimage]{\sheafO[
\vY]}[spar,stalk=\vx]$
$\sheafG[shdual]$,
$\sheafO[\vX][twist=-1]$,
$\sheafO[twist=1,shdual]$
\end{LTXexample}

\chapter{Example: Homological algebra}

Before you venture into homological algebra, you should probably
define some keys for the standard constructions:

\begin{lstlisting}
\newvar\Hom{\operatorname{Hom}}
\newvar\Ext{\operatorname{Ext}}
\newvar\Tor{\operatorname{Tor}}
\end{lstlisting}
\newvar\Ext{\operatorname{Ext}}
\newvar\Tor{\operatorname{Tor}}
Now the ability to easily print indices via the options key will come in handy:
\begin{LTXexample}
$\Hom[\vA]{\vM,\vN}$,
$\Ext[\vA]{\vM,\vN}$
\end{LTXexample}
\setupclass{var}{
valuekeys={
		{shift}{ return,symbolputright={ \relax [ {#1} ] } },
		% \relax is necessary since otherwise [...] can
		% occasionally be interpreted as an optional argument
	},
}
You will probably need several keyval interfaces, some of which will be covered below. But right now, we shall implement a shift operation~\( \vX\mapsto\vX[shift=\vn] \):
\begin{lstlisting}
\setupclass{var}{
	valuekeys={
		{shift}{ return,symbolputright={ \relax [ {#1} ] } },
		% \relax is necessary since otherwise [...] can
		% occasionally be interpreted as an optional argument
	},
}
\end{lstlisting}
Let us see that it works:
\begin{LTXexample}
$\vX\mapsto\vX[shift=\vn]$
\end{LTXexample}

\section{The keys \texttt{i = index} and \texttt{d = deg = degree}}

Homological algebra is a place where people
have very different opinions about the positions of the gradings.
As an algebraist, I am used to \emph{upper} gradings (\enquote{cohomological} grading), whereas many topologists prefer \emph{lower} gradings (\enquote{homological} grading). The \semantex system
supports both, but the default is upper gradings (the package author has the privilege to decide).
You can adjust this by writing
\lstinline!gradingpos=upper! or~\lstinline!gradingpos=lower!.


We already learned about the keys \lstinline!upper! and~\lstinline!lower!.
There are two more, \enquote{relative} keys that print the index either as an upper index or as a lower index, depending on your preference for cohomological or homological grading. They are called
\begin{center}
	\lstinline!index!
	\qquad\qquad and\qquad\qquad
	\lstinline!degree!
\end{center}
The \lstinline!degree! is the actual grading in the homological algebra
sense. The \lstinline!index! is an additional index where you can put extra information that you might need.
To understand the difference, keep the following two examples
in mind: the hom complex~\( \Hom[*,index=\vA] \) and the simplicial homology~\( \ho[*,index=\vDelta] \) (we will define the command~\lstinline!\ho! for homology in the next section):
\begin{LTXexample}
$\Hom[index=\vA,degree=0]$,
$\ho[index=\vDelta,degree=1]$
\end{LTXexample}
These names are not perfect; many people would say that the degree is also
an index, but feel free to come up with a more satisfactory naming principle, and I shall be happy to consider it. These names probably become a bit too heave to write in the long run, so both keys have abbreviated equivalents:
\begin{center}
	\lstinline!i! = \lstinline!index!
	\qquad\qquad and\qquad\qquad
	\lstinline!d! = \lstinline!deg! = \lstinline{degree}
\end{center}
Let us see them in action:
\begingroup\begin{LTXexample}
$ \vX[d=3,i=\vk] $

\setupobject\vX{
	gradingpos=lower
}

$ \vX[d=3,i=\vk] $
\end{LTXexample}\endgroup
\noindent (We haven't seen the command \lstinline!\setupobject! before, but I imagine you can guess what it does).
If you want to print a bullet as the degree, there is the predefined key~\lstinline!*! for this:
\begingroup\begin{LTXexample}
$ \vX[*] $

\setupobject\vX{
	gradingpos=lower
}

$ \vX[*] $
\end{LTXexample}\endgroup

I guess it is also time to reveal that the previously mentioned shorthand notation~\lstinline!\vx[1]! for indices always prints the~\lstinline!1! on the \lstinline{index} position. So changing the grading position changes the position of the index:
\begingroup\begin{LTXexample}
$ \vX[1] $

\setupobject\vX{
	gradingpos=lower
}

$ \vX[1] $
\end{LTXexample}\endgroup
In other words, in the first example above, we could have written
\begin{LTXexample}
$\Hom[\vA,d=0]$,
$\ho[\vDelta,d=1]$
\end{LTXexample}


Note that the use of the short notations \lstinline!d! and~\lstinline!i! does not mean you cannot write e.g. \lstinline!\vx[d]! and~\lstinline!\vx[i]!.
In fact, this is not the case:
\begin{LTXexample}
$\vf[i]$, $\vf[i=]$,
$\vf[d]$, $\vf[d=]$
\end{LTXexample}
As we see, it is only when a \lstinline!d! or~\lstinline!i! key is followed by an equality sign~\lstinline!=!
that the routines of these keys are invoked.
In fact, \semantex carefully separates
\lstinline!valuekeys! from \lstinline!novaluekeys!.

\section{The \texttt{cohomology} class type}

Now homological algebra is hard unless we can do \emph{cohomology} and \emph{homology}. In principle, this is not hard
to do, as we can write e.g.~\lstinline!\vH[d=0]{\vX}! to get~\( \vH[d=0]{\vX} \).
However, some people might find it cumbersome to have to write~\lstinline!d=! every time you want to print an index.
This is probably the right time to reveal that \semantex supports multiple class \emph{types}.
So far, we have been exclusively using the \lstinline!variable!
class type, but there are several others.
The first one we shall need is the \lstinline!cohomology! class type, which has a different input syntax that fits cohomology.
Let us try to use it:
\begin{lstlisting}
\newcohomologyclass{cohomology}[parent=var,gradingpos=upper]

\newcohomology\co{H}

\newcohomologyclass{homology}[parent=cohomology,gradingpos=lower]

\newhomology\ho{H}
\end{lstlisting}
The cohomology command~\lstinline!\co! in general works very much
like a command of variable type. However, the input syntax is a bit different:
\begin{lstlisting}
\co[options]{degree}{argument}
\end{lstlisting}
All three arguments are optional. Let us see it in practice:
\begin{LTXexample}
$\co{0}$, $\co{*}$,
$\co{\vi}{\vX}$,
$\co[\vG]{0}$,
$\co[\vH]{*}$,
$\co[\vDelta]{\vi}{\vX}$
\end{LTXexample}

\begin{LTXexample}
$\ho{0}$, $\ho{*}$,
$\ho{\vi}{\vX}$,
$\ho[\vG]{0}$,
$\ho[\vH]{*}$,
$\ho[\vDelta]{\vi}{\vX}$
\end{LTXexample}
Of course, you can define similar commands for cocycles, coboundaries, and all sorts of other entities that show up in homological algebra.

You might also want to implement feature like reduced cohomology, \v{C}ech cohomology,
and hypercohomology. This is quite easy with the \lstinline!command! key:
\begin{lstlisting}
\setupclass{var}{
	novaluekeys={
		{reduced}{command=\widetilde},
		{cech}{command=\noexpand\check},
		{hyper{command=\noexpand\mathbb},
	},
}
\end{lstlisting}
\setupclass{var}{
	novaluekeys={
		{reduced}{command=\widetilde},
		{cech}{command=\noexpand\check},
		{hyper}{command=\noexpand\mathbb},
	},
}

\begin{LTXexample}
$\co[reduced]{i}$,
$\co[cech]{*}$,
$\co[hyper,cech]{0}{\vX}$
\end{LTXexample}

The cohomology class also provides a nice way
to implement derived functors:
\begin{lstlisting}
\newcohomology\Lder{\mathbb{L}}[nopar]
\newcohomology\Rder{\mathbb{R}}[nopar]
\end{lstlisting}
\newcohomology\Lder{\mathbb{L}}[nopar]
\newcohomology\Rder{\mathbb{R}}[nopar]
For instance, we can write
\begin{LTXexample}
$\Lder{\vi}{\vf}$,
$\Rder{0}{\vf}$
\end{LTXexample}

Alternatively, the user might prefer to use keyval syntax
on the level of the function itself (\( \vf \)~in this case).
This can be done the following way:
\begin{lstlisting}
\setupclass{var}{
	valuekeys={
		{Lder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{L}^{#1},
		},
		{Rder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{R}^{#1},
		},
	},
	novaluekeys={
		{Lder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{L},
		},
		{Rder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{R},
		},
	},
}
\end{lstlisting}
\setupclass{var}{
	valuekeys={
		{Lder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{L}^{#1},
		},
		{Rder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{R}^{#1},
		},
	},
	novaluekeys={
		{Lder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{L},
		},
		{Rder} {
			innerreturn,leftreturn,
			symbolputleft=\noexpand\mathbb{R},
		},
	},
}
Then the syntax becomes:
\begin{LTXexample}
$\vF[Lder=\vi]$,
$\vF[Lder]{\vX[*]}$,
$\vF[Rder]{\vX[*]}$,
$\Hom[Rder]{\vX,\vY}$
\end{LTXexample}
If you get tired of having to write \lstinline!\Hom[Rder]! all
the time, you can create a shortcut:
\begin{lstlisting}
\newvar\RHom[copy=\Hom,Rder]
\end{lstlisting}
\newvar\RHom[copy=\Hom,Rder]
The \lstinline!copy! key is like the \lstinline!parent! key,
except it allows you to inherit the settings from an \emph{object} rather than a \emph{class}. Notice that we did not specify a symbol; the symbol argument is optional, and in this case, it was unnecessary, as the symbol was inherited from~\lstinline!\Hom!. Let us see it in action:
\begin{LTXexample}
$\RHom{\vX,\vY}$
\end{LTXexample}

\section{Keyval syntax in arguments (Example: Cohomology with coefficients)}

\setupclass{var}{
	argvaluekeys={
		{coef}{ sep={;}{#1}  },
	},
}

Imagine we want to do cohomology with coefficients in some ring~\( \vR \).
It is common to write this as~\( \co{*}{\vX,coef=\vR} \)
with a semicolon instead of a comma. This can be implemented, too, with the syntax
\begin{LTXexample}
$\co{*}{\vX,coef=\vR}$
\end{LTXexample}
This shows that arguments of functions also support keyval syntax.
In order to customize this, there are two extra keys:
\begin{center}
\lstinline!argnovaluekeys!
\qquad\qquad\text{and}\qquad\qquad
\lstinline!argvaluekeys!
\end{center}
These work exactly like \lstinline!novaluekeys! and~\lstinline!valuekeys!.
\begin{lstlisting}
\setupclass{var}{
	argvaluekeys={
		{coef}{ sep={;}{#1}  },
	},
}
\end{lstlisting}
(But it will not quite work yet -- stay tuned for a moment!)
The key \lstinline!sep! is a key that controls the separator
between the current argument and the previous argument (it will only be printed if there was a previous argument). By default, this separator is a comma. So in the syntax~\lstinline!\co{*}{\vX,coef=\vR}!,
there are two arguments, \lstinline!\vX! and~\lstinline!\vR!, and the separator is a semicolon.

However, even with the above setup, the notation \lstinline!\co{*}{\vX,coef=\vR}! will not work
just yet. For the keys you define using \lstinline!argvaluekeys!
are turned off by default. To turn them on for the object~\lstinline!\co!, run the following code:
\begin{lstlisting}
\setupobject\co{
	valuekeys={
		{arg}{argwithkeyval={#1}},
	},
}
\end{lstlisting}
The reason the keys are turned off by default is that keys in arguments that support values are only used in very rare cases, like cohomology with coefficients. If such keys were turned on in general, it would mess up
every occurrence of an equality sign in arguments, and the following
would not work:
\begin{LTXexample}
$\Hom[\sheafO[\vU]]{
	\sheafF[res=\vU],
	\sheafG[res=\vU]
}$
\end{LTXexample}

It should be noted that there are several predefined
keys (of type \mbox{\lstinline!novaluekey!)} which are defined on the level
of the class \lstinline!semantexvariable!. The full list is:\fxfatal{Finish this}

\begin{itemize}
	\item slot, \ldots
\end{itemize}

We should also talk about the \lstinline!arg! key.

\section{The \texttt{binary} class type (Example: Derived tensor products and fibre products)}

\newbinaryclass{binaryoperator}[
	novaluekeys={
		{Lder}{upper=L},
		{Rder}{upper=R},
	},
	mathbin, % this makes sure that the output is wrapped in \mathbin
]

\newbinaryoperator\tens{\otimes}[
	novaluekeys={
		{der}{Lder},
	},
]

\newbinaryoperator\fibre{\times}[
	% Americans are free to call it \fiber instead
	novaluekeys={
		{der}{Rder},
	},
]

The \semantex system has facilities for printing tensor products~\( \tens \) as well as derived tensor products~\( \tens[der] \).
For this, we need the \lstinline!binary! class type.
This has exactly the same syntax as the \lstinline!variable!
class type, except that it cannot take an argument. In other words,
its syntax is
\begin{lstlisting}
\command[options]
\end{lstlisting}
Let us try to use it to define tensor products and fibre products:
\begin{lstlisting}
\newbinaryclass{binaryoperator}[
	novaluekeys={
		{Lder}{upper=L},
		{Rder}{upper=R},
	},
	mathbin,
	% this makes sure that the output is wrapped in \mathbin
]

\newbinaryoperator\tens{\otimes}[
	novaluekeys={
		{der}{Lder},
	},
]

\newbinaryoperator\fibre{\times}[
	% Americans are free to call it \fiber instead
	novaluekeys={
		{der}{Rder},
	},
]
\end{lstlisting}
As you see, this is one of the few cases where I recommend adding keyval
syntax on the level of subclasses. Also, notice that it does not have any~\lstinline!parent=var!, as I do not really see any reason to inherit all the keyval syntax from the \lstinline!var!~class.
Now we first define keys \lstinline!Lder! and~\lstinline!Rder! for left and right derived binary operators. Next, we build in a shortcut in both \lstinline!\tens! and~\lstinline!\fibre!
so that we can write simply~\lstinline!der! and get the correct notion of derived functor. Let us see it in action:
\begin{LTXexample}
$\vA \tens \vB$,
$\vX[*] \tens[\vR] \vY[*]$
$\vk \tens[\vA,der] \vk$,
$\vX \fibre[\vY,der] \vX$
\end{LTXexample}

\chapter{The \texorpdfstring{\texttt{$\backslash$⟨classname⟩}}{classname} command}

So far, we have learned that every mathematical entity should be treated
as an object of some class. However, then we run into issues the moment we
want to write expressions like
\[
	\var{\vf\circ\vg}[spar,der=\vn]{\vx}.
\]
We do not want to have to define a new variable
with symbol~\( \vf\circ\vg \) in order to write something like this.
Fortunately, once you have created the class~\lstinline!var!,
you get an extra command~\lstinline!\var! that has the following syntax
\begin{lstlisting}
\var{symbol}[options]{argument}
\end{lstlisting}
In other words, it allows you to create a variable on the spot and give in an arbitrary symbol. So the above equation can be written
\begin{LTXexample}
$\var{\vf\circ\vg}[
	spar,der=\vn]{\vx}$
\end{LTXexample}
More generally, whenever you create a class with name \lstinline!⟨classname⟩!, you automatically get a command
named~\lstinline!\⟨classname⟩!.
It has the same input syntax as the class in question,
except that, as above, the first argument is the symbol:
\begin{lstlisting}
\⟨classname⟩{symbol}⟨usual syntax of class⟩
\end{lstlisting}

Actually, now might be the right time to reveal that the low-level machinery in \semantex does not actually see the difference between an object and a class. Yep, this is how it has been implemented, and there are probably some object-oriented purists who will say that this goes against some general programming philosophy nonsense. So when you create the class \lstinline!⟨classname⟩!, you really create the above object which has a special syntax. And now all other objects of that class simply inherit from this object. (As we saw from above, you can actually inherit from any object; you just write~\lstinline!copy=\objectname! instead of using \lstinline!parent!.)

\chapter{Class types}

The \semantex system uses several different \emph{class types}.
We have been almost exclusively using the \lstinline!variable! class type (which is by far the most important one), but in the last section, we were introduced to the \lstinline!cohomology! and the \lstinline!binary! class types.

In fact, all class types are identical internally; the low-level machinery of \semantex does not \enquote{know} what type a class has.
The only difference between the class types is the \emph{input syntax}.
In other words, it determines which arguments an object of that class
can take. The syntax for creating new objects
also varies.

The current implementation has the following
class types:

\begin{itemize}
	\item \lstinline!variable!:
	A new class is declared with the
	syntax
	\begin{lstlisting}
		\newvariableclass{⟨classname⟩}[options]
	\end{lstlisting}
	A new object is declared by
	\begin{lstlisting}
		\new⟨classname⟩\⟨objectname⟩{symbol}[options]
	\end{lstlisting}
	The syntax for this object is
	\begin{lstlisting}
		\⟨objectname⟩[options]{argument}
	\end{lstlisting}
	\item \lstinline!cohomology!:
	A new class is declared with the
	syntax
	\begin{lstlisting}
		\newcohomologyclassclass{⟨classname⟩}[options]
	\end{lstlisting}
	A new object is declared by
	\begin{lstlisting}
		\new⟨classname⟩\⟨objectname⟩{symbol}[options]
	\end{lstlisting}
	The syntax for this object is
	\begin{lstlisting}
		\⟨objectname⟩[options]{degree}{argument}
	\end{lstlisting}
	\item \lstinline!binary!:
	A new class is declared with the
	syntax
	\begin{lstlisting}
		\newdelimiterclass{⟨classname⟩}[options]
	\end{lstlisting}
	A new object is declared by
	\begin{lstlisting}
		\new⟨classname⟩\⟨objectname⟩{left bracket}{right bracket}[options]
	\end{lstlisting}
	The syntax for this object is
	\begin{lstlisting}
		\⟨objectname⟩[options]{argument}
	\end{lstlisting}
	\item \lstinline!delimiter!:
	A new class is declared with the syntax
	\begin{lstlisting}
		\newtupleclass{⟨classname⟩}[options]
	\end{lstlisting}
	A new object is declared by
	\begin{lstlisting}
		\new⟨classname⟩\⟨objectname⟩{left bracket}{right bracket}[options]
	\end{lstlisting}
	The syntax for this object is
	\begin{lstlisting}
		\⟨objectname⟩[options]{argument}
	\end{lstlisting}
\end{itemize}

Let me add that \semantex uses a very clear separation between the input syntax and the underlying machinery. Because of this, if the user needs a different kind of class type, it is not very hard to create one. You must simply open the source code of \semantex, find the class you want to modify, and then copy the definition of the command~\lstinline!\new⟨class type⟩class! and modify it in whatever way you want.

\chapter{The \texorpdfstring{\texttt{delimiter}}{delimiter} class type}

\newdelimiterclass{delim}[parent=var]
\newdelim\norm{\lVert}{\rVert}
\newdelim\inner{\langle}{\rangle}

Delimiters are what they sound like: functions like \( \norm{slot} \) and~\( \inner{slot,slot} \)
that are defined using brackets only. Let us define a class of type delimiter:
\begin{lstlisting}
\newdelimiterclass{delim}[parent=var]
\end{lstlisting}
Now we get a command \lstinline!\newdelim! with the following syntax:
\begin{lstlisting}
\newdelim\⟨objectname⟩{left bracket}{right bracket}[options]
\end{lstlisting}
Now we can do the following:
\begin{lstlisting}
\newdelim\norm{\lVert}{\rVert}
\newdelim\inner{\langle}{\rangle}
\end{lstlisting}
Indeed:
\begin{LTXexample}
$\norm{\va}$,
$\inner{\va,\vb}$,
$\inner{slot,slot}$
\end{LTXexample}
We can also use it for more complicated constructions, like sets.
\begin{lstlisting}
\newcommand\where{
	\nonscript\:
	\semantexdelimsize\vert
	\allowbreak
	\nonscript\:
	\mathopen{}
}

\newdelim\Set{\lbrace}{\rbrace}[
	prearg={\,},postarg={\,},
	% adds \, inside {...}, as recommended by D. Knuth
	valuekeys={
		{arg}{argwithoutkeyval={#1}},
		% this turns off all keyval syntax in the argument
	}
]
\end{lstlisting}
\newcommand\where{
	\nonscript\:
	\semantexdelimsize\vert
	\allowbreak
	\nonscript\:
	\mathopen{}
}

\newdelim\Set{\lbrace}{\rbrace}[
	prearg={\,},postarg={\,},
	% adds \, inside {...}, as recommended by D. Knuth
	valuekeys={
		{arg}{argwithoutkeyval={#1}},
		% this turns off all keyval syntax in the argument
	}
]
Now you can use
\begin{LTXexample}
$\Set{ \vx \in \vY \where
\vx \ge 0 }$
\end{LTXexample}
Don't forget that anything created with \semantex
outputs as a variable-type object. So you can do stuff like
\begin{LTXexample}
$\Set{
	\vx \in \vY[\vi]
	\where
	\vx \ge 0
}[conj,\vi\in\vI]$
\end{LTXexample}


Tuple-like commands are also possible:
\begin{lstlisting}
\newdelim\tup{(}{)} % tuples
\newdelim\pcoor{[}{]}[ % projective coordinates
	argsep=\mathpunct{:}, % changes the argument separator to :
	argdots=\cdots, % changes what is inserted if you write "..."
]
\end{lstlisting}
\newdelim\tup{(}{)} % tuples
\newdelim\pcoor{[}{]}[ % projective coordinates
	argsep=\mathpunct{:}, % changes the argument separator to :
	argdots=\cdots, % changes what is inserted if you write "..."
]
Let us see them in action:
\begin{LTXexample}
$\tup{\va,\vb,...,\vz}$,
$\pcoor{\va,\vb,...,\vz}$
\end{LTXexample}

One can also use tuples for other, less obvious purposes, like calculus differentials:
\begin{lstlisting}
\newdelimiterclass{calculusdifferential}[
	parent=var,
	argvaluekeys={
		{default}{standardsep={d\!#1}},
	},
	argdots=\cdots,
	ifpar=false,
]
	
\newcalculusdifferential\intD{(}{)}[argsep={\,},iffirstarg=false]

\newcalculusdifferential\wedgeD{(}{)}[argsep=\wedge]
\end{lstlisting}
\newdelimiterclass{calculusdifferential}[
	parent=var,
	argvaluekeys={
		{default}{standardsep={d\!#1}},
	},
	argdots=\cdots,
	ifpar=false,
]
	
\newcalculusdifferential\intD{(}{)}[argsep={\,},iffirstarg=false]

\newcalculusdifferential\wedgeD{(}{)}[argsep=\wedge]

\begin{LTXexample}
$\int \vf \intD{\vx[1],\vx[2],...,\vx[n]}$,

$\int \vf \wedgeD{\vx[1],\vx[2],...,\vx[n]}$
\end{LTXexample}

\chapter{The \texttt{execute} and \texttt{parseoptions} keys}

As you can see above, \semantex has a ``waterfall-like'' behaviour. It parses keys in the order it receives them. This works fine most of the time, but for some more complicated constructions, it is useful to be able to provide a data set in any order and have them printed in a fixed order. For this purpose, we have the \lstinline!execute! and \lstinline!parseoptions!~keys.

\newvar\Mat{\operatorname{Mat}}[
	execute={
		\semantexdataprovide{rows}
		\semantexdataprovide{columns}
	},
	valuekeys={
		{rows}{
			execute={
				\semantexdataset{rows}{#1}
			},
		},
		{columns}{
			execute={
				\semantexdataset{columns}{#1}
			},
		},
	},
	parseoptions={
		execute={
			\semantexstrifeq{\semantexdatagetexpnot{columns}}{\semantexdatagetexpnot{rows}}
			{
				\semantexsetkeysx{
					lower={
						\semantexdatagetexpnot{columns}
					}
				}
			}
			{
				\semantexsetkeysx{
					lower={
						\semantexdatagetexpnot{rows}
						\times
						\semantexdatagetexpnot{columns}
					}
				}
			}
		},
	},	
]

Suppose we want to be able to write the set of \( \vn \times \vm \)-matrices with entries in~\( \vk \) as~\( \Mat[rows=\vn,columns=\vm]{\vk} \). We can in principle do the following:
\begin{LTXexample}
$ \Mat[\vn\times\vm]{\vk} $.
\end{LTXexample}
However, this is not quite as systematic and semantic as we might have wanted. Indeed, what if later you would like to change the notation to~\( \Mat[\vn,\vm]{\vk} \)?
Therefore, we do something like the following instead (we explain the notation below):
\begin{lstlisting}
\newvar\Mat{\operatorname{Mat}}[
	execute={
		\semantexdataprovide{rows}
		\semantexdataprovide{columns}
		 % provides data sets for number of rows and columns
		 % for this object
	},
	valuekeys={
		{rows}{
			execute={
				\semantexdataset{rows}{#1}
			},
		},
		{columns}{
			execute={
				\semantexdataset{columns}{#1}
			},
		},
	},
	parseoptions={
		execute={
			\semantexstrifeq{\semantexdatagetexpnot{columns}}
			{\semantexdatagetexpnot{rows}}
			% tests if rows = columns
			{
				\semantexsetkeysx{
					lower={
						\semantexdatagetexpnot{columns}
					}
				}
			}
			{
				\semantexsetkeysx{
					lower={
						\semantexdatagetexpnot{rows}
						\times
						\semantexdatagetexpnot{colums}
					}
				}
			}
		},
	},	
]
\end{lstlisting}
Now we can do the following:
\begin{LTXexample}
$ \Mat[rows=\vn,columns=\vm]{\vk} $, $ \Mat[rows=\vn,columns=\vn]{\vk} $
\end{LTXexample}

The key~\lstinline!execute! is a key that basically just executes code. You can in principle write any \TeX\ code there, and it will be applied right at the spot. However, inside the \lstinline!execute!~key, you can also use the following locally defined commands. These can be used to handle the data that is associated with the object in question:
\begin{lstlisting}
\semantexdataprovide{name} % provides a data set with this name
\semantexdataset{name}{value} % sets the data set
\semantexdatasetx{name}{value} % sets the data set, but fully expands the argument
\semantexdataputright{name}{value} % adds something to the right of the data set
\semantexdataputrightx{name}{value} % the same, but fully expands first
\semantexdataputleft{name}{value} % adds something to the left of the data set
\semantexdataputleftx{name}{value} % the same, but fully expands first
\semantexdataget{name}{value} % outputs the data set
\semantexdatagetexpnot{name}{value} % outputs the data set wrapped in a \noexpand
\semantexdataclear{name} % clears the data set
\semantexsetkeys{keys} % sets keys
\semantexsetkeysx{keys} % sets keys after expanding
\semantexstrifeq{str1}{str2}{if true}{if false} % tests if str1 = str2
\semantexboolprovide{name} % provides a boolean
\semantexboolsettrue{name} % sets the boolean to true
\semantexboolsetfalse{name} % sets the boolean to false
\semantexboolif{name}{if true}{if false} % tests the boolean
\end{lstlisting}

The key~\lstinline!parseoptions! is a key that is executed right before rendering the object.  This is where you write whatever the system is supposed to \emph{do} with the data sets you provide.

\chapter{Bugs}

The most important current (known) bug happens if you create a variable whose symbol is a mathematical operator. For instance, write
\begin{lstlisting}
\newvar\Int{\int}
\end{lstlisting}
\newvar\Int{\int}

\begin{LTXexample}
$\int$ \\
$\Int$ \\
See the difference: \rlap{$\int$}$\Int$
\end{LTXexample}
It turns out to be equivalent to the difference between
\lstinline!$\int$! and~\lstinline!${}\int$!. In other words, this~\lstinline!{}!
affects the spacing a tiny bit.
I more or less know where this bug appears, but cannot really solve it without breaking the expansion somewhere else. Suggestions and advice are more than welcome! Then again, even if it affects the spacing a little bit, it still looks fine, only a bit different. 

%\input{testground}

\end{document}