Skip to content

HoTTEST-Seminar/HoTTEST-Seminar.github.io

Repository files navigation

EXAMPLE OF CORRECT 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
...

New talk files should be added to the TalkInfo folder. The termGenerator.py script can help with this. See that file for instructions.

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 shortened form of the month (Jan, Sept, etc. this is just for consistency purposes, as long as MON starts with the correct three letters it will be sorted correctly).
  • DD is the day, if it is a single digit, make sure there is a space between MON and DD.
  • SPEAKER is the name of the speaker
  • SCHOOL/INSTITUTION is the name of the name of the speaker's affiliation, this is okay to leave empty.
  • TALK TITLE is the title of the talk.
  • YOUTUBE LINK is the relevant links, this is okay to leave empty.
  • SLIDE_FILENAME_X are the relevant filenames (no "hottestfiles/" prefix necessary), multiple pdfs can be attached to a single talk and should be seperated by a single space. This is okay to leave empty.
  • ABSTRACT CONTENT is the abstract, which should be split into lines for the desired paragraph breaks. The abstract can be as long as you would like, but it must always be the last entry.
  • HTML can be added to ABSTRACT CONTENT and will be rendered correctly, such as, 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
  • Missing entries (other than youtube link/pdf/school)
  • "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 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)
  • Capitalization
  • Missing youtube link/slides/school
  • Ordering of entries (besides "Abstract:" which must go last)

About

Repository for the HoTTEST website.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •