Scripts to manage lecture notes
Shell TeX
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
common
example
gpp
grading
pandoc-templates
.gitignore
LICENSE
README.md
findgrades.sh
getpdf.sh
gradembox.sh
head_lecture.sty
head_outline.sty
markdown.sh
note.sh
textgen.sh

README.md

ClassManagement

After teaching for years, I got tired of updating my lecture notes when changing systems and word processors. I worked in WordPerfect to Microsoft Word to LibreOffice, and maybe a few others in between. No LaTeX? It seemed like a nice idea, but I wasn't aware of any convenient PC-based system and it wasn't popular at my school, which was run mostly by engineers.

That has changed, so this is my attempt to future-proof the notes. Various shell scripts grab the text out of the notes, convert them to Markdown for permanent storage (and suitable for version control), and process them into PDF packages with everything needed for the night.

Likewise, rather than spreadsheets for grades in each class and manual extraction of information to notify students of their end-of-semester grades, the grading system has been stripped down to centralized CSV files with a script to process it.

Right now, it's a hodge-podge of small scripts tuned specifically for my existing setup, but hopefully will be generalized and modernized quickly.

Workflow

There are quite a few scripts floating around, here, documented below. Some of them are used infrequently, some intended mostly as support for a broader process. So, to summarize the use:

  • textgen.sh converts a folder of Microsoft Word documents with an appropriate naming convention into Markdown documents with minimal formatting. The script will generally only need to be run once per course; the Markdown format has fewer requirements for editing and maintaining, after all. They do, however, need to be reviewed for any formatting that needs restoration. The script makes use of markdown.sh, to easily experiment with and adjust the input and output types without needing to worry about the full process.

  • getpdf.sh takes the Markdown notes required for a particular lecture, converting and bundling them into a single PDF file. If the <#note ... > GPP macro is used, the script will generate the full lecture notes and a lecture outline for distribution. It makes use of note.sh for the conversion(s), which handles an individual document.

  • findgrades.sh calculates the grades for a class in a convenient table or delimited output. Primarily designed for use at the end of the semester, it also calculates the grade required (at the current point of time) on the final exam for an A, B, and C in the class, if no other changes are made.

  • gradembox.sh generates outgoing mail for each student with their final grade for the course. Obviously, only meant to run at the end of the semester.

In addition to this, the following files need to be maintained.

  • grading/classes.txt contains information on each course section, which should be added at the beginning of the semester.

  • grading/students.txt contains information on each student, also updated at the start of every semester, both for new students and any changes to contact information.

  • grading/enroll.txt indicates which students are enrolled in which sections, also best updated at the start of the semester.

  • grading/grades.txt contains the each student's grades for each course, best updated throughout the semester as grades come in.

The files, of course, aren't very different from maintaining any grade record.

Macros

Because Markdown is not exactly designed for desktop publishing in the conventional sense, we extend it here with a preprocessor to insert additional markup codes where necessary.

The scripts assume that the macros are in "HTML format," embedded into the text as <#macro arguments-or-text>. What are probably the most useful macros include...

  • file, literal, and code all currently translate to preformatted, monospaced text, Markdown backquotes.

  • book formats a book title, currently bold-facing the name.

  • epigram indents and italicizes a quote, in addition to surrounding it by quotation marks. The similar epigramnq doesn't close the quotation marks, for the rare cases where that's useful. attribution deeply indents an author attribution for the epigram, prefacing it with an em-dash.

  • qa slightly indents and italicizes a paragraph, intended as the answer to an exam question, for sample exams.

  • note metaphorically splits a document in two, creating full-text notes (for a lecturer, say) and an outline (to be handed out). In the full-text version, the macro does nothing, just passing the contents through. For the outline, the macro removes the contents entirely.

  • space fills space between two elements to push the surrounding objects to the margins; if the output medium doesn't support it, the macro simply inserts a non-breaking space. newline inserts a line in output formats where it makes sense. page inserts a page break when the output format supports such an idea.

  • usejoins prepares the document to use database join symbols later in the text for output formats that require it.

In addition to those, assorted symbols have been added as I have needed them. Most of the Greek letters (capital and lowercase, named like <#alpha> and <#Alpha>), Latin vowels with diareses (<#auml> et al), various mathematical symbols (times, plusminus, divide, element, notelement, abs, sqrt, subset, supset, isect, union, setdiff, negate, cross, power, empty), and database join symbols (join{l,r,f}).

To make use of the macros, the Markdown file must include the macro package, with some variation of:

<#include "gpp/macros.gpp">

near the top of the notes.

markdown.sh

This script gets the ball rolling. It takes a Microsoft Word document as an input, converts it to plain text, and indents the ordered lists to show up properly.

This assumes that lecture points are organized along the lines of what I've done for many years...

1.  Main Point.
    a)  Subsidiary topic.
        i.  Minor issues.

The script also assumes that you have antiword installed.

Due to antiword not being built for the purpose, the resulting output file is only Markdown in terms of the ordered lists. Any use of bold, italics, or different typefaces must be handled manually.

textgen.sh

While markdown simply strips the text out of a single document, textgen takes a target directory and uses or derives a common prefix to convert many files via the markdown script. To work, it presumes a common format for source files, in the form CREF Lecture X (Title).doc, where

  • CREF is a course reference number,

  • X is a number, and

  • Title indicates the lecture contents.

Converting a file with such a name will produce a Markdown-formatted file named like X_title.md.

The script actually operates by generating a temporary script, which is executed and deleted behind the scenes.

note.sh

The note script takes a set of lecture notes or supplemental material in Markdown format (with GPP preprocessor directives) as input and outputs a converted file in the specified format. If the input material doubles as notes and a handout, the script generates both.

Invoke it with:

note.sh input_file.md output_type class_name

For example, a typical run might look like:

$ sh ../note.sh 06a_parameters.markdown pdf cs0000
DONE with outline!

$ l cs*
cs0000_06a_parameters_outline.pdf  cs0000_06a_parameters.pdf

The script assumes that you have GPP the Generic Preprocessor and Pandoc installed. Pandoc's template files are also assumed to be in a sister folder to the Markdown documents.

getpdf.sh

The getpdf script leverages node.sh to generate and package everything needed for a lecture into one PDF package. Looking for the (zero-padded, two-digit) lecture number, it creates each component, plus a blank attendance sheet for the first night.

A typical session might look like:

$ sh ../getpdf.sh 04 cs0000
DONE with outline!
DONE!
PDF DONE!
PDF DONE!

$ ls CS*
CS0000_L04.pdf

The script assumes that you have PDFtk installed.

Please note that, in calling pdftk, the script intentionally avoids quoting $pdflist against the judgment of any semantic checker (such as shellcheck). In this case, word splitting is a requirement, because the variable holds multiple file names. As a result, this presumably means that the PDF files to assemble may not have spaces in them. My source files have no spaces, so this is no danger.

findgrades.sh

The findgrades script is a stripped-down, single-purpose database for processing class grades. The required data is spread across three files:

  • classes.txt identifies each class along with the layout of grades for the class. Its format is CREF,TERM,SECTION,Homework,Midterm,Final,MidtermComponents,FinalComponents (example: cs6033,092,12345,20,40,40,1,3), as follows.

    • The course reference number (CREF) identifies the course, something like cs101, but can literally be anything.

    • The term identifies which semester the course is/was given, following the codes used by my school. This should be a three-digit number where the first two digits are the last two digits of the year and the final digit is the semester number, 1 for winter, 2 for spring, 3 for summer, or 4 for fall. Can theoretically be anything, but findgrades will guess the current semester if not given anything explicit. The example above is spring (2) of 2009.

    • The section is whatever magic identifier is used for students to register for that class, where there are choices. Again, this could be anything and will probably be unused except for reporting.

    • Homework is the percent of the final grade contributed by average homework scores.

    • Midterm is the percent of the final grade contributed by the midterm exam grade.

    • Final is the percent of the final grade contributed by the final exam grade.

    • Midterm components counts the number of separate scores totalling the midterm exam grade. Likely to be 1 most of the time, but accounts for exams that include multiple parts.

    • Final components, like the midterm, counts the number of separate scores totalling the final exam grade. Likely to be 1 most of the time, but accounts for exams that include multiple parts.

  • students.txt contains contact information for each student, in the form Last,FirstPlus,StudentID,Phone,EMail (example: Kent,Clark N. (Superman),657001938,2925551234,ckent@dailyplanet.com), as follows.

    • Last Name is the student's family name.

    • First Name is the student's given name, plus any other information. Generally, whatever is in parentheses should be the student's preferred mode of address.

    • Student ID is exactly what it sounds like, either issued by the school or (if your data is very old) possibly a Social Security Number as in the example above.

    • Telephone Number is hopefully self-explanatory.

    • E-Mail Address should also be self-explanatory.

    • Note that it is not used by the findgrades script, but rather is a simple format to connect the students with grades.

    • Also note that my school banned communication with students regarding grades except in person or where contact information was gathered on the student's first attending class. This is why getpdf.sh adds an attendance sheet to the first night's bundle, even though I never check attendance.

  • enroll.txt pairs students with classes. It generally looks something like Name,ID,CREF (example: Kent,657001938,12345) as follows, though each item has been seen before.

    • Name is the student's family name, as it appears in students.txt and grades.txt.

    • ID is the student ID number, like in students.txt.

    • CREF is the course reference number as in classes.txt.

    • Note that I did not originally think of this capability (I initially processed e-mails separately), and so created a draft copy by sorting the student and grade files (squeezing out extra space) and running join -t ',' -1 1 -2 1 students-sorted.txt grades-sorted.txt | cut -d',' -f3,6,1 > enroll.txt.

  • grades.txt, lastly, contains each student's grades for each course taken. The format here is more free-form, because different courses have different assignments. However, generally, they look something like Name,Section,Extra,Homework+,Midterm+,Final+ (example: Kent,12345,14,10,10,10,10,94,97) as follows.

    • Name is however you identify students. I use last names unless there are multiples in the class.

    • Section is the magic identifier from classes.txt, so the script knows what to look for.

    • Extra Credit points get added to the homework total in my classes. If you need something else, the awk code will need to change.

    • Some number of homework grades, graded in my classes on a 0-10 scale. The script considers whatever isn't another field to be a homework grade.

    • Some number of midterm exam component grades, which need to match whatever count you provided in classes.txt.

    • Some number of final exam component grades, which also need to match the count provided in classes.txt.

Please note that the script determines the grades based on whatever I last used to calculate them, including extra credit, points added for extreme improvement, and so forth. If your grading policy is different, it needs to change in the awk code.

Invoking findgrades produces a table summarizing class performance, with tallies for the homework, midterm, final, any additional points (again, for improvement), a letter grade, and a final column to show the grade needed on the final for an A, B, or C, given the current conditions, in case that information is needed before the final.

A typical session might look something like the following.

$ sh findgrades.sh cs9801 142
Name             HW	     Mid	 Fin	 Esc	 Avg	L	( A / B / C )
-----------     -----	-----	-----	----	------	--	-------------
Browning        27.75	34.00	34.00	 0.0	 95.75	A
Cabrera         36.25	36.00	37.20	 2.5	111.98	A
Frazier         39.25	28.00	38.40	 4.4	110.03	A
Hutchinson      25.75	34.00	36.40	 0.0	 96.15	A
Jiminez         24.75	34.00	32.80	 0.0	 91.55	A-	( 91)
Lee             34.00	38.00	41.60	 1.8	115.39	A
Moran           28.00	38.00	39.60	 0.0	105.60	A
Savage          33.25	38.00	36.00	 0.0	107.25	A
Whitaker        29.25	20.00	20.00	 0.0	 69.25	C	(114/ 84)

If no arguments are given, the script will guess at the current semester (as I write this, it's December of 2014 or 144). If there is only one class available for that semester, it will process grades for that class. If there are multiple possibilities, it will list them, instead.

gradembox.sh

gradembox is technically new development. For many years, especially prior to modern student record systems that could be accessed at any time, I sent out e-mail with each student's grade so that they wouldn't need to wait for the paper grade report to be mailed. I had a script that pulled the information off of a spreadsheet to generate simple messages to be sent, but never really maintained it.

This script re-creates that in a handier package.

Invoke gradembox like...

$ sh gradembox.sh cs9801 142 you@school.edu "Your Name"

If fewer than two parameters are provided, the script exits with a usage message. If the e-mail address or name isn't provided, the script tries to guess it. Obviously, the guesses are likely to be wrong, except maybe on school-maintained systems that are so infrequently available, today, so be warned.

The output is a series of e-mails outlining each student's grade for the final exam and course.

Currently, it looks something like...

$ sh gradembox.sh cs9801 142 jimmy@crime.edu "James Moriarty"
From - Mon Dec  8 11:16:30 EST 2014
Subject: CS6083 Final Grades
From: James Moriarty <jimmy@crime.edu>
To: Sherlock Holmes <sh221b@baker.onion>
Date: Mon, 08 Dec 2014 11:16:30 -0500

Hi, Sherlock--

This is to notify you of your grade.  You earned a 36.40 on
the final exam.  With homework and extra credit, that brings your
overall average to an 81.93, which is a B-.

                              --James

And so on. This is essentially in mbox format, which should be usable by most e-mail clients, if you redirect it into a file.

If you only use webmail, though, good luck...

Example Class

To test out the scripts and to give a sense of the expected format, there is a self-referential "first lecture" in the example directory.

The lecture uses the format I typically use for lecture notes and at least superficially describes each major piece. There is also a fake syllabus (the month names are Anglicized versions of the French Revolutionary calendar) and a trivial "sample program" in a hypothetical programming language. The latter is there just to illustrate supplemental content, with no relevance to the example.

If the previous content didn't sink in, here's how to generate the "first night packet."

cd example
sh ../getpdf.sh 01 xx101

The script output will be...

DONE!
DONE with outline!
DONE!

This will create XX101_L01.pdf, which includes...

  • Full-text lecture notes,
  • Attendance sheet,
  • Sample syllabus,
  • Lecture outline, and
  • Sample program

The first two parts are intended to be kept, and the remainder copied and collated to hand out to the students.