Overview

This repository is used to generate the HoTTEST website: https://hottest-seminar.github.io/

The information for each talk is stored in a file in the TalkInfo folder, using a file name like AndyPitts-Sep20.txt. See below for details about the format.

At the beginning of each term, the termGenerator.py script can be used generate these files, with just the essential information filled in. After soliciting a title and abstract, you can update the appropriate file.

Whenever a TalkInfo file is created or changed, you need to run the script ./indexGenerator.py which updates index.html. You can preview this in your local browser to make sure it looks correct. Then you commit the changes to the TalkInfo file and index.html, push your commit to github, and wait around 30 seconds. Then reload the website https://hottest-seminar.github.io/ to check that all is good.

Aside: If you run indexGenerator.py on the day a seminar occurs, it will become a "past" talk. If you still want it to be a future talk, you can run: faketime yesterday ./indexGenerator.py (after installing faketime on your system).

When you get the pdf file after a talk, you put it in the hottestfiles folder, following the naming convention there, and update the TalkInfo file to refer to it. Then regenerate as described above, and commit the TalkInfo file, the pdf file, and index.html.

Dan currently handles adding the YouTube links.

See also calendarGenerator.py for how to create the initial Google calendar entries for a term.

Formatting for talk files

Term: TERM YYYY
Date: MON DD
Speaker: SPEAKER NAME
School: SCHOOL/INSTITUTION Title: TALK TITLE
YouTube: YOUTUBE LINK
Slides: SLIDE_FILENAME_1 SLIDE_FILENAME_2 ...
Abstract: ABSTRACT CONTENT
ABSTRACT CONTENT
...

NOTES:

• TERM should be either "Spring" or "Fall" for regular sessions, special terms can be added (such as the Jr. Researcher Event), but a corresponding entry must be added to termIDDict in indexGenerator.py for sorting purposes.
• YYYY is the year.
• MON should be the first three letters of the month.
• DD is the day, as one or two digits.
• SPEAKER is the name of the speaker, with first name first.
• SCHOOL/INSTITUTION is the name of the name of the speaker's affiliation; this can be left empty.
• TALK TITLE is the title of the talk, usually with only the first word and proper nouns capitalized.
• YOUTUBE LINK is the relevant link.
• SLIDE_FILENAME_X are the relevant filenames (no "hottestfiles/" prefix necessary); multiple pdfs can be attached to a single talk and should be separated by a single space.
• ABSTRACT CONTENT is the abstract, with each paragraph as a single long line. A line break indicates a new paragraph, and there should be no empty lines between paragraphs. The abstract must always be the last entry.
• HTML can be added to ABSTRACT CONTENT and will be rendered correctly, e.g., if you want to include a hyperlink.

THINGS THAT WILL AFFECT PAGE GENERATION (indexGenerator.py will throw an exception):

• Misspelled line starters
• Improperly formatted term or date entries
• Certain missing entries (e.g. Term, Date, Speaker)
• "Abstract:" not being the last entry (the exception that will show up in this case is for missing entries of whatever was below "Abstract:")
• > and < symbols in abstract (must be replaced with &gt; and &lt; to not get the following error: yattag.indentation.XMLTokenError)

THINGS THAT WILL NOT AFFECT PAGE GENERATION:

• File name
• Whitespace differences (either before or after lines, between entry label and content, or general blank lines)
• Ordering of entries (besides "Abstract:" which must go last)