auto-multiple-choice-annotate — completed answer sheets annotation after marking for AMC multiple choice exams.
auto-multiple-choice annotate --project
project-dir --names-file
students.csv [annotation options...]
The auto-multiple-choice annotate command annotates papers scans with scores for all questions, global score and mark, resulting in PDF files (one for each student, or one single file).
--project
project-dirsets the project name or directory.
--data
project-data-dirgives the directory where data files are (default value
is
).project-dir/data
--pdf-dir
pdf-dirsets the project pdf directory, where to output
annotated scans (default value is
).project-dir/cr/corrections/pdf
--names-file
students-list.csvsets the students list file name.
--names-encoding
encodingselects an encoding for file
students-list.csv (default is
utf-8).
--association-key
keysets the key (column name in the students list file) that is used for association. Default value is stored in the database from value actually used for association, so this option should not be used.
--subject
subject.pdfsets the path to the PDF question file (default is
).project-dir/DOC-sujet.pdf
--compose
modeuse this option if you want to take pages from the
subject when there is no boxes to be filled on them (for
example, question pages before the annotated answer sheet).
When mode equals 1, the pages are
taken from the subject, are filled or not according to the
student's answers (the same as on the answer sheet), and the
same correction marks are drawn as on the answer sheet. When
mode equals 2, the pages are taken from the corrected answer
sheet (so the ticked answers are the correct ones), and no
correction marks are drawn.
--corrected
corrected.pdfsets the path to the PDF corrected subject (default is
).
If not present, this file will be built using values from
options project-dir/DOC-corrected.pdf--n-copies, --with,
--filter and
--filtered-source).
--darkness-threshold
tsets the darkness threshold. Default value is stored in the database from value actually used for scoring, so this option should not be used.
--darkness-threshold-up
upper_tsets the upper darkness threshold. Default value is stored in the database from value actually used for scoring, so this option should not be used.
--csv-build-name
name-modelsets the model for building students names from the
students list file. Default value is '(nom|surname)
(prenom|name)', so that the name is built using the
nom column content (or the surname
column if the nom column does not exist),
followed by the content of the prenom column (or
the name column), so that the result should be OK
for French or English simple CSV files.
--id-file
ids.txtgives a filename where to find the ids of copies to
annotate (one per line, either the student number if photocopy
mode is off, or
if the photocopy mode is on). If no file is given, then all
copies will be annotated.student:copy
--debug
file.loggives a file to fill with debugging information.
--single-outputuse this option if you need all annotated copies in a single PDF file. Default behavior is to build one PDF file per student.
--sort
ssets the sort key (only useful when using
--single-output): use
to keep students in the same order as in the students list file.
to sort students according to their marks.
to sort students according to the copy id.
to sort students according to their names.
--filename-model
modelsets a file name model for annotated PDFs. In this model, some sequences will be substituted:
(ID)is replaced by the student's name (see
--csv-build-name).
(N)is replaced by the student number.
(COL)is replaced by the value of column
COL in the students list for
the current student.
The default value is
'(N)-(ID).pdf'.
These options are used when the --corrected
path points to a non-existing file, so that this file can be
rebuilt.
--src mcq-source-file
--n-copies n --with
latex-engine --filter
filter-name --filtered-source
fs.texsee auto-multiple-choice-prepare(1).
When present, scans are embedded in the annotated PDF file. The following options control the quality of the embedded scans, to reduce the annotated file size.
--embedded-max-size
maxsizesets the maximal size for scans (in the format
,
in pixels). Default value is the empty string, which means
there is no maximum size. Scans that are larger will be
reduced before being included in the annotated file.widthxheight
--embedded-format
formatsets the format for scans inclusion:
jpeg or
png.
--embedded-jpeg-quality
qualitysets the JPEG quality (from 1 to 100) for jpeg embedded scans.
These options controls what kind of annotations are being to be drawn.
--font-size
fssets the font size, in points, for annotations.
--text-color
colortext color for annotations. Default value is
red.
--verdict
headersets the text header to be printed on each first page of the students copies. This text may contain CR characters for multi-line headers. Some sequences are substituted in it:
%Sis replaced by the student total score.
%Mis replaced by the maximum total score.
%sis replaced by the student mark.
%mis replaced by the maximum mark.
%(ID)is replaced by the student's name.
%(COL)is replaced by the value of column
COL in the students list for
the current student.
--position
possets the position where question scores are to be written:
the scores will be written in the left margin
the scores will be written in the closest margin (left or right).
the scores will be written near the boxes
the scores won't be written.
perl-expressionsets the text to be printed next to all questions,
through a perl expression to be evaluated (if you need a
simple text, simply quote it with "). Some
sequences are substituted in it before evaluation:
%Sis replaced by the student score for this question.
%Mis replaced by the maximum score for this question.
%sis the same as %S, but rounded to
nc significant digits (see
option --ch-sign).
%mis the same as %M, but rounded to
nc significant digits (see
option --ch-sign).
A standard value for this option is
"\"%s/%m\"". You can also use tests (with the
perl syntax ( TEST ? IF-YES : IF-NO )) to write
Valid if the score is the maximal score,
or Failed if not, using
--verdict-question "(%S==%M ? \"Valid\" : \"Failed\")"
perl-expressionsame as --verdict-question, but applies
for cancelled questions (see allowempty scoring
strategy). The default value is "X".
--indicativesuse this option to request boxes annotation for indicative questions (these questions' scores won't be taken into account while computing the global score. The correct/wrong status is often irrelevant for these questions, so there is no point correcting the corresponding boxes).
--line-width
widthsets the line width (in points) when drawing symbols to correct answers.
--symbols
symbols-definitiondefines how boxes will be annotated. symbols-definition
is a comma separated list of
constructs, where H-A:shape:colorH is
0 or 1 depending on
whether the box has to be checked or not,
A is 0 or
1 depending on whether the box is actually
checked or not, shape is one of
none, circle,
mark, box and
color is a color (name or #RGB, see
ImageMagick or GraphicsMagick documentation for details).
Default value is
"0-0:none,0-1:circle:red,1-0:mark:red,1-1:mark:blue".
The following length can be given with a unit
(in, ft, pt, cm
or mm).
--dist-to-box
dsets the distance from the boxes (going left) where to
write questions scores when using --position
case.Defaults to 1cm.
--dist-margin
dsets the margin size. Defaults to
5mm.
--dist-margin-global
dsets the margin size for the header. Defaults to
3mm.