summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ufrgscca/doc/ufrgscca.tex
blob: a29824a5f6a7f1b2bfb5c1c12be18f4a85f04899 (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
% !TEX program = pdflatex
% !TEX ext =  --interaction=nonstopmode --enable-etex --enable-write18
% !BIB program = none
%%%==============================================================================
%% Copyright 2022-23 by Alceu Frigeri
%%
%% This work may be distributed and/or modified under the conditions of
%%
%% * The [LaTeX Project Public License](http://www.latex-project.org/lppl.txt),
%%   version 1.3c (or later), and/or
%% * The [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html),
%%   version 3 (or later)
%%
%% This work has the LPPL maintenance status *maintained*.
%%
%% The Current Maintainer of this work is Alceu Frigeri
%%
%% This is version 1.11 (2023/05/29)
%%
%% The list of files that compose this work can be found in the README.md file at
%% https://ctan.org/pkg/ufrgscca
%%
%%%==============================================================================
%% UFRGS stands for "Federal University of Rio Grande do Sul" in south Brazil
%% EE    stands for "Engineering School"
%% CCA   stands for "Control and Automation Engineering Course" (Portuguese acronym)
%%%==============================================================================
\documentclass[article,nogeometry,english,tocdepth=3,secdepth=3]{ufrgscca} % tcbundle  tcpack tcmain
\usepackage[a4paper,margin=5cm,right=2cm,marginparwidth=3.5cm,asymmetric,top=2.5cm,bottom=1.5cm]{geometry}
\usepackage{codedescribe}
\usepackage{ufrgscca-curr}

%\maxdeadcycles=500 %% the many marginpar statements are actually a pain.

\newif\iffulldoc
%\fulldocfalse
\fulldoctrue

\begin{document}


\iffulldoc
\tstitle{
  author={Alceu Frigeri\footnote{\tsverb{https://github.com/alceu-frigeri/ufrgscca}}},
  date={\monthname\space\number\year},
  title={The ufrgscca, and associated, Packages\\ Version \ufrgsccaversion \\(extended documentation)}
  }
\else
\tstitle{
  author={Alceu Frigeri\footnote{\tsverb{https://github.com/alceu-frigeri/ufrgscca}}},
  date={\monthname\space\number\year},
  title={The ufrgscca, and associated, Packages\\ Version \ufrgsccaversion}
  }
\fi

	\begin{tsabstract}
		This bundled is aimed at producing undergraduate students final work/report at UFRGS/EE (Engineering School at the Federal University of Rio Grande do Sul), closely following ABNT rules (Brazilian Association for Technical Norms). It is composed of a main class, \tsobj[pkg]{ufrgscca}, and a set of auxiliary packages, some of which can be used independently.

	\end{tsabstract}

\tableofcontents

	\section{Introduction}
	\emph{ABNT} rules can be quite challenging some times (read: bibliography style/references) and sometimes just odd (line spacing, front matter, page layout), nevertheless it is a \emph{Brazilian Standard} for typography whose students at UFRGS should grow cherished to follow.

	In short, as of version \ufrgsccaversion\space the bundle is composed of a class, \tsobj[pkg]{ufrgscca} (based on the standard \LaTeX2e \tsobj[pkg]{report} class), which pre-loads all other, as needed, packages: \tsobj[pkg]{ufrgscca-abnt, ufrgscca-core, ufrgscca-cover, ufrgscca\-forms, ufrgscca-gen, ufrgscca-lists, ufrgscca-curr, ufrgscca-coord, ufrgscca-ppc}.

\begin{tsremark}[N.B.:]
	This bundle requires a quite recent \LaTeX2e kernel, at least as recent as June 2022, which allows to declare package options using the \tsobj[key]{key}~=\tsobj[key]{value} system and declare commands with \tsmacro{\NewDocumentCommand}{}, out-of-the-box.
\end{tsremark}

\subsection{Current Version}
For the sake of the “maintainer's sanity”, since this is a bundle, all files are saved with the same version (bundle version), with two exceptions: \tsobj[pkg]{ufrgscca-curr.sty} \tsobj[pkg]{ufrgscca-ppc.sty} which are less tested than the others, and somewhat in what one would call 'beta' state. Better said, all files are version \ufrgsccaversion, except \tsobj[pkg]{ufrgscca-curr} and \tsobj[pkg]{ufrgscca-ppc} whose versions are \ufrgsccacurrversion.

\section{\tightul{ufrgscca} Class}

The following packages are always pre-loaded: \tsobj[pkg]{etex, etoolbox, lmodern, fontenc (T1), inputenc (utf8), silence, ufrgscca-abnt, ufrgscca-gen}, \tsobj[pkg]{ ufrgscca-cover, ufrgscca-core, hyperref} and (if it exists) a \emph{local.tex} file.

Other set of auxiliary packages are also pre-loaded, depending on the class options used, and finally it loads (normally) the \tsobj[pkg]{report} class (the exception being if one uses the \tsobj[option]{dctools} option).

Being based on the report class, one can use all class options one would with a report, plus the ones listed below.
\subsection{Class Options}
\begin{describelist}{option}
	\describe {tocdepth} { use: \tsobj[key]Use{tocdepth}{number}, whereas \tsobj[meta]{number} indicates the deepest sectioning to appears in the Table of Contents (0 being the top section, which is \tsmacro{\chapter}{} for report based classes, 1 being \tsmacro{\section}{}, and so on.) The default value being 3 (\tsmacro{\subsubsection}{}).}

	\describe {secdepth} { use: \tsobj[key]Use{secdepth}{number}, whereas \tsobj[meta]{number} indicates the deepest sectioning to be numbered. (0 being the top section, which is \tsmacro{\chapter}{} for report based classes, 1 being \tsmacro{\section}{}, and so on.) The default value being 4 (\tsmacro{\paragraph}{}).}

	\describe {english} { the default language being Portuguese, this option changes locale to English.}

	\describe {brazilian} { in some rare cases (to be further investigated) babel seems to get confused about which language is active, this “shouldn't be necessary” but one can explicitly tell babel to use THIS language (which should, otherwise, be the default one).}

	\describe {relnum} { by default, figures, tables, etc. are numbered as a continuous series. With this switch, those lists are reset at each chapter, e.g. Figure 5.1 instead of Figure 23.}

	\describe {openright} { in case of printed material, this will assure that a \tsmacro{\chapter}{} always starts at an odd page, which is relevant in case of printing out (double sided) the document.}

	\describe {oneside} { in case the document will be printed in single side sheets, otherwise it's assumed a two-sided printing.}

	\describe {strict-abnt} {to assure asymmetric margins, as defined by ABNT: inner ones greater than outer ones, which matters if you are going to print the doc and make a book of it, but makes it odd to look at in a computer screen, reason by which the current default setting is for symmetric margins (same text width).}

    \describe {pretextontoc} { “pre-text” elements, like “list of$\dots$” will be inserted in the “table of contents”.}

    \describe {yearsonly} { Cover pages, at their bottom, will display the years only (instead of the default mouth year construct).}

    \describe {timesroman} { will set the default font to Roman (using the obsolete mathptmx package, based on  a free replacement of the proprietary 
    Times New Roman (by Microsoft) and Times Roman (By Adobe)) instead of the default Latin Modern Roman font. 
    As a side effect, the package \tsobj[pkg]{microtype} isn't loaded (can't be used), resulting in a sub-optimal overall layout. 
    NB. The alternative (newer and maintained) packages \tsobj[pkg]{newtxtext}/\tsobj[pkg]{newtxmath} can't be used due to some packages incompatibilities.}

	\describe {repeatfields} { in case of authors with multiple publications, their names will be repeated for each entry. 
In the default setting the author's name is written only in the first entry, and replaced by underscores in the other entries.}

	\describe {xlists} { this will load the \tsobj[pkg]{ufrgscca-lists} package, for the definition of new floats/lists.}

	\describe {xpacks} { this will load a series of packages, which can be handy when writing Engineering reports:
       \tsobj[pkg]{relsize, keyval, graphicx, mathtools, mathrsfs, amsfonts, amssymb, empheq, amsthm, ext\-arrows, mathfixs, bigdelim, circuitikz, steimenz} 
       and tikz libraries: \tsobj[pkg]{ fit,  math, calc, shapes.geometry, shapes.misc, shapes.multipart, graphs, 3d, positioning, shadows, babel}. 
       One is advised to look after each package documentation (ctan.org) for further information.}
%\end{describelist}

%\begin{describelist}{option}
 %some random text, inserted here...

	\describe {report} { in case the doc is just a class assignment with, possibly, many co-authors. It changes mainly the front matter, which is simplified (no referral page, for instance).}

	\describe {internship} { in case the doc is an internship report.}

	\describe {nonrequired} { in case the internship report is related to a “non required” / “optional” internship. This option is ignored otherwise.}

	\describe {forms} { in the process of submitting a student final work/report, there is a series of forms to be submitted, this allows the customization  of said forms in a simple  way.}

	\describe {chapternopagenum} { to suppress the page numbers at chapters begin.}

	\describe {nomicrotype} { in some rare cases, \tsobj[pkg]{microtype} might hurt page layout, this allows the suppression of \tsobj[pkg]{microtype}.}

	\describe {showframes} { for layout proof only, it will draw frames around each page main parts.}

	\describe {showlabels} { it will put a reference mark in each label created, and print out it's name.}

	\describe {nofontwarning} { in case of \tsobj[pkg]{ufrgscca-ppc} is loaded, it will suppress some font related warnings.}

	\describe {nolocal} { this will suppress the loading of any local.tex file, which would, otherwise, be loaded.}

	\describe {article} { this will load the  class  \tsobj[pkg]{article} instead of \tsobj[pkg]{report}, it's meant to document the class itself.}

	\describe {nogeometry} { the package \tsobj[pkg]{geometry} won't be loaded. In case one wants to fully customize the page geometry}

	\describe {texlive} { this is a reserved key, in case some workaround for texlive is needed.}

	\describe {overleaf} { this is a reserved key, in case some workaround for overleaf is needed.}

	\describe {miktex} { this is a reserved key, in case some workaround for miktex is needed.}
\end{describelist}

\subsection{Class Declared Commands}
\begin{codedescribe}{\autonameref,\annexref,\autoannexref}
	\begin{codesyntax}%
		\tsobj[code]{\autonameref}{\tsobj[oarg]{sep}\tsobj[marg]{label}\tsobj[oarg]{spc}}
		\tsmacro{\annexref}{label}
		\tsobj[code]{\autoannexref}{\tsobj[oarg]{sep}\tsobj[marg]{label}\tsobj[oarg]{spc}}
	\end{codesyntax}
The \tsobj[pkg]{hyperref} package, sometimes, gets the \tsmacro{\autoref}{} name wrong (when referencing an annex), the \tsmacro{\annexref}{label} will assure the correct annex name is used.

\tsmacro{\autonameref}{label} produces an entry of the form `\tsmacro{\autoref}{label} \tsobj[meta]{sep} \tsmacro{\nameref}{label} \tsobj[meta]{spc}'

\tsmacro{\autoannexref}{label} produces an entry of the form `\tsmacro{\annexref}{label} \tsobj[meta]{sep} \tsmacro{\nameref}{label} \tsobj[meta]{spc}'

The default \tsobj[meta]{sep} being a comma, and the default \tsobj[meta]{spc} being empty space.

\end{codedescribe}

\subsection{Class Known Hooks}
\begin{codedescribe}{\miktexHack,\overleafHack,\livetexHack}
    \begin{codesyntax}%
        \tsmacro{\miktexHack}{}
        \tsmacro{\overleafHack}{}
        \tsmacro{\livetexHack}{}
    \end{codesyntax}
    In case some workaround is needed due an unexpected error (when upgrading packages/\TeX system) the class “knows” about those three hooks.
    They will be executed if, and only if, they are user defined and the corresponding package option is used, i.e., for example, for the hook \tsmacro{\miktexHack}{} to be used/called by the class \tsobj[pkg]{ufrgscca}, one has to: a)~define it and b)~use the class option \tsobj[option]{miktex}.
\end{codedescribe}


\section{\tightul{ufrgscca-abnt} Package}
This package is the one that sets the page layout (using \tsobj[pkg]{geometry, titlesec, titletoc}) and adjusts the main float environments (figure, tables, captions).
It can be used as a stand alone package, regardless of the underlying class.

The following packages are always pre-loaded: \tsobj[pkg]{ babel, csquotes, geometry, appendix, titlesec, titletoc, enumitem, chngctr, caption, biblatex, microtype, array, nicematrix, contour, soul}.

Take note that \tsobj[pkg]{biblatex} is loaded with the \textbf{\tsobj[option]{biber}} option, to correctly handle ABNT biography style.

\subsection{Package Options}


\begin{describelist}{option}
	\describe {strict-abnt} {to assure asymmetric margins, as defined by ABNT: inner ones greater than outer ones, which matters if you are going to print the doc and make a book of it, but makes it odd to look at in a computer screen, reason by which the current default setting is for symmetric margins (same text width).}

 	\describe {chapternopagenum} { to suppress the page numbers at chapters begin.}

	\describe {relnum} { by default, figures, tables, etc. are numbered as a continuous series. With this switch, those lists are reset at each chapter, e.g. Figure 5.1 instead of Figure 23.}

	\describe {repeatfields} { in case of authors with multiple publications, their names will be repeated for each entry. In the default setting the author's name is written only in the first entry, and replaced by underscores in the other entries.}

    \describe {yearsonly} { Cover pages, at their bottom, will display the years only (instead of the default mouth year construct).}
    
  \describe {yearsonly}{ Cover pages, at their bottom, will display the years only, instead of the default mouth year construct.}
  
	\describe {nomicrotype} { in some rare cases, \tsobj[pkg]{microtype} might hurt page layout, this allows the suppression of \tsobj[pkg]{microtype}.}

	\describe {showframes} { for layout proof only, it will draw frames around each page main parts.}

	\describe {showlabels} { it will put a reference mark in each label created, and print out it's name.}

	\describe {tocdepth} { use: \tsobj[key]{tocdepth}=\tsobj[meta]{number}, whereas \tsobj[meta]{number} indicates the deepest sectioning to appears in the Table of Contents (0 being the top section, which is \tsmacro{\chapter}{} for report based classes, 1 being \tsmacro{\section}{}, and so on.) The default value being 3 (\tsmacro{\subsubsection}{}).}

	\describe {secdepth} { use: \tsobj[key]{secdepth}=\tsobj[meta]{number}, whereas \tsobj[meta]{number} indicates the deepest sectioning to be numbered. (0 being the top section, which is \tsmacro{\chapter}{} for report based classes, 1 being \tsmacro{\section}{}, and so on.) The default value being 4 (\tsmacro{\paragraph}{}).}

	\describe {dctools} {  this will change page layout and base class to article, it is meant to document the class itself.}
\end{describelist}


\subsection{Commands}

\begin{codedescribe}{\keyword}
	\begin{codesyntax}%
		\tsmacro{\keyword}{keyword}
	\end{codesyntax}
  This command can be invoked many times, it will construct a list of keywords to be used when printing out the abstract environment.
\end{codedescribe}

\begin{codedescribe}{\sourcecitation,\note}
	\begin{codesyntax}
		\tsmacro{\sourcecitation}{source}
		\tsmacro{\note}{text}
	\end{codesyntax}
When describing floating elements (like figure, tables, circuits) one always has to cite the source of it, and in some cases it might be necessary to add a special note. Those assure uniformity when doing that.
\end{codedescribe}

\begin{codedescribe}{\nonum,\notoc}
	\begin{codesyntax}%
		\tsobj[code]{\nonum}{\tsmacro{\chapter}{chap.title}}
		\tsobj[code]{\nonum}{\tsmacro{\section}{sec.title}}
		\tsobj[code]{\notoc}{\tsmacro{\chapter}{chap.title}}
		\tsobj[code]{\notoc}{\tsmacro{\section}{sec.title}}
	\end{codesyntax}
In some cases, it might be necessary to create a numberless chapters or sections. Those two commands can be used as a \emph{prefix} to any sectioning command. Whilst \tsmacro{\nonum}{} will just suppress the sectioning number, the \tsmacro{\notoc}{} will also suppress it from the table of contents.
\end{codedescribe}

\begin{codestore}[st=demononum]
	\nonum\chapter{some title} %this one will appear in the toc
	\notoc\section{some other title} %this won't even appear in the toc
\end{codestore}
\tscode*[emph={nonum,notoc}]{demononum}

\begin{codedescribe}{\tightul}
	\begin{codesyntax}%
		\tsmacro{\tightul}{text}
	\end{codesyntax}
This will \emph{underline} a short text, take note that \tsobj[meta]{text} `can't be broken' (think paragraph justification), which can lead to \emph{text overflows} and bad justification.
\end{codedescribe}

\begin{codestore}[st=demotight]
	\tightul{Some text example}%
\end{codestore}

\tsdemo[emph={tightul}]{demotight}[-0.75ex]

\begin{codedescribe}{\NewChapListEnv}
	\begin{codesyntax}%
		\tsmacro{\NewChapListEnv}{envname,displayname}
	\end{codesyntax}
\end{codedescribe}
This is the command used to created those \emph{chapter like} lists, like `List of Symbols' or `List of acronyms'. With it, a new environment is created, \tsobj[meta]{envname}, with an associated `numberless' chapter name \tsobj[meta]{displayname}. The newly created environment will implement a \emph{description} like environment (thanks to \tsobj[pkg]{enumitem}) with an optional and a mandatory argument (see below).

\begin{codestore}[st=d.newchapenv]
	\def\listabbrvname{Lista de Abreviaturas}
	\NewChapListEnv{listofabbrv}{\listabbrvname} % this is the actual code used in ufrgscca-abnt.sty
\end{codestore}
\tscode*{d.newchapenv}

\begin{codedescribe}{\date,\today,\monthname}
	\begin{codesyntax}%
		\tsmacro{\date}[day]{month,year}
		\tsmacro{\today}{}
		\tsmacro{\monthname}{}
	\end{codesyntax}
\end{codedescribe}
The command \tsmacro{\date}{} is redefined, to allow a separation between the many arguments \tsobj[meta]{day}, \tsobj[meta]{month} and \tsobj[meta]{year}. If not called by the user it \emph{defaults} to current month / year. \tsmacro{\today}{} returns the current \emph{locale} date, whilst \tsmacro{\monthname}{} returns the \emph{locale} name of the current month.


\subsection{Environments}

\begin{codedescribe}[env]{abstract}
	\begin{codesyntax}%
		\tsmacro{\begin{abstract}}[lang]{keywords}\ldots\tsmacro{\end{abstract}}{}
	\end{codesyntax}
	The standard environment \tsobj[env]{abstract} is redefined as a numberless chapter based on the current locale (default: Portuguese), at the end of it the keywords list created with \tsmacro{\keyword}{} will be added.
\end{codedescribe}

\begin{codestore}[st=d.abstract]
	\keyword{a keyword}
	\keyword{another keyword}
	\begin{abstract} some short summary of things\ldots
	\end{abstract}
\end{codestore}
\tscode*{d.abstract}

\begin{codedescribe}[env]{otherabstract}
	\begin{codesyntax}%
		\tsmacro{\begin{otherabstract}}[lang]{keywords}\ldots\tsmacro{\end{otherabstract}}{}
	\end{codesyntax}
This is the environment to create an abstract in a language other than the default one.
The default value for \tsobj[meta]{lang} is english, and it can be any value that \tsobj[pkg]{babel} understands. The \tsobj[meta]{keywords} are just a list of keywords which will be added at the end of the \emph{otherabstract}.
\end{codedescribe}

\begin{codestore}[st=d.oabstract]
	\begin{otherabstract}[english]{a keyword, another keyword} some short summary of things\ldots
	\end{otherabstract}
\end{codestore}
\tscode*{d.oabstract}


\begin{codedescribe}[env]{listofabbrv,listofsymbols}
	\begin{codesyntax}%
	\tsmacro{\begin{listofabbrv}}[enum-opt]{ABBRV}\ldots\tsmacro{\end{listofabbrv}}{}
	\tsmacro{\begin{listofsymbols}}[enum-opt]{SYMB}\ldots\tsmacro{\end{listofsymbols}}{}
	\end{codesyntax}
\end{codedescribe}
Both environments create a description like list preceded by a numberless (\tsmacro{\nonum}{}) chapter. \tsobj[meta]{enum-opt} is any \tsobj[pkg]{enumitem} list valid key. Whereas \tsobj[meta]{ABBRV} / \tsobj[meta]{SYMB} are just the `biggest' abbreviation/symbol to be used as a tab reference.

\begin{codedescribe}[env]{appendix,annex}
	\begin{codesyntax}%
		\tsmacro{\begin{appendix}}{}.... \tsmacro{\end{appendix}}{}
		\tsmacro{\begin{annex}}{}.... \tsmacro{\end{annex}}{}
	\end{codesyntax}
\end{codedescribe}
Those two environments start the appendices and annex chapters (using locale). Chapters are  alphabetic \emph{numbered} (starting at A).
\subsection{Tabular New Columns}
Thanks to \tsobj[pkg]{array} some new columns types are defined:
\begin{describelist}{value}
	\describe {P} { \tsobj[value]{P\{\tsobj[marg]{width}\}} Normal text, ragged left.}

	\describe {B} { \tsobj[value]{B\{\tsobj[marg]{width}\}} Bold text, ragged left.}
	\describe {C} { \tsobj[value]{C\{\tsobj[marg]{width}\}} Normal text, centered.}
	\describe {R} { \tsobj[value]{R\{\tsobj[marg]{width}\}} Normal text, ragged left.}
	\describe {L} { \tsobj[value]{L\{\tsobj[marg]{width}\}} Normal text, ragged right.}
	\describe {J} { \tsobj[value]{J\{\tsobj[marg]{width}\}} Normal text, justified.}
	\end{describelist}



\subsection{enumitem Extra Keys}
Besides the \emph{default} keys defined by the \tsobj[pkg]{enumitem} package a few others are defined for author's convenience:

\begin{describelist}{key}
	\describe {ppc, tcc} {\tsobj[key]{ppc} and \tsobj[key]{tcc} are alias of each other, and just assure that lists indentation will be the same as paragraphs default.}
	\describe {parindent} { with \tsobj[key]{parindent}, the list number/mark is aligned with paragraph indentation.}
	\describe {noindent} { \tsobj[key]{noindent} removes the label indentation.}

	\begin{codestore}[st=enumA]
\begin{enumerate}[tcc]
	\item some A
	\item some B
\end{enumerate}
\begin{enumerate}[tcc,parindent]
	\item some A
	\item some B
\end{enumerate}
\begin{enumerate}[parindent]
	\item some A
	\item some B
\end{enumerate}
\begin{enumerate}[noindent]
	\item some A
	\item some B
\end{enumerate}

New paragraph, for reference.
\end{codestore}

%	\tsdemo*[parindent=org]{enumA}
	\tsdemo{enumA}

	\describe {tight} { allows for very tight lists (no indentation) to be used, for instance, inside quotes. N.B. don't use it in normal paragraph mode, otherwise the labels will spill outside the default text window.}
	\describe {miditemsep} { \tsobj[key]{miditemsep} halves items separation, as an alternative to \tsobj[key]{noitemsep} from \tsobj[pkg]{enumitem}}
	\begin{codestore}[st=enumB]
	\begin{enumerate}[tcc]
		\item some A
		\item some B
	\end{enumerate}
	\begin{enumerate}[tcc,miditemsep]
		\item some A
		\item some B
	\end{enumerate}
	\begin{enumerate}[tcc,noitemsep]
		\item some A
		\item some B
	\end{enumerate}
\end{codestore}
\newpage
\tsdemo{enumB}


	\describe {bullet} { for simple itemized lists, it will replace the default black dot by an `open bullet'}

	\begin{codestore}[st=enumD]
	\begin{itemize}[tcc,miditemsep]
		\item some A
		\item some B
		\item some C
	\end{itemize}
	\begin{itemize}[tcc,bullet,miditemsep]
		\item some A
		\item some B
		\item some C
	\end{itemize}
\end{codestore}

\tsdemo{enumD}


	\describe {arabic} { That's the \emph{default} enumerate style. Arabic numbers, starting at 1, followed by a dot.}
	\describe {arabic)} { Label will be constructed as number followed by a parenthesis.}
	\describe {(arabic)} { Label will be enclosed by parenthesis.}
	\describe {arabic*} { (for secondary lists) Label will be constructed by the label of the outer list, this item number and a final dot.}
	\describe {arabic*)} { (for secondary lists) Label will be constructed by the label of the outer list, this item number and a final parenthesis.}

	\describe {roman} { This and below keys are the same as the arabic ones, but using lower case roman numbers.}
	\describe {roman)} { lower case roman number, followed by a parenthesis.}
	\describe {(roman)} { enclosed by parenthesis.}
	\describe {roman*} { preceding one followed by roman number and a final dot.}
	\describe {roman*)} { same, followed by a final parenthesis.}

	\describe {Roman} { This and below keys are the same as the arabic ones, but using upper case roman numbers.}
	\describe {Roman)} { upper case roman number, followed by a parenthesis.}
	\describe {(Roman)} { enclosed by parenthesis.}
	\describe {Roman*} { preceding one followed by roman number and a final dot.}
	\describe {Roman*)} { same, followed by a final parenthesis.}

	\describe {alpha} { This and below keys are the same as the arabic ones, but using lower case alpha numbers.}
	\describe {alpha)} { lower case alpha number, followed by a parenthesis.}
	\describe {(alpha)} { enclosed by parenthesis.}
	\describe {alpha*} { preceding one followed by alpha number and a final dot.}
	\describe {alpha*)} { same, followed by a final parenthesis.}

	\describe {Alpha} { This and below keys are the same as the arabic ones, but using upper case alpha numbers.}
	\describe {Alpha)} { upper case roman number, followed by a parenthesis.}
	\describe {(Alpha)} { enclosed by parenthesis.}
	\describe {Alpha*} { preceding one followed by roman number and a final dot.}
	\describe {Alpha*)} { same, followed by a final parenthesis.}
	\begin{codestore}[st=enumC]
	\begin{enumerate}[tcc,roman]
		\item some A
		\item some B
		\item some C
	\end{enumerate}
	\begin{enumerate}[tcc,Roman]
		\item some A
		\item some B
		\begin{enumerate}[tcc,alpha*]
			\item some A
			\item some B
			\item some C
		\end{enumerate}
		\item some C
	\end{enumerate}
	\begin{enumerate}[tcc,arabic]
		\item some A
		\item some B
		\begin{enumerate}[tcc,roman*)]
			\item some A
			\item some B
			\item some C
		\end{enumerate}
		\item some C
	\end{enumerate}
\end{codestore}

\tsdemo{enumC}


\end{describelist}




\section{\tightul{ufrgscca-core} Package}
The \tsobj[pkg]{ufrgscca-core} package defines a set of commands for author's, student's, advisor's examiner's names and related info. It is needed by most/all of the bundled packages.

\subsection{Core Forms Commands}
\begin{codedescribe}{\tccbrief,\tcccoadvisorbrief,\tccadvisorsreview}
	\begin{codesyntax}%
		\tsmacro{\tccbrief}{brief}
		\tsmacro{\tcccoadvisorbrief}{brief}
		\tsmacro{\tccadvisorsreview}{brief}
	\end{codesyntax}
Those commands are only of use when using \tsobj[pkg]{ufrgscca-forms}. \tsmacro{\tccbrief}{} sets the work initial summary, \tsmacro{\tcccoadvisorbrief}{} sets the justification for having a co-advisor, \tsmacro{\tccadvisorsreview}{} sets the advisor's review.
\end{codedescribe}

\subsection{Core Global Commands}\label{core-commands}

\begin{codedescribe}{\location}
	\begin{codesyntax}%
		\tsmacro{\location}{city,state}
	\end{codesyntax}
	To redefine the default values of \tsobj[meta]{city} and \tsobj[meta]{state} (Porto Alegre and RS).\\
\end{codedescribe}

\begin{codedescribe}{\TCCcoord,\TCCcoordtitle}
	\begin{codesyntax}%
		\tsobj[code]{\TCCcoord}{\tsobj[marg]{(title) full name}\tsobj[oarg]{gender}}
		\tsmacro{\TCCcoordtitle}{coordinator denomination}
	\end{codesyntax}
\end{codedescribe}

\begin{codedescribe}{\coursecoord,\coursecoordtitle}
	\begin{codesyntax}%
		\tsobj[code]{\coursecoord}{\tsobj[oarg]{(title) full name}\tsobj[oarg]{gender}}
		\tsmacro{\coursecoordtitle}{course coordinator denomination}
	\end{codesyntax}
\end{codedescribe}
 \tsobj[meta]{coordinator denomination} and \tsobj[meta]{course coordinator denomination} are the full 'job title' of their position. \tsobj[meta]{gender} can be either 'm' or 'f'.

\begin{codedescribe}{\internshipcoord,\internshipcoordtitle}
    \begin{codesyntax}%
        \tsobj[code]{\internshipcoord}{\tsobj[oarg]{(title) full name}\tsobj[oarg]{gender}}
        \tsmacro{\internshipcoordtitle}{internship coordinator denomination}
    \end{codesyntax}
\end{codedescribe}
\tsobj[meta]{coordinator denomination} and \tsobj[meta]{internship coordinator denomination} are the full 'job title' of their position. \tsobj[meta]{gender} can be either 'm' or 'f'.


\subsection{Core Specific Commands}\label{core-specific-commands}

The following commands are more or less self-explanatory, \tsobj[meta]{ID} is the student's university ID. \tsobj[meta]{Nproc} is the process/request number. \tsobj[meta]{gender} can be either 'm' or 'f'.


\begin{codedescribe}{\author,\authorinfo,\student,\studentinfo}%,\studentgender}
	\begin{codesyntax}
		\tsobj[code]{ \author}{\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
		\tsmacro{\authorinfo}[Nproc]{ID,email}
		\tsobj[code]{\student}{\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
		\tsmacro{\studentinfo}[Nproc]{ID,email}
	\end{codesyntax}
\end{codedescribe}


\begin{codedescribe}{\advisor,\advisorinfo}%,\advisorgender}
	\begin{codesyntax}
		\tsobj[code]{\advisor}{\tsobj[oarg]{title}\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
		\tsmacro{\advisorinfo}{Institut,title-info,email,phone}
	\end{codesyntax}
\end{codedescribe}

\begin{codedescribe}{\coadvisor,\coadvisorinfo}%,\coadvisorgender}
	\begin{codesyntax}
		\tsobj[code]{\coadvisor}{\tsobj[oarg]{title}\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
		\tsmacro{\coadvisorinfo}{Institut,title-info,email,phone}
	\end{codesyntax}
\end{codedescribe}

\begin{codedescribe}{\examiner,\examinerinfo}%,\examinergender}
	\begin{codesyntax}
		\tsobj[code]{\examiner}{\tsobj[oarg]{title}\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
		\tsmacro{\examinerinfo}{Institut,title-info,email,phone}
	\end{codesyntax}
\end{codedescribe}

\begin{codedescribe}{\altexaminer,\altexaminerinfo}%,\altexaminergender}
	\begin{codesyntax}
		\tsobj[code]{\altexaminer}{\tsobj[oarg]{title}\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
		\tsmacro{\altexaminerinfo}{Institut,title-info,email,phone}
	\end{codesyntax}
\end{codedescribe}

\begin{codedescribe}{\tutor,\tutorinfo}%,\tutorgender}
\begin{codesyntax}
    \tsobj[code]{\tutor}{\tsobj[oarg]{title}\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
    \tsmacro{\tutorinfo}{Institut,title-info,email,phone}
\end{codesyntax}
\end{codedescribe}

\begin{codedescribe}{\supervisor,\supervisorinfo}%,\tutorgender}
\begin{codesyntax}
    \tsobj[code]{\supervisor}{\tsobj[oarg]{title}\tsobj[marg]{last}\tsobj[marg]{first}\tsobj[oarg]{gender}}
    \tsmacro{\supervisorinfo}{register,office,email,phone}
\end{codesyntax}
\end{codedescribe}

\begin{tsremark}[N.B.:]
The commands \tsmacro{\advisor}{}, \tsmacro{\coadvisor}{}, \tsmacro{\examiner}{} and \tsmacro{\altexaminer}{} are meant to be used in a 'final work' doc. The Macros \tsmacro{\tutor}{} and \tsmacro{\supervisor}{} in case of an internship report.
\end{tsremark}


\section{\tightul{ufrgscca-cover} Package}
This package is the one that sets the front pages, depending on the kind of 'report' being generated. The default being to generate 3 cover pages: an identification on, followed by presentation one, then an referral/approval one.

\subsection{Package Options}
\begin{describelist}{option}
	\describe {report} { in case the doc is just a class assignment with, possibly, many co-authors. It changes mainly the front matter, which is simplified (no referral page, for instance).}
    \describe {internship} { in case the doc is an internship report.}
    \describe {nonrequired} { in case the internship report is related to a “non required” / “optional” internship. This option is ignored otherwise.}

\end{describelist}

\subsection{Defined Commands}
\begin{codedescribe}{\maketitle}
	\begin{codesyntax}%
		\tsmacro{\maketitle}{}
	\end{codesyntax}
This is the only main command, which will typeset the front matter. It requires that all \emph{specific info} be already set up (like work title, author's name, affiliation, etc.)
\end{codedescribe}


\begin{codedescribe}{\course,\courseacronym,\graduationtitle,\university,\universityacronym,%
		\universitydivision,\divisiongradcouncil,\department,\classcode,\classname,\subject}
\begin{codesyntax}%
	\tsmacro{\course}{arg}
	\tsmacro{\courseacronym}{arg}
	\tsmacro{\graduationtitle}{arg}
	\tsmacro{\university}{arg}
	\tsmacro{\universityacronym}{arg}
	\tsmacro{\universitydivision}{arg}
	\tsmacro{\divisiongradcouncil}{arg}
	\tsmacro{\department}{arg}
	\tsmacro{\classcode}{arg}
	\tsmacro{\classname}{arg}
	\tsmacro{\subject}{arg}
\end{codesyntax}
In case some customization is needed, one can change them as needed. The default values are set for the \emph{control and automation} course at UFRGS/EE.
\end{codedescribe}

\section{\tightul{ufrgscca-forms} Package}
This package defines just two user commands to generate specific forms needed at UFRGS/EE.
\subsection{Forms Defined Commands}\label{forms.commands}
\begin{codedescribe}[code,update=2023/05/29]{\tcforms,\tcemptyforms}
	\begin{codesyntax}%
\tsmacro{\tcforms}{formslist}
\tsmacro{\tcemptyforms}{formslist}
\end{codesyntax}
The command \tsmacro{\tcforms}{} will generate the many forms (\tsobj[meta]{formslist}) using the information from \emph{local.tex}, whilst \tsmacro{\tcemptyforms}{} will generate said forms with 'blanks' (to be fulfilled by hand, for instance).

\end{codedescribe}

\tsobj[meta]{formslist} is a csv list of any of:
\begin{describelist*}{option}
    \describe {reqform-I} {}
    \describe {reqform-II} { Registration requirement form.}
    \describe {coadvisor-I} {}
    \describe {coadvisor-II} { Coadvisor justification form.}
    \describe {boardsapproval-I} {}
    \describe {boardsapproval-II} { Boards approval form.}
    \describe {advisorsapproval-I} {}
    \describe {advisorsapproval-II} { Advisors approval form.}
    \describe {receipts-II} { Receipts forms (one per board member).}
    \describe {examinersforms-I} {}
    \describe {examinersforms-II} { Grades and correction forms (per board member).}
    \describe {rectifyapproval-I} {}
    \describe {rectifyapproval-II} { Corrections approval  form.}
    \describe {internreqform} { Internship Registration requirement form.}
    \describe {internsupervisorform} { Internship Supervisor evaluation form.}
    \describe {interntutorform} { Internship tutor evaluation form.}
\end{describelist*}
Please note that those '-I' regards TCC-I, while '-II' regards TCC-II.


\section{\tightul{ufrgscca-lists} Package}
The following packages are always pre-loaded: \tsobj[pkg]{ newfloat, listings, xcolor}.
It defines a new \emph{floating environment}. Combined with \tsobj[pkg]{listings} one can typeset exempts of \emph{code listing}.

\subsection{Environment}
\begin{codedescribe}[env]{codelist}
	\begin{codesyntax}%
		\tsmacro{\begin{codelist}}{}\ldots \tsmacro{\end{codelist}}{}
	\end{codesyntax}
\tsmacro{\caption}{} will be named 'Listing' (Listagem).

\begin{codestore}[st=d.listing]
	\begin{codelist}[htbp]
		\caption{sample C code}
		\label{code01}
		\begin{lstlisting}[language=C]
			struct i2c_msg
			{
				__u16 addr;     /* endereco do escravo */
				__u16 flags;
			}
		\end{lstlisting}
		{\sourcecitation{\textcite{Garg:SMA-2000}}}
	\end{codelist}
\end{codestore}
\tscode*{d.listing}

\end{codedescribe}

\subsection{Declared Commands}
\begin{codedescribe}{listofcodelist}
	\begin{codesyntax}%
		\tsmacro{\listofcodelist}{}
	\end{codesyntax}
This will create the 'List of ...' associated with the \tsobj[env]{codelist} environment.
\end{codedescribe}

\iffulldoc

\begin{codedescribe}{\DeclareNewFloat}
	\begin{codesyntax}%
		\tsmacro{\DeclareNewFloat}{env-name,file-ext,listname,listofname}
	\end{codesyntax}
A new float environment, named \tsobj[env]{env-name}, will be created. Captions will be associated (numbered) as \textbf{\tsobj[meta]{listname} num:}. Finally, an associated command \tsmacro{\listof...}{} will be defined, using \tsobj[meta]{listofname} as a numberless \tsmacro{\chapter}{} title.

\begin{codestore}[st=d.float]
	\def\listingname{Listing}%
	\def\listlistingname{List of Listings}%
	\DeclareNewFloat{codelist}{lox}{\listingname}{\listlistingname}%%
	%% after that, one can do as in the previous example
 	%%
 	%% the list of, will be created as
 	\listofcodelist
\end{codestore}

\tscode*[emph={codelist,listofcodelist}]{d.float}
\end{codedescribe}
\fi

\iffulldoc
\section{\tightul{ufrgscca-gen} Package (extended documentation)}
Just two set of commands are defined, one is kind of a 'command factory' aimed at creating macros in a standard way, while the other helps create 'case like' commands.


\subsection{Package Options}
\begin{describelist}{option}
	\describe {family} { sets the family name, defaults to \tsobj[value]{tcdef}.}
	\describe {group} { sets the group name, defaults to \tsobj[value]{gen}.}
\end{describelist}

\subsection{Defined Commands}
\begin{codedescribe}{\cmdfactory,\factory,\tcgen@cdef}
	\begin{codesyntax}%
		\tsobj[code]{\cmdfactory}{\tsobj[oarg]{fam}\tsobj[xarg]{grp}\tsobj[marg]{cmd-list}}
		\tsobj[code]{\factory}{\tsobj[oarg]{fam}\tsobj[xarg]{grp}\tsobj[marg]{cmd}}
		\tsobj[code]{\tcgen@cdef}{\tsobj[oarg]{fam}\tsobj[xarg]{grp}\tsobj[marg]{cmd}\tsobj[marg]{new-val}}
	\end{codesyntax}
	\tsmacro{\cmdfactory}{} is the actual command meant to be used (the other two are just auxiliary ones). \tsobj[meta]{cmd-lst} is a csv list of commands. \tsobj[meta]{fam} is the command \emph{family} (defaults to \emph{tcdef}) and \tsobj[meta]{grp} is the family group (defaults to \emph{gen}).

	The newly created commands will be based on \tsmacro{\tcgen@cdef}{} (the actual assigment command) having the form \tsmacro{\cmd}{new-val}, accepting a single mandatory value. Internally \tsobj[meta]{new-val} will be stored in a macro likely named \tsmacro{\fam@grp@cmd}{}.

    \tsmacro{\factory}{} is basically the same as \tsmacro{\cmdfactory}{}, whilst to create just one new command (it is the command called by \tsmacro{\cmdfactory}{} via \tsmacro{\forcsvlist}{}.)
\end{codedescribe}

\begin{codedescribe}{\mkswitch,\addcase}
	\begin{codesyntax}%
		\tsmacro{\mkswitch}[default]{sw-name}
		\tsmacro{\addcase}{sw-name,str-case,code}
	\end{codesyntax}
	\tsmacro{mkswitch}{} will create a command, \tsmacro{\sw-name}{case}, which will behave like a switch/case in other programming languages. \tsobj[meta]{default} is the code to be executed in case a \emph{switching value} isn't defined.
	\tsmacro{\addcase}{} adds \emph{cases}, one by one, to the switch. \tsobj[meta]{str-case} can be any \tsmacro{\csname}{} valid name. \tsobj[meta]{code} is the code to be executed.

	\begin{codestore}[st=d.switch]
		\mkswitch[\gr@depcut]\gr@case@angle
		\addcase\gr@case@angle{}{\def\gr@ANG{0}}
		\addcase\gr@case@angle{A}{\def\gr@ANG{\gr@A}}
		%%
		%% actual use of the switch
		\gr@case@angle{A}  % this will result in \def\gr@ANG{\gr@A}
	\end{codestore}
	\tscode*{d.switch}
\end{codedescribe}
\fi

\iffulldoc
\section{\tightul{ufrgscca-coord} Package (extended documentation)}
This package defines a set of auxiliary commands meant to support the Professor coordinating students work.
it will always pre-load the \tsobj[pkg]{longtable} and \tsobj[pkg]{ufrgscca-forms} packages. One can select the reports/forms to be generated using the package options or the command \tsmacro{\setreports}{keys}

N.B. It might be also useful to use the commands defined at \autonameref{forms.commands}.

\subsection{Package/Report Options}\label{ufrgscca-coord.options}
\begin{describelist}{option}
	\describe {calendar} { Calendar for the period.}
	\describe {checklist} { a students check list.}
	\describe {report} { a student control report.}
	\describe {reportxinfo} { report additional info.}
	\describe {boards} { exam board dates.}
	\describe {boarddates} { exam board dates with highlighted dates.}
	\describe {studentlist} { a simple student list.}
	\describe {revforms} { per student reviews forms.}
	\describe {referral} { per student referral letters.}
	\describe {cocertificate} { per student coadvisor certificate letter (if any).}
\end{describelist}

\subsection{Defined Commands}
The \emph{report document} to be created is composed of 2 main parts:
\begin{enumerate}[tcc,arabic,miditemsep]
	\item A global preamble, where one sets
	\begin{enumerate}[tcc,alpha*,noitemsep]
		\item the current semester, Course/TCC/internship coordinator's names, etc. ,
		\item auxiliary data, like students \emph{check list} items and
		\item students data.
	\end{enumerate}
    \item A 'final part' whereas one set which reports are to be generated.
\end{enumerate}

\subsubsection{Global Commands I}
One can (should) use the commands listed at \autonameref{core-commands}, and these below:

\begin{codedescribe}{\checkdef}%,\checklist}
\begin{codesyntax}%
    \tsmacro{\checkdef}{checkLC,check-item,check-text}
\end{codesyntax}
Whereas one has a '4x5 alphabetic matrix', lines A to D, columns A to E. \tsobj[meta]{checkLC} being one element of that matrix (from checkAA up to checkDE), \tsobj[meta]{chek-item} is a free identifier (to be used with the \tsmacro{\checklist}{}), and \tsobj[meta]{check-text} the text to appear in the 'check list report'.  So, for instance:

\begin{codestore}[st=d.check]
    \checkdef{checkAA}{tcc-part}{Rel. Parcial}        % this creates the 'check item' tcc-part and associates it with the AA position (first line, first column), display text 'Rel. Parcial'
    \checkdef{checkBA}{partOK}{Aprov. Rel. Parcial}   % this creates 'partOK' and associates it with BA position

    \checkdef{checkAB}{board}{Banca def.}             %
    \checkdef{checkBB}{board-date}{Data defesa}       % 'board-date' is associated with the BB position

    \checkdef{checkAE}{tcc-final}{TCC final}          %
    \checkdef{checkBE}{approval}{Aprovação Correções} %
    \checkdef{checkDE}{exam}{Em Exame}                % 'exam' (display 'Em Exame') is associated with the DE position
    %%
    %%
    %% later on, one can use (inside a \NewStudent command)
    \checklist{tcc-part,partOK,exam}                  % this will, for a given student, 'mark' the 'tcc-part', 'partOK' and 'exam' items.
\end{codestore}


\tscode*[emph={{tcc-part},partOK,board,board-date,{tcc-final},approval,exam}]{d.check}

Be aware that, \tsmacro{\checkdef}{} can and should be only used at the preamble, whereas \tsmacro{\checklist}{} can only be used at the 'student data definition' context (meaning, inside the \tsmacro{\NewStudent}{} command).
\end{codedescribe}\\


\paragraph{Final Work Specific}

\begin{codedescribe}{\boardstitleB,\boardsOBS,\TCCperiod}
	\begin{codesyntax}%
		\tsmacro{\boardstitleB}{titleB}
		\tsmacro{\boardsOBS}{obs}
		\tsmacro{\TCCperiod}{semester}
	\end{codesyntax}
 \tsmacro{boardstitleB}{} sets a 2nd title line for the 'boards schedule report'. \tsmacro{\boardsOBS}{} allows to add an observation (\tsobj[meta]{obs}) for the 'boards schedule report', finally, \tsmacro{\TCCperiod} sets the current semester value.
\end{codedescribe}

\begin{codedescribe}[code,update=2023/05/29]{\tcccalendarreset,\tcccalendarevent,\tcccalendareventdate}
	\begin{codesyntax}%
    \tsmacro{\tcccalendarreset}{}
    \tsmacro{\tcccalendarevent}{week,description}
		\tsmacro{\tcccalendareventdate}{date}
	\end{codesyntax}
With \tsobj{\tcccalendarevent} one defines the many calendar events. \tsobj[marg]{week} defines the event's week, and  \tsobj[marg]{description} the associated text. Furthermore \tsobj{\tcccalendareventdate} defines the associated \tsobj[marg]{date}. \tsobj{\tcccalendarevent} is, normally, pre-set in the \emph{ufrgscca-ptBR-coord.def} file, but can be redefined using first \tsobj{\tcccalendarreset}.
\end{codedescribe}


\begin{codedescribe}{\tcceventAweek,\tcceventBweek,.,.,.,.,\tcceventJweek}
    \begin{codesyntax}%
        \tsmacro{\tcceventAweek}{week num.}
        \tsmacro{\tcceventBweek}{week num.}
        \ensuremath{\cdots}
        \tsmacro{\tcceventJweek}{week num.}
    \end{codesyntax}
    Those macros allow to change the default week value for the calendar's events.
\end{codedescribe}

\paragraph{Internship Specific}

\begin{codedescribe}{\intershipcommitdates}
    \begin{codesyntax}%
        \tsmacro{\intershipcommitdates}{date I}{date II}
    \end{codesyntax}
    Use \tsmacro{\intershipcommitdates}{} to set the semester deadlines. Both dates must be given in the dd/mm/yyyy format.
    \tsobj[meta]{date I} is the deadline for a given report still be fully evaluated. After \tsobj[meta]{date I} the given internship will be in “exam”. If the student report isn't submitted until \tsobj[meta]{date II} the student will fail with an “FF” grade.
\end{codedescribe}



\subsubsection{Global Commands II}\label{new-student}

\begin{codedescribe}{\NewStudent}
	\begin{codesyntax}%
		\tsmacro{\NewStudent}{studentname,code}
	\end{codesyntax}
	This is the main command describing each \tsobj[meta]{student} associated work, advisor and exam board. In \tsobj[meta]{code} one should use the commands defined in \autonameref{core-specific-commands}, and \autonameref{student-specific-commands} (although one can use  any valid \LaTeXe~ preamble code, keep in mind those will be executed BEFORE \tsmacro{\begin{document}}{}), to describe a student work.
\end{codedescribe}
	So, for instance:
	\begin{codestore}[st=d.newstudent]
\NewStudent{Artur}{
	\student{last}{first}[m]

	\studentinfo[]{243716}{email@somewhere}
	\TCCtitle{work title}
	\advisor{de Amorin}{Heraldo José}[m]
	\coadvisor{Camargo Nardelli}{Vítor}[m]
	\examinergrades{9.2}{8.5}{9.2}
	\examiner{Götz}{Marcelo}[m]
	\examinergrades{10}{9.5}{9.5}
	\examiner{Comparsi Laranja}{Rafael Antônio}
	\examinergrades{8.5}{8.5}{8}
	\altexaminer{Ventura Bayan Henriques}{Renato}
	%%
	%%
	\timeslot[Teams]{12/11}{15:30}

	\studentFate[Dismiss]  %% FF or Dismiss ??
}
\end{codestore}

\tscode*{d.newstudent}

\begin{tsremark}[N.B.:]
Internally, \tsmacro{\NewStudent}{} will create a command named \tsmacro{\studentname}{}, with a \emph{hook} named \tsmacro{\studentname.hook}{} (the dot is part of the hook's name).
\end{tsremark}


\begin{codedescribe}{\NewInternshipStudent}
    \begin{codesyntax}%
        \tsmacro{\NewInternshipStudent}{studentname,code}
    \end{codesyntax}
    This is the main command describing each \tsobj[meta]{student} associated internship, tutor and advisor. In \tsobj[meta]{code} one should use the commands defined in \autonameref{core-specific-commands}, and \autonameref{student-specific-commands} (although one can use  any valid \LaTeXe~ preamble code, keep in mind those will be executed BEFORE \tsmacro{\begin{document}}{}), to describe a student internship.
    \end{codedescribe}
        So, for instance:
        \begin{codestore}[st=d.newstudentB]
  \NewStudent{Artur}{
      \student{last}{first}[m]
      \studentinfo[]{243716}{email@somewhere}
      \internship{Empresa I}{P\&D}{10/10/22}{20/12/22}{2 Meses}

      \supervisor[Eng. I]{do Supervisor}{Nome}[m]
      \supervisorinfo{crea I}{posição/cargo}{email}{ramal}

      \internshipsupervisorgrades{4}{4}{4}{4}{5}
      \internshipsupervisorgrades{4}{4}{4}{4}{5}
      \internshiptutorgrades{90}
      \internshipcoordgrades{90}

      \tutor[Prof.~Dr.]{do Tutor I}{Nome}[m]
      \tutorinfo{UFRGS}{Instituição I-- Cidade, País}{email}{ramal}

      \studentFate[Dismiss]  %% FF or Dismiss ??
  }
\end{codestore}

        \tscode*{d.newstudentB}
\begin{tsremark}[N.B.:]
         Internally, \tsmacro{\NewInternshipStudent}{} will create a command named \tsmacro{\studentname}{}, with a \emph{hook} named \tsmacro{\studentname.hook}{} (the dot is part of the hook's name).
\end{tsremark}         


\subsubsection{Student Specific Commands}\label{student-specific-commands}
\begin{codedescribe}{\studentFate}
	\begin{codesyntax}%
		\tsmacro{\studentFate}[fate]{}
	\end{codesyntax}
This assigns the \tsobj[meta]{fate} of a student, for those cases that one cannot rely on the 'calculated one' (from examiners individual grades). \tsobj[meta]{fate} can be either C or D (in case a student got in exam), FF for those that haven't finished the work or 'Dismiss' for those that, for whatever reason, got dismissed. The default is 'do nothing' (no \tsobj[meta]{fate} assigned)
\end{codedescribe}

\begin{codedescribe}{\checklist}
    \begin{codesyntax}%
        \tsmacro{\checklist}{csv-checkitems}
    \end{codesyntax}
    \tsobj[meta]{csv-checkitems} is a csv list of valid 'items' (the ones defined by \tsmacro{\checkdef}{}) and it will 'mark' (check) the corresponding items for a given student.
\end{codedescribe}


\paragraph{Final Student Work Specific ones}

\begin{codedescribe}{\studenttimeslot,\timeslot}
	\begin{codesyntax}%
		\tsmacro{\studenttimeslot}[local]{date,time}
		\tsmacro{\timeslot}[local]{date,time}
	\end{codesyntax}
\tsmacro{\timeslot}{} is just an alias of \tsmacro{\studenttimeslot}{}. They set, for the Boards Report, the \tsobj[meta]{local}, \tsobj[meta]{date} and \tsobj[meta]{time} in which a student will have its work presented. Those commands are meant to be used 'inside' a \tsmacro{\NewStudent}{} command.
\end{codedescribe}



\begin{codedescribe}{\studentTCCtitle,\TCCtitle,\studentremark}
	\begin{codesyntax}%
		\tsmacro{\studentTCCtitle}{title}
		\tsmacro{\TCCtitle}{title}
		\tsmacro{\studentremark}{remark}
	\end{codesyntax}
\end{codedescribe}
\tsmacro{\TCCtitle}{} is also just an alias to \tsmacro{\studentTCCtitle}{} which just 'defines' the current student “work's title”. \tsmacro{\studentremark}{} just inserts a \tsobj[meta]{remark}, which will appear in the \emph{report}'s report (\ldots report option).


\begin{codedescribe}{\DistinctBoard,\DefaultBoard}
	\begin{codesyntax}%
		\tsmacro{\DistinctBoard}{}
		\tsmacro{\DefaultBoard}{}
	\end{codesyntax}
Normally, the default, it's assumed that the student's advisor will also be a member of the student's exam board. For the ones in which this doesn't holds true, one should use the \tsmacro{\DistinctBoard}{} after informing a student's name (via \tsmacro{\student}{}) and before informing its advisor name (via \tsmacro{\advisor}{}). 
\end{codedescribe}
For example:

	\begin{codestore}[st=d.distinct]
	\NewStudent{Artur}{
		\student{last}{first}[m]

		\studentinfo[]{243716}{email@somewhere}
		\TCCtitle{work title}
		\DistinctBoard
		\advisor{de Amorin}{Heraldo José}[m]
		\examiner{Götz}{Marcelo}[m]                 % He will be the 1st examiner
		\examiner{Comparsi Laranja}{Rafael Antônio} % the 2nd
		\examiner{Ventura Bayan Henriques}{Renato}  % the 3rd
	}
\end{codestore}

\tscode*[emph={DistinctBoard}]{d.distinct}


\begin{codedescribe}{\examinergrades}
	\begin{codesyntax}%
		\tsmacro{\examinersgrades}{N1,N2,N3}
	\end{codesyntax}
Quite obvious, this set the grades given by an examiner (the one defined by the 'last' \tsmacro{\examiner}{} before this.).
\end{codedescribe}

\paragraph{Internship Specific Ones}

\begin{codedescribe}{\studentturnindate}
    \begin{codesyntax}%
        \tsmacro{\studentturnindate}{date}
    \end{codesyntax}
    The date, in which, the student submitted the Internship Report. Beware, the date must be in the day/month/year format.
\end{codedescribe}

\begin{codedescribe}{\internshipsupervisorgrades}
    \begin{codesyntax}
        \tsmacro{\internshipsupervisor}{N1,N2,N3,N4,N5}
    \end{codesyntax}
    Quite obvious, this set the grades given by the supervisor, it's meant to be used twice for the two 'grades blocks'.
\end{codedescribe}

\begin{codedescribe}{\internshiptutorgrades}
    \begin{codesyntax}%
        \tsmacro{\internshipgrades}{N1}
    \end{codesyntax}
    Quite obvious, this set the grade given by the student tutor.
\end{codedescribe}

\begin{codedescribe}{\internshipcoordgrades}
    \begin{codesyntax}%
        \tsmacro{\internshipcoordgrades}{N1}
    \end{codesyntax}
    Quite obvious, this set the grade given by the Internship Coordinator.
\end{codedescribe}

\paragraph{Setting Commands}


\begin{codedescribe}{\addtostudent}
	\begin{codesyntax}%
		\tsmacro{\addtostudent}{student,code}
	\end{codesyntax}
\tsobj[meta]{code} will be appended to the command created with \tsmacro{\NewStudent}{}. \tsobj[meta]{student} must be an already defined one, whilst \tsobj[meta]{code} can be anything valid in the context of a \tsmacro{\NewStudent}{} as described in \autonameref{new-student}.
\end{codedescribe}

\begin{codedescribe}{\setreports}
	\begin{codesyntax}%
		\tsmacro{\setreports}{rep-list}
	\end{codesyntax}
	\tsobj[meta]{rep-list} is a csv list of keys as defined at \autonameref{ufrgscca-coord.options}.
\end{codedescribe}

\begin{codedescribe}{\setstudentlist}
	\begin{codesyntax}%
		\tsmacro{\setstudentlist}{listID,list}
	\end{codesyntax}
This command will define/create a list named \tsobj[meta]{listID} composed of a csv \tsobj[meta]{list}~ of student names (as defined by \tsmacro{\Newstudent}{}).
\end{codedescribe}

\begin{codedescribe}{\tcreports}
	\begin{codesyntax}%
		\tsmacro{\tcreports}[rep-list]{listID}
	\end{codesyntax}
	This is the main command (final work reports), to be used only once, at the end of the file. It will typeset the reports, as set by \tsmacro{\setreports}{}, using the student list identified by \tsobj[meta]{listID}.
    \tsobj[meta]{rep-list} is a csv list of keys as defined at \autonameref{ufrgscca-coord.options}.
\end{codedescribe}

\begin{codedescribe}{\internshipreports}
    \begin{codesyntax}%
        \tsmacro{\internshipreports}[rep-list]{listID}
    \end{codesyntax}
    This is the main command (internship reports), to be used only once, at the end of the file. It will typeset the reports, as set by \tsmacro{\setreports}{}, using the student list identified by \tsobj[meta]{listID}.
    \tsobj[meta]{rep-list} is a csv list of keys as defined at \autonameref{ufrgscca-coord.options}.
\end{codedescribe}

\section{\tightul{ufrgscca-ppc} Package (beta) (extended documentation)}
This contains a set of auxiliary commands to keep track of many \emph{indicators} whilst writing  a \emph{PPC document} (which is going to be evaluated based on said \emph{indicators}, though the track of those \emph{indicators} themselves shall not appear in the final version of it). Keep in mind, when considering the use of it: “it works as is” but it hasn't being properly debugged, and it might change “as needed locally”.

The packages \tsobj[pkg]{longtable}, \tsobj[pkg]{pdfcomment}, \tsobj[pkg]{mdframed} and \tsobj[pkg]{ufrgscca-curr} will always be pre-loaded.

\subsection{Package Options}
\begin{describelist}{option}
\describe {showind} { (for drafts) it will display the report indicators, of those indicators whose family wasn't set to hide.}
\describe {indlong} { (for drafts) when displaying an indicator, the long version of them will be used.}
\describe {nocomments} { (for drafts) comments (created with the command \tsmacro{\comment}) will be suppressed.}
\end{describelist}

\subsection{Defined Commands}
\begin{codedescribe}{\maketitle}
    \begin{codesyntax}%
        \tsmacro{\maketitle}{}
    \end{codesyntax}
The command \tsmacro{\maketitle}{} is redefined for the specifics of a \emph{PPC document}.
\end{codedescribe}

The next few commands use a finite set of \tsobj[meta]{status} which are a pre-defined list of:
\begin{describelist*}{value}
    \describe {tbd} { “To Be Done”}
    \describe {done} { “Done”}
    \describe {review} { “to be reviewed”}
    \describe {attention} { Needs Attention}
    \describe {NSA} { NSA (portuguese for “do not apply”)}
    \describe {noref} { no references}
    \describe {EAD} { EAD (portuguese for “distance learning”)}
    \describe {MDi} { course ware (portuguese for “didactic material”) }
    \describe {DOCs} { other DOCs}
    \describe {default} { everything else}
\end{describelist*}

\begin{codedescribe}{\declareindicator, \indicatorDesc, \indicatorText}
	\begin{codesyntax}%
		\tsmacro{\declareindicator}<*+>[status]{fam,ID,text}
		\tsmacro{\indicatorDesc}{longdesc,extra}
		\tsmacro{\indicatorText}{text}
	\end{codesyntax}
\tsmacro{\declareindicator}{} is the command to create/define a given “indicator”. \tsobj[meta]{fam} set's its \emph{family} group, \tsobj[meta]{ID} is the particular ID/term used to reference it (in a family of indicators), \tsobj[meta]{text} is a short text describing it (it is the text displayed when using the \tsmacro{\indref}{} below.). \tsmacro{\indicatorDesc}{} adds a \tsobj[meta]{longdesc} (long description) and \tsobj[meta]{extra} (extra long description) to a defined \tsmacro{\declareindicator}{} (it will add those text fields to the “last declared one”). \tsobj[meta]{longdesc} will also be displayed when using the \tsmacro{\indref}{} commands, but only if the \tsobj[option]{indlong} option was used. The \tsobj[meta]{extra} will only be used/displayed with the \tsmacro{\PrintIndicators}{} command. Finally, \tsmacro{indicatorText}{} adds a remark \tsobj[meta]{text}, which will be also printed out when using  \tsmacro{\lstind}{} (akin of an explanation/remark field.)
\end{codedescribe}

\begin{codedescribe}{\indsetstatus, \indsetview, \indsethide}
	\begin{codesyntax}%
	\tsmacro{\indsetstatus}[status]{fam,ID}
	\tsmacro{\indsetview}{fam}
	\tsmacro{\indsethide}{fam}
\end{codesyntax}
\tsmacro{indsetstatus}{} sets the \tsobj[meta]{status} of a given indicator defined by \tsobj[meta]{fam} and \tsobj[meta]{ID}. \tsmacro{\indsetview}{} and \tsmacro{indsethide} set the visibility (or not) of a given “family” of indicators, meaning, if those indicators are going to be visible or not (command \tsmacro{\indref}{}, for instance) if the option \tsobj[option]{showind} is in use.
\end{codedescribe}

\begin{codedescribe}{\lstind}
	\begin{codesyntax}%
	\tsmacro{\lstind}[seclvl1,seclvl2]{fam}
\end{codesyntax}
\tsmacro{\lstind}{} will produce a sectioning like list, \tsobj[meta]{seclvl1} defaults to \tsmacro{\section}{} and \tsobj[meta]{seclvl2} defaults to \tsmacro{\subsection}{}, those indicators marked with an \textbf{*} (when creating them) will be issued with \tsobj[meta]{seclvl1}, those marked with an \textbf{+} will be issued with \tsobj[meta]{seclvl2}. The indicator's short text will be the sectioning title, whilst the indicator's 'text' (the one assigned with \tsmacro{indicatorText}{} will be the sectioning body.)
\end{codedescribe}

\begin{codedescribe}{\PrintIndicators}
    \begin{codesyntax}%
        \tsmacro{\PrintIndicators}[fam]{}
    \end{codesyntax}
    \tsmacro{\PrintIndicators}{} will produce a “list of contents” like list (with cross reference to all used \tsmacro{\indref}{} pages). It will either issue a list of all \tsmacro{\declareindicator}, or just the ones belonging to \tsobj[meta]{fam}. \tsobj[meta]{fam} can be a csv list of families. Each entry will be composed by indicator's “family”, “ID”, “short text”, “long text” and “extra description” but not the text issued with \tsmacro{\indicatorText}{}.
\end{codedescribe}


\begin{codedescribe}{\helpindicators}
	\begin{codesyntax}%
	\tsmacro{\helpindicators}{}
\end{codesyntax}
This will just prints, middle text, a quick “help text” listing the few main “indicators related command” (to help out those less \LaTeXe~ savvy writers.)
\end{codedescribe}

\begin{codedescribe}{ \ifshowind}
    \begin{codesyntax}%
        \tsmacro{\ifshowind}{code-ifshow,code-ifnot}
    \end{codesyntax}
Just a helping command, based on the package options. If the option \tsobj[option]{showind} was used, \tsobj[meta]{code-ifshow} is executed, otherwise \tsobj[meta]{code-ifnot}.
\end{codedescribe}


\begin{codedescribe}{\textmark, \comment}
	\begin{codesyntax}%
	\tsmacro{\textmark}[status]{text}
	\tsmacro{\comment}[status]{title,text}
\end{codesyntax}
Those are annotation, remark commands. The difference being that \tsmacro{\textmark}{} will just highlight the \tsobj[meta]{text} (using \tsobj[meta]{status} “format”), whilst \tsmacro{comment}{} will create a “remark box” (the same used when inserting an indicator's reference, commands below).
\begin{tsremark}[N.B.:]
 The command \tsmacro{\comment}{} is suppressed unless the option \tsobj[option]{showind} is used.
 \end{tsremark}
\end{codedescribe}

\begin{codedescribe}{\indref,\indreflst}
	\begin{codesyntax}%
	\tsmacro{\indref}<*>[status]{fam,ID,comment}
	\tsmacro{\indreflst}<*>[status]{fam,IDlist,comment}
\end{codesyntax}
\tsmacro{\indref}{} creates a box (\tsobj[pkg]{TikZ} based \tsobj[pkg]{mdframed} ) of the indicator denoted by  \tsobj[meta]{fam} and \tsobj[meta]{ID}. The family and IDs will be issued as the “frame title”, the current indicator's \tsobj[meta]{status} will be printed out (the whole box will be highlighted accordly), the short version of the indicator will be used (the long version will “appear” as a \tsobj[pkg]{pdfcomment}), finally any \tsobj[meta]{comment} will be added to the text box. Each \tsmacro{\indref}{} box will have a link to the indicator's list (issued with \tsmacro{\PrintIndicators}{}). If the optional argument \tsobj[meta]{status} is used, the indicator's status will be updated accordly. The star version also prints the indicator's long text.

\tsmacro{\indreflst}{} behaves similarly, with the difference that \tsobj[meta]{IDlist} is a csv list of IDs (same family), moreover, each item of said list can have the form either just \tsobj[meta]{ID} or \tsobj[meta]{status:ID}, in the last form, that ID will have its status updated, as well.
\end{codedescribe}

\begin{codedescribe}{\fancyquote}
	\begin{codesyntax}%
	\tsmacro{\fancyquote}[vspc]{text,author,dateref}
\end{codesyntax}
As quick “quote” hack, \tsmacro{\fancyquote}{} will typesets a \tsobj[meta]{text} (small size, italic  text, in a minipage environment) followed by \tsobj[meta]{author} and \tsobj[meta]{dateref}. This is meant to be used after a \tsmacro{\chapter}{} or \tsmacro{\section}{} commands. \tsobj[meta]{vspc} is to be used in case one has to adjust the vertical space between the sectioning command, and the quote one.
\end{codedescribe}


\begin{codedescribe}{\labelhack}
    \begin{codesyntax}%
        \tsmacro{\labelhack}{text}
    \end{codesyntax}
As the name implies, it is a hack. In some cases (which we haven't manage to found why/what), \tsobj[pkg]{hyperref} would fail miserably when using the \tsmacro{\nameref}{} (in some cases getting the sectioning correct, but not the name!). This just assures that \tsmacro{\nameref}{} will use the correct sectioning name in those cases.
\begin{codestore}[st=d.labelhack]
    \section{this section}\labelhack{this section}\label{somelabel}
\end{codestore}
\tscode*[codeprefix={For Example:},emph={labelhack}]{d.labelhack}
\end{codedescribe}

\begin{codedescribe}{\acrodef, \acro,\acrol,\acrols,\acrosl,\acrofoot,\printacrolist}
    \begin{codesyntax}%
        \tsmacro{\acrodef}{acroID}{acronym}{long}
        \tsmacro{\acro}{acroID}
        \tsmacro{\acrol}{acroID}
        \tsmacro{\acrols}{acroID}
        \tsmacro{\acrosl}{acroID}
        \tsmacro{\acrofoot}{acroID}
        \tsmacro{\printacrolist}[enumkeys]{widest}
    \end{codesyntax}
Those are yet another acronym hack. \tsmacro{\acrodef}{} “creates” an acronym, identified by \tsobj[meta]{acroID}, whose short (acronym) version is \tsobj[meta]{acronym} and the long version in \tsobj[meta]{long}. \tsmacro{\acro}{} just typesets the \tsobj[meta]{acronym}, \tsmacro{\acrol}{} the \tsobj[meta]{long} version.
\tsmacro{\acrols}{} typesets the the long version followed by the short (using a comma as separator).
\tsmacro{\acrosl}{} prints the short version first. Finally, \tsmacro{\acrofoot}{} typesets the short version in text and the long as a footnote. \tsmacro{\printacrolist}{} creates a description list based on the \tsobj[env]{listofabbrv} environment.
\end{codedescribe}

\subsection{Environments}
\begin{codedescribe}[env]{ppc.quote}
    \begin{codesyntax}%
    \tsmacro{\begin{ppc.quote}}{} \ldots \tsmacro{\end{ppc.quote}}{}
    \end{codesyntax}
\end{codedescribe}
This is just a tailored “quote” environment, using almost all page width, just in a smaller font size.

\section{\tightul{ufrgscca-curr} Package (beta) (extended documentation)}
This package is mostly in beta state, some parts of it should be identified as  alpha state. Those are mostly rushed out adaptations of other “solutions at hand”. Literally, try to use it at your own peril.

The background of it: To have the ability to “describe” (store the information in a “structured way”) an University Course Curricula and  have the possibility, later, to presented that same information in many different ways (including a dependence graph). To an extended, most of it is done (and working), but hopeless lacking more testing and debugging.

Why is it included in the bundle? Well, it is needed, in part for completeness, by \tsobj[pkg]{ufrgscca-ppc}, which is “locally important”.

\subsection{Commands Creating the many lists}
The following commands “describe” a curricula, whereas one is a sequence of semesters \tsobj[meta]{semID}, each semester is composed by a list of classes, \tsobj[meta]{classID}, and each class has a list of dependencies, \tsobj[meta]{classID} as \tsmacro{\depdef}{}. All those lists are stored as csv lists, so “processing them” can be systematized.

\begin{codedescribe}{\topicdef,\defaulttopic}
\begin{codesyntax}%
    \tsmacro{\topicdef}[color]{topicID,text}
    \tsmacro{\defaulttopic}{topicID}
\end{codesyntax}
\tsmacro{\topicdef}{} defines \tsobj[meta]{topicID} (to be used when describing a class) and associates a \tsobj[meta]{text} description and a \tsobj[meta]{color} (for topic highlight). \tsmacro{\defaulttopic}{} sets the default one (if not explicitly given when describing a class).
\end{codedescribe}


\begin{codedescribe}{\semdef}
    \begin{codesyntax}%
        \tsobj[code]{\semdef}{\tsobj[oarg]{pos}\tsobj[xarg]{cod}\tsobj[marg]{semID}}
    \end{codesyntax}
This “defines” a semester, \tsobj[meta]{semID}, and associates with it a \tsobj[meta]{cod} (for reference) and a \tsobj[meta]{pos} (to be used by, for instance, \tsobj[pkg]{ufrgscca-curr-graph}.)
\end{codedescribe}


\begin{codedescribe}{\classdef,\setclass,\classremark}
    \begin{codesyntax}%
        \tsobj[code]{\classdef}{\tsobj[oarg]{topicID}\tsobj[xarg]{pos}\tsobj[marg]{classID}\tsobj[marg]{cred}\tsobj[marg]{typ}\tsobj[marg]{name}\tsobj[marg]{desc}}
        \tsmacro{\setclass}{classID}
        \tsmacro{\classremark}{remark}
    \end{codesyntax}
\tsmacro{\classdef}{} defines a class, associating with a \tsobj[meta]{topicID}, \tsobj[meta]{pos} (for \tsobj[pkg]{ufrgscca-curr-graph}), \tsobj[meta]{classID}, number and type, \tsobj[meta]{typ}, of credits, \tsobj[meta]{cred}, a long name, \tsobj[meta]{name} and description, \tsobj[meta]{desc}. \tsmacro{\classremark}{} adds an extra remark to it.

The following commands always refer to the “last defined” \tsmacro{\classdef}{} unless \tsmacro{\setclass}{} is used, which changes the “current class” for the following commands.
\end{codedescribe}

\begin{codedescribe}{\depdef,\altdef}
    \begin{codesyntax}%
        \tsobj[code]{\depdef}{\tsobj[oarg]{topicID}\tsobj[xarg]{pos}\tsobj[marg]{classID}}
        \tsmacro{\altdef}{}
    \end{codesyntax}
\tsmacro{\depdef}{} inserts/creates a “class dependency” list. The highlight color (if used) is usually defined by the current class topic (informing \tsobj[meta]{topicID} changes the highlight color). \tsobj[meta]{pos} is used by \tsobj[pkg]{ufrgscca-curr-graph} to determine the incident line angle.

\tsmacro{\altdef}{} defines/start and alternate dependency list.
\end{codedescribe}

\begin{codedescribe}{\bibdef}
    \begin{codesyntax}%
        \tsmacro{\bibdef}[type]{text}
    \end{codesyntax}
This is used to set a list of bibliographies, one per issued command. The default \tsobj[meta]{type} value is just \emph{bib}, possible values (as understood by \tsobj[pkg]{ufrgscca-curr-tab}) are \emph{bib}, \emph{basic} and \emph{comp}.
\end{codedescribe}

\subsection{List Processing Commands}
Those are the main loop commands that go through the lists.
\begin{codedescribe}{\LstClass,\LstDep,\LstTopic}
    \begin{codesyntax}
        \tsmacro{\LstClass}[cmd]{semID}
        \tsobj[code]{\LstDep}{\tsobj[oarg]{cmd}\tsobj[xarg]{ang}\tsobj[marg]{classID}}
        \tsmacro{\LstTopic}[cmd]{topicID}
    \end{codesyntax}
\tsobj[meta]{cmd} can be any command accepting a single argument. It will, in fact, be the one defining the way the data will, effectively, be presented.

\tsmacro{\LstClass}{} will process \tsobj[meta]{cmd} over all classes associated with \tsobj[meta]{semID}.

\tsmacro{\LstDep}{} will process \tsobj[meta]{cmd} over all dependency classes associated with \tsobj[meta]{classID}.

\tsmacro{\LstTopic}{} will process \tsobj[meta]{cmd} over all classes associated with \tsobj[meta]{topicID}.

\end{codedescribe}

\section{\tightul{ufrgscca-curr-tab} Package (beta) (ex\-tend\-ed documentation)}
This is truly a work in progress (based on some old ideas), not really tested. It shall be revised and, mostly sure, it will be changed (no compatibility guaranties).  It always pre-load \tsobj[pkg]{ufrgscca-curr} and \tsobj[pkg]{longtable}.

\subsection{Tabular Presentation Commands}
\begin{codedescribe}{\TabEtp,\TabTopic}
    \begin{codesyntax}%
        \tsobj[code]{\TabEtp}{\tsobj[xarg]{type}\tsobj[oarg]{sectioning}c\tsobj[marg]{semID}}
        \tsmacro{\TabTopic}[type]{topicID}
    \end{codesyntax}
\tsmacro{\TabEtp}{} will construct a longtable with all classes associated with \tsobj[meta]{semID} (including it's dependencies and bibliography).

\tsmacro{\TabTopic}{} will construct a longtable with all classes associated with \tsobj[meta]{topicID}.

\end{codedescribe}

\section{\tightul{ufrgscca-curr-graph} Package (beta) (extended documentation)}

\subsection{Graph Presentation Command}
Ironically, this is the “oldest” of the \tsobj[pkg]{-curr-} packages, but it is the less tested one, and the one whose code is more prone to fail in unexpected ways, be advised: do not try to use it, unless you know the internal code well. It always pre-load \tsobj[pkg]{ufrgscca-curr} (N.B. it also depends on \tsobj[pkg]{tikz}).

\begin{codedescribe}{\GraphSem}
    \begin{codesyntax}%
        \tsmacro{\GraphSem}[type]{semID}
    \end{codesyntax}
It will create a dependency graph for a given \tsobj[meta]{semId}. N.B. to start with, it is highly dependent on the semester sequence, one shall start with first semester and go from there.
\end{codedescribe}

\fi


\end{document}