What the Software Does

Much of the software creates files called index.html from files called index-template.html by doing substitutions. One thing that is substituted is the contents of file leftnav.html (found in the base directory), which contains the information in the left-hand navigation pane.

It also replaces TOP by a sequence of "../"-s sufficient to make a link refer to a file in the base directory. For example, if TOP/public/academic/index.html occurs in file public/academic/curriculum/index-template.html, then, when public/academic/curriculum/index.html is built, TOP is replaced by ../../.., so that the link refers to ../../../public/academic/index.html.

The software also creates tables such as the score and sample tables found in assessment result pages.

Index.html pages that need a link to each term in a directory have the list of terms created automatically. The same goes for pages that need a link to each course, to each academic year, to each outcome and to each ability in a directory.

Some index.html files are created from term-index-template.html or course-index-template.html one or two directories up, when all templates for a directory are the same.

To use software, use the scripts and executables in directory bin. Always use a script with the base directory as your current directory. For example, to run startAcademicYear, use command 

  bin/startAcademicYear
in the base directory.

List of software

bin/build

Build everything, for all academic years and terms.

bin/buildAcademicYear 2020-2021

Build everything beneath an directory called 2020-2021. Use an academic year, not some other kind of directory.

bin/buildTerm 2021-Fall

Build everything beneath an directory called 2021-Fall. Use a term, not some other kind of directory. All term names have the form Y-Fall or Y-Spring, where Y is a calendar year.

bin/buildAssessmentData

Build all automatic files in directory private/assessmentData, for all terms. Command 
  bin/buildAssessmentData 2021-Fall
only builds assessment data files for 2021-Fall

bin/buildBasic

Builds

bin/buildBlankDataForms

Build automatic files in directory private/preData, for every term. They are Command 
  bin/buildBlankDataForms 2021-Fall
only builds private/preData/index.html and private/preData/2021-Fall/*.

bin/buildCourseCoordinators

Build automatic files in directory public/academic/course-coordinators, for all academic years. The files are public/academic/course-coordinators/index.html and public/academic/course-coordinators/ACYR/index.html. Command 
  bin/buildCoursCoordinators 2021-2022
only builds public/academic/course-coordinators/index.html and public/academic/course-coordinators/2021-2022/index.html.

bin/buildCourses

Build automatic files in public/academic/courses, for all academic years. They are public/academic/courses/index.html and public/academic/courses/ACYR/index.html. Command 
  bin/build 2021-2022
only builds public/academic/courses/index.html and public/academic/courses/2021-2022/index.html.

bin/buildOffered

Build automatic files in public/academic/offered, for all terms. They are public/academic/offered/index.html and public/academic/offered/TERM/index.html. Command 
  bin/build 2021-Fall
only builds public/academic/offered/index.html and public/academic/offered/2021-Fall/index.html.

bin/buildPortfolios

Build all automatic files in private/portfolios, for all terms. They are private/portfolios/index.html and private/portfolios/TERM/index.html. Command 
  bin/buildPortfolios 2021-Fall
only builds private/portfolios/index.html and private/portfolios/2021-Fall/index.html.