summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ufrgscca/doc/ufrgscca.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/ufrgscca/doc/ufrgscca.tex')
-rw-r--r--macros/latex/contrib/ufrgscca/doc/ufrgscca.tex42
1 files changed, 30 insertions, 12 deletions
diff --git a/macros/latex/contrib/ufrgscca/doc/ufrgscca.tex b/macros/latex/contrib/ufrgscca/doc/ufrgscca.tex
index 9b5171802b..413f1fc7d6 100644
--- a/macros/latex/contrib/ufrgscca/doc/ufrgscca.tex
+++ b/macros/latex/contrib/ufrgscca/doc/ufrgscca.tex
@@ -2,7 +2,7 @@
% !TEX ext = --interaction=nonstopmode --enable-etex --enable-write18
% !BIB program = none
%%%==============================================================================
-%% Copyright 2022-23 by Alceu Frigeri
+%% Copyright 2022-present by Alceu Frigeri
%%
%% This work may be distributed and/or modified under the conditions of
%%
@@ -15,7 +15,7 @@
%%
%% The Current Maintainer of this work is Alceu Frigeri
%%
-%% This is version {2.2} {2023/12/02}
+%% This is version {2.3} {2023/12/05}
%%
%% The list of files that compose this work can be found in the README.md file at
%% https://ctan.org/pkg/ufrgscca
@@ -644,11 +644,12 @@ These are, respectively, \tsobj{\starray_get_prop:nn, \starray_term_syntax:n,\st
\end{codedescribe}
-\begin{codedescribe}[code,new=2023/11/18]{\studentiterate}
+\begin{codedescribe}[code,new=2023/11/18,update=2023/12/02]{\studentiterate,\studentadvisoriterate}
\begin{codesyntax}%
\tsmacro{\studentiterate}{code}
+ \tsmacro{\studentadvisoriterate}{code}
\end{codesyntax}
-This is \tsobj{\starray_iterate_over:nn} from \tsobj[pack]{starray}. \tsobj[meta]{code} will be executed for every defined student.
+These are \tsobj{\starray_iterate_over:nn} from \tsobj[pack]{starray}. \tsobj[meta]{code} will be executed for every defined student, \tsobj{\studentiterate} or student's advisor, \tsobj{\studentadvisoriterate}.
\end{codedescribe}
\begin{codedescribe}[code,new=2023/11/29]{\ActivityCalendarIterate}
@@ -1051,12 +1052,13 @@ Those commands are only of use when using \tsobj[pkg]{ufrgscca-coord}. \tsmacro{
\end{codedescribe}
-\begin{codedescribe}[code,new=2023/11/18]{\studentCase,\studentCoadvCase,\studentDismissCase,\studentNewPageCase,\studentDistinctBoardCase}
+\begin{codedescribe}[code,new=2023/11/18,update=2023/12/02]{\studentCase,\studentAdvCase,\studentCoadvCase,\studentDismissCase,\studentNewPageCase,\studentDistinctBoardCase}
\begin{codesyntax}%
\tsmacro{\studentCase}{if-A-B-C,if-D,if-Exam-C,if-Exam-D,if-FF}
+ \tsmacro{\studentAdvCase}{if-more-than-one,if-not}
\tsmacro{\studentCoadvCase}{if-defined,if-not}
\tsmacro{\studentDismissCase}{if-dismiss,if-not}
- \tsmacro{\studentNewPageCase}{if-new,if-not}
+ \tsmacro{\studentNewPageCase}{if-newpage,if-not}
\tsmacro{\studentDistinctBoardCase}{if-distinct,if-not}
\end{codesyntax}
These are a set of auxiliary conditionals, for instance, \tsobj{\StudentCase} will execute \emph{only one} of the \tsobj[meta]{if-} accordingly.
@@ -1180,6 +1182,13 @@ These are a set of auxiliary conditionals, for instance, \tsobj{\StudentCase} wi
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}[code,new=2023/12/04]{\studentaddtolist}
+ \begin{codesyntax}%
+ \tsmacro{\studentaddtolist}{listID}
+ \end{codesyntax}
+Adds the student to a given list (defined by \tsobj[marg]{listID}), to be later used by \tsobj{\sortstudentlist} and \tsobj{\tcreport}.
+\end{codedescribe}
+
\begin{codedescribe}{\checklist}
\begin{codesyntax}%
\tsmacro{\checklist}{csv-checkitems}
@@ -1196,7 +1205,7 @@ To set the \tsobj[meta]{local}, \tsobj[meta]{date} and \tsobj[meta]{time} of a s
\end{codedescribe}
\begin{tsremark}
-\tsobj[meta]{date} must be given in numerical form, either \tsmeta{day}/\tsmeta{month} or \tsmeta{day}/\tsmeta{month}/\tsmeta{year}. The day-of-the-week will be obtained using \tsobj[pkg]{pgfcalendar}.
+\tsobj[meta]{date} must be given in numerical form, either \tsmeta{day}/\tsmeta{month} or \tsmeta{day}/\tsmeta{month}/\tsmeta{year}. The day-of-the-week will be obtained using \tsobj[pkg]{pgfcalendar}.\\ Likewise, \tsobj[marg]{time} must be given in a (24h) \tsmeta{hour}:\tsmeta{min} format.
\end{tsremark}
@@ -1250,18 +1259,27 @@ Quite obvious, this set the grades given by an examiner (the one defined by the
\begin{codedescribe}[code,update=2023/11/29]{\setstudentlist}
\begin{codesyntax}%
\tsmacro{\setstudentlist}{listID,list}
- \tsmacro{\setstudentlist*}{listID,list}
- \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 hashes (as defined by \tsmacro{\student}[student-hash]{...}). The star version sorts the list by student's full name, the \emph{plus} version sorts the list by student's presentation date.
+This command will define/create a list named \tsobj[meta]{listID} composed of a csv \tsobj[meta]{list}~ of student hashes (as defined by \tsmacro{\student}[student-hash]{...}).
+\end{codedescribe}
+
+\begin{codedescribe}[code,new=2023/12/04]{\sortstudentlist}
+ \begin{codesyntax}%
+ \tsmacro{\sortstudentlist}{listID}
+ \tsmacro{\sortstudentlist*}{listID}
+ \tsmacro{\sortstudentlist+}{listID}
+ \end{codesyntax}
+These will sort (and classify) a given student list defined by \tsobj[meta]{listID}. The star version sorts the list by student's full name, the \emph{plus} version sorts the list by student's presentation date.
+By default, the list remains unchanged (no sort).
\end{codedescribe}
+
\begin{codedescribe}{\tcreports}
\begin{codesyntax}%
- \tsmacro{\tcreports}[rep-list]{listID}
+ \tsmacro{\tcreports}[report-list]{listID}
\end{codesyntax}
This will typeset the many reports, using the student list defined by \tsobj[meta]{listID}.
- \tsobj[meta]{rep-list} is a csv list of keys as follow:
+ Where \tsobj[meta]{report-list} is a csv list of keys as follow:
\end{codedescribe}
\begin{describelist}{option}