Automated calculation of current year and first Monday.

nigel.stanger / Handbook

Browse code Automated calculation of current year and first Monday. This means we no longer have to change the dates every year! Note that this does imply that the scripts now always generate output for the current year, so you can’t run them ahead of time (e.g., in December). master
1 parent 0395e76 commit 934d265e67aabacbd7bf1538903a609e19715663 Nigel Stanger authored on 31 Jan 2019

Browse code

This means we no longer have to change the dates every year! Note that this does imply that the scripts now always generate output for the current year, so you can’t run them ahead of time (e.g., in December).

master

1 parent 0395e76 commit 934d265e67aabacbd7bf1538903a609e19715663

Nigel Stanger authored on 31 Jan 2019

Patch

Showing 2 changed files

Ignore Space Show notes View calendar/generate_calendar.php
<?php /* This script generates a LaTeX include file that contains macros specifying the date ranges for every week of the three main teaching periods through the year (i.e., summer school, first semester, second semester). Simply set the configuration as outlined below and run the script, saving the output in a suitable location, ideally only once for all papers. A good spot would be somewhere in the TeX search path. / // LaTeX macro names can't include numbers, so we have to convert them to words. require 'Numbers/Words.php'; / Teaching period configuration. It's easily extensible to a new teaching period simply by adding a new specification for that period. The key should be valid as a LaTeX macro name (i.e., no spaces, no digits, no punctuation). The components of each period specification are: first_week: The academic week number of the first week of the period. last_week: The academic week number of the last week of the period. break_weeks: A list of breaks that occur during the teaching period. Each is specified by the start (break_start) and end (break_end) week. If a break is only one week long, then break_start and break_end should be equal. If there are no breaks in the teaching period, include a single break specification with both break_start and break_end set to zero. The list should ideally be in ascending order, but the script doesn't assume this and sorts the list anyway. Weeks are numbered by academic week number (i.e., week 1 is the first academic week of the year). The date of the first Monday of the year is stored in $first_monday below (everything is Monday-indexed). Note that academic week is normally the same as absolute calendar week. Example: $periods = array( 'SummerSchool' => array( 'first_week' => 2, 'last_week' => 7, 'break_weeks' => array( array( 'break_starts' => 0, 'break_ends' => 0, ), ), ), 'SemesterOne' => array( 'first_week' => 9, 'last_week' => 22, 'break_weeks' => array( array( 'break_starts' => 14, 'break_ends' => 14, ), ), ), 'SemesterTwo' => array( 'first_week' => 28, 'last_week' => 41, 'break_weeks' => array( array( 'break_starts' => 35, 'break_ends' => 35, ), ), ), 'FullYear' => array( 'first_week' => 9, 'last_week' => 41, 'break_weeks' => array( array( 'break_starts' => 23, 'break_ends' => 27, ), array( 'break_starts' => 15, 'break_ends' => 15, ), array( 'break_starts' => 35, 'break_ends' => 35, ), ), ), ); / require 'calendar_config.php'; // Get first Monday of week 1 according to ISO 8601. $year = date("Y"); $first_monday = new DateTime(); $first_monday->setISODate($year, 1); // A couple of handy date intervals: four days to the end of the current week, // and seven days to the start of next week. $plus_four_days = new DateInterval( 'P4D' ); $plus_seven_days = new DateInterval( 'P7D' ); $numwords = new Numbers_Words(); printf( "%% Teaching calendar dates for %s.\n", $year ); foreach ( $periods as $period_name => $period_data ) { $week_start = clone( $first_monday ); // Jump forward the correct number of weeks to the start of the teaching period. $week_start->add( new DateInterval( sprintf( "P%dD", ( $period_data['first_week'] - 1 ) 7 ) ) ); $week_number = 0; $num_breaks = 0; // Grab the first break week off the front of the list. sort( $period_data['break_weeks'] ); $break_week = array_shift( $period_data['break_weeks'] ); for ( $week = $period_data['first_week']; $week <= $period_data['last_week']; $week++ ) { $week_end = clone( $week_start ); $week_end->add( $plus_four_days ); // Handle break weeks. if ( ( $week >= $break_week['break_starts'] ) && ( $week <= $break_week['break_ends'] ) ) { if ( $week == $break_week['break_starts'] ) { $num_breaks++; // Work out the end date of the break. $break_end = clone( $week_start ); // Note: +4 days to get to Friday. $break_end->add( new DateInterval( sprintf( "P%dD", ( ( $break_week['break_ends'] - $break_week['break_starts'] ) * 7 ) + 4 ) ) ); // Output macro for inclusion in paper calendar. printf( "\\newcommand{\\%sBreak%s}{%s--%s}\n", $period_name, str_replace( "-", "", ucfirst( $numwords->toWords( $num_breaks ) ) ), // If the week start and end dates are in the same month, we only // need to output the month name once. ( $week_start->format( 'n' ) == $break_end->format( 'n' ) ) ? $week_start->format( 'j' ) : $week_start->format( 'j M' ), $break_end->format( 'j M' ) ); } // if current week == first week of break if ( $week == $break_week['break_ends'] ) { // Grab the next break week off the front of the list. $break_week = array_shift( $period_data['break_weeks'] ); } // if current week == last week of break } // if current week is a break week else { $week_number++; // If the week start and end dates are in the same month, we only // need to output the month name once. if ( $week_start->format( 'n' ) == $week_end->format( 'n' ) ) { // Output macro for inclusion in paper calendar. printf( "\\newcommand{\\%sWeek%s}{%s--%s \\\\ %s}\n", $period_name, str_replace( "-", "", ucfirst( $numwords->toWords( $week_number ) ) ), $week_start->format( 'j' ), $week_end->format( 'j' ), $week_end->format( 'M' ) ); } // if same month else { // Output macro for inclusion in paper calendar. printf( "\\newcommand{\\%sWeek%s}{%s \\\\ --%s}\n", $period_name, str_replace( "-", "", ucfirst( $numwords->toWords( $week_number ) ) ), $week_start->format( 'j M' ), $week_end->format( 'j M' ) ); } // else different months } // else normal teaching week $week_start->add( $plus_seven_days ); } // for each week } // foreach teaching period ?> <?php /* This script generates a LaTeX include file that contains macros specifying the date ranges for every week of the three main teaching periods through the year (i.e., summer school, first semester, second semester). Simply set the configuration as outlined below and run the script, saving the output in a suitable location, ideally only once for all papers. A good spot would be somewhere in the TeX search path. / // LaTeX macro names can't include numbers, so we have to convert them to words. require 'Numbers/Words.php'; / Teaching period configuration. It's easily extensible to a new teaching period simply by adding a new specification for that period. The key should be valid as a LaTeX macro name (i.e., no spaces, no digits, no punctuation). The components of each period specification are: first_week: The academic week number of the first week of the period. last_week: The academic week number of the last week of the period. break_weeks: A list of breaks that occur during the teaching period. Each is specified by the start (break_start) and end (break_end) week. If a break is only one week long, then break_start and break_end should be equal. If there are no breaks in the teaching period, include a single break specification with both break_start and break_end set to zero. The list should ideally be in ascending order, but the script doesn't assume this and sorts the list anyway. Weeks are numbered by academic week number (i.e., week 1 is the first academic week of the year). The date of the first Monday of the year is stored in $first_monday below (everything is Monday-indexed). Note that academic week is normally the same as absolute calendar week. Example: $year = 2013; $first_monday = new DateTime( "2012-12-31" ); $periods = array( 'SummerSchool' => array( 'first_week' => 2, 'last_week' => 7, 'break_weeks' => array( array( 'break_starts' => 0, 'break_ends' => 0, ), ), ), 'SemesterOne' => array( 'first_week' => 9, 'last_week' => 22, 'break_weeks' => array( array( 'break_starts' => 14, 'break_ends' => 14, ), ), ), 'SemesterTwo' => array( 'first_week' => 28, 'last_week' => 41, 'break_weeks' => array( array( 'break_starts' => 35, 'break_ends' => 35, ), ), ), 'FullYear' => array( 'first_week' => 9, 'last_week' => 41, 'break_weeks' => array( array( 'break_starts' => 23, 'break_ends' => 27, ), array( 'break_starts' => 15, 'break_ends' => 15, ), array( 'break_starts' => 35, 'break_ends' => 35, ), ), ), ); / require 'calendar_config.php'; // A couple of handy date intervals: four days to the end of the current week, // and seven days to the start of next week. $plus_four_days = new DateInterval( 'P4D' ); $plus_seven_days = new DateInterval( 'P7D' ); $numwords = new Numbers_Words(); printf( "%% Teaching calendar dates for %s.\n", $year ); foreach ( $periods as $period_name => $period_data ) { $week_start = clone( $first_monday ); // Jump forward the correct number of weeks to the start of the teaching period. $week_start->add( new DateInterval( sprintf( "P%dD", ( $period_data['first_week'] - 1 ) 7 ) ) ); $week_number = 0; $num_breaks = 0; // Grab the first break week off the front of the list. sort( $period_data['break_weeks'] ); $break_week = array_shift( $period_data['break_weeks'] ); for ( $week = $period_data['first_week']; $week <= $period_data['last_week']; $week++ ) { $week_end = clone( $week_start ); $week_end->add( $plus_four_days ); // Handle break weeks. if ( ( $week >= $break_week['break_starts'] ) && ( $week <= $break_week['break_ends'] ) ) { if ( $week == $break_week['break_starts'] ) { $num_breaks++; // Work out the end date of the break. $break_end = clone( $week_start ); // Note: +4 days to get to Friday. $break_end->add( new DateInterval( sprintf( "P%dD", ( ( $break_week['break_ends'] - $break_week['break_starts'] ) * 7 ) + 4 ) ) ); // Output macro for inclusion in paper calendar. printf( "\\newcommand{\\%sBreak%s}{%s--%s}\n", $period_name, str_replace( "-", "", ucfirst( $numwords->toWords( $num_breaks ) ) ), // If the week start and end dates are in the same month, we only // need to output the month name once. ( $week_start->format( 'n' ) == $break_end->format( 'n' ) ) ? $week_start->format( 'j' ) : $week_start->format( 'j M' ), $break_end->format( 'j M' ) ); } // if current week == first week of break if ( $week == $break_week['break_ends'] ) { // Grab the next break week off the front of the list. $break_week = array_shift( $period_data['break_weeks'] ); } // if current week == last week of break } // if current week is a break week else { $week_number++; // If the week start and end dates are in the same month, we only // need to output the month name once. if ( $week_start->format( 'n' ) == $week_end->format( 'n' ) ) { // Output macro for inclusion in paper calendar. printf( "\\newcommand{\\%sWeek%s}{%s--%s \\\\ %s}\n", $period_name, str_replace( "-", "", ucfirst( $numwords->toWords( $week_number ) ) ), $week_start->format( 'j' ), $week_end->format( 'j' ), $week_end->format( 'M' ) ); } // if same month else { // Output macro for inclusion in paper calendar. printf( "\\newcommand{\\%sWeek%s}{%s \\\\ --%s}\n", $period_name, str_replace( "-", "", ucfirst( $numwords->toWords( $week_number ) ) ), $week_start->format( 'j M' ), $week_end->format( 'j M' ) ); } // else different months } // else normal teaching week $week_start->add( $plus_seven_days ); } // for each week } // foreach teaching period ?>

Ignore Space Show notes View

calendar/generate_calendar.php

<?php

/*
    This script generates a LaTeX include file that contains macros specifying
    the date ranges for every week of the three main teaching periods through
    the year (i.e., summer school, first semester, second semester). Simply set
    the configuration as outlined below and run the script, saving the output
    in a suitable location, ideally only once for all papers. A good spot would
    be somewhere in the TeX search path.
*/

// LaTeX macro names can't include numbers, so we have to convert them to words.
require 'Numbers/Words.php';

/*
    Teaching period configuration. It's easily extensible to a new teaching
    period simply by adding a new specification for that period. The key should
    be valid as a LaTeX macro name (i.e., no spaces, no digits, no punctuation).
    The components of each period specification are:
    
	first_week:		The academic week number of the first week of the period.
		
	last_week:		The academic week number of the last week of the period.
		
    break_weeks:    A list of breaks that occur during the teaching period.
                    Each is specified by the start (break_start) and end
                    (break_end) week. If a break is only one week long, then
                    break_start and break_end should be equal. If there are no
                    breaks in the teaching period, include a single break
                    specification with both break_start and break_end set to zero.
                    
                    The list should ideally be in ascending order, but the
                    script doesn't assume this and sorts the list anyway. Weeks
                    are numbered by academic week number (i.e., week 1 is the
                    first academic week of the year). The date of the first
                    Monday of the year is stored in $first_monday below
                    (everything is Monday-indexed). Note that academic week is
                    normally the same as absolute calendar week.

Example:
    
    $periods = array(
        'SummerSchool' => array(
            'first_week'  => 2,
            'last_week'   => 7,
            'break_weeks' => array(
                array(
                    'break_starts' => 0,
                    'break_ends'  => 0,
                ),
            ),
        ),
        'SemesterOne' => array(
            'first_week'  => 9,
            'last_week'   => 22,
            'break_weeks' => array(
                array(
                    'break_starts' => 14,
                    'break_ends'  => 14,
                ),
            ),
        ),
        'SemesterTwo' => array(
            'first_week'  => 28,
            'last_week'   => 41,
            'break_weeks' => array(
                array(
                    'break_starts' => 35,
                    'break_ends'  => 35,
                ),
            ),
        ),
        'FullYear' => array(
            'first_week'  => 9,
            'last_week'   => 41,
            'break_weeks' => array(
                array(
                    'break_starts' => 23,
                    'break_ends'  => 27,
                ),
                array(
                    'break_starts' => 15,
                    'break_ends'  => 15,
                ),
                array(
                    'break_starts' => 35,
                    'break_ends'  => 35,
                ),
            ),
        ),
    );
*/
require 'calendar_config.php';

// Get first Monday of week 1 according to ISO 8601.
$year = date("Y");
$first_monday = new DateTime();
$first_monday->setISODate($year, 1);

// A couple of handy date intervals: four days to the end of the current week,
// and seven days to the start of next week.
$plus_four_days = new DateInterval( 'P4D' );
$plus_seven_days = new DateInterval( 'P7D' );

$numwords = new Numbers_Words();

printf( "%% Teaching calendar dates for %s.\n", $year );

foreach ( $periods as $period_name => $period_data )
{
    $week_start = clone( $first_monday );
    // Jump forward the correct number of weeks to the start of the teaching period.
    $week_start->add( new DateInterval( sprintf( "P%dD", ( $period_data['first_week'] - 1 ) * 7 ) ) );
    
    $week_number = 0;
    $num_breaks = 0;
    
    // Grab the first break week off the front of the list.
    sort( $period_data['break_weeks'] );
    $break_week = array_shift( $period_data['break_weeks'] );
    
    for ( $week = $period_data['first_week']; $week <= $period_data['last_week']; $week++ )
    {
        $week_end = clone( $week_start );
        $week_end->add( $plus_four_days );
        
        // Handle break weeks.
        if ( ( $week >= $break_week['break_starts'] ) && ( $week <= $break_week['break_ends'] ) )
        {
            if ( $week == $break_week['break_starts'] )
            {
                $num_breaks++;
                
                // Work out the end date of the break.
                $break_end = clone( $week_start );
                // Note: +4 days to get to Friday.
                $break_end->add(
                    new DateInterval(
                        sprintf( "P%dD",  ( ( $break_week['break_ends'] - $break_week['break_starts'] ) * 7 ) + 4 )
                    )
                );
                
                // Output macro for inclusion in paper calendar.
                printf( "\\newcommand{\\%sBreak%s}{%s--%s}\n",
                    $period_name,
                    str_replace( "-", "", ucfirst( $numwords->toWords( $num_breaks ) ) ),
                    // If the week start and end dates are in the same month, we only
                    // need to output the month name once.
                    ( $week_start->format( 'n' ) == $break_end->format( 'n' ) ) ? $week_start->format( 'j' ) : $week_start->format( 'j M' ),
                    $break_end->format( 'j M' )
                );
            } // if current week == first week of break
            
            if ( $week == $break_week['break_ends'] )
            {
                // Grab the next break week off the front of the list.
                $break_week = array_shift( $period_data['break_weeks'] );
            } // if current week == last week of break
        } // if current week is a break week
        else
        {
            $week_number++;
            
            // If the week start and end dates are in the same month, we only
            // need to output the month name once.
            if ( $week_start->format( 'n' ) == $week_end->format( 'n' ) )
            {
                // Output macro for inclusion in paper calendar.
                printf( "\\newcommand{\\%sWeek%s}{%s--%s \\\\ %s}\n",
                    $period_name,
                    str_replace( "-", "", ucfirst( $numwords->toWords( $week_number ) ) ),
                    $week_start->format( 'j' ),
                    $week_end->format( 'j' ),
                    $week_end->format( 'M' )
                );
            } // if same month
            else
            {
                // Output macro for inclusion in paper calendar.
                printf( "\\newcommand{\\%sWeek%s}{%s \\\\ --%s}\n",
                    $period_name,
                    str_replace( "-", "", ucfirst( $numwords->toWords( $week_number ) ) ),
                    $week_start->format( 'j M' ),
                    $week_end->format( 'j M' )
                );
            } // else different months
        } // else normal teaching week
        
        $week_start->add( $plus_seven_days );
    } // for each week
} // foreach teaching period

<?php

// LaTeX macro names can't include numbers, so we have to convert them to words.
require 'Numbers/Words.php';

Example:
    
    $year = 2013;
    
    $first_monday = new DateTime( "2012-12-31" );
    
    $periods = array(
        'SummerSchool' => array(
            'first_week'  => 2,
            'last_week'   => 7,
            'break_weeks' => array(
                array(
                    'break_starts' => 0,
                    'break_ends'  => 0,
                ),
            ),
        ),
        'SemesterOne' => array(
            'first_week'  => 9,
            'last_week'   => 22,
            'break_weeks' => array(
                array(
                    'break_starts' => 14,
                    'break_ends'  => 14,
                ),
            ),
        ),
        'SemesterTwo' => array(
            'first_week'  => 28,
            'last_week'   => 41,
            'break_weeks' => array(
                array(
                    'break_starts' => 35,
                    'break_ends'  => 35,
                ),
            ),
        ),
        'FullYear' => array(
            'first_week'  => 9,
            'last_week'   => 41,
            'break_weeks' => array(
                array(
                    'break_starts' => 23,
                    'break_ends'  => 27,
                ),
                array(
                    'break_starts' => 15,
                    'break_ends'  => 15,
                ),
                array(
                    'break_starts' => 35,
                    'break_ends'  => 35,
                ),
            ),
        ),
    );
*/
require 'calendar_config.php';

$numwords = new Numbers_Words();

printf( "%% Teaching calendar dates for %s.\n", $year );

Ignore Space Show notes View calendar/generate_lecturedates.php
<?php /* This script generates a LaTeX include file that contains macros for generating the dates for every lecture in a teaching period. It doesn't generate dates for multiple papers; rather, you should generate a separate include file for each paper individually. The main reason for this approach is that each paper will have different lecture offsets in a week, and possibly also a different number of lectures each week. It's easier to keep track of this in paper- specific files rather than a single file for all papers. The configuration for a specific paper is read from a separate file. The output of the script should be placed at the root of the tree for the target paper, alongside the paper_init.tex file. / // LaTeX macro names can't include numbers, so we have to convert them to words. require 'Numbers/Words.php'; / Configuration requires the following variables to be specified in the file lecturedates_config.php: $period_config An array whose key is the teaching period code (e.g., "SS", "S1", "S2", "FY"). Each element is an array comprising the following sub-elements: "start_dates" A list of starting dates for contiguous teaching weeks, e.g., the six weeks up to mid-semester break, and the seven weeks after. We pretty much ignore breaks, etc., otherwise; all we want to know is what the date(s) are for the lecture(s) in each week. It also means that we don't have to do anything clever for things like full year papers that span more than one semester. The variable $year (defined to be current year below) can be used here. "period_lengths" A list of integers representing the length in weeks of each period specifed in $start_dates. Both the "start_dates" and "period_lengths" elements must therefore have the same length! Example (full year with one break in each semester): "full year" => array( "start_dates" => array( new DateTime( "{$year}-02-27" ), new DateTime( "{$year}-04-24" ), new DateTime( "{$year}-07-10" ), new DateTime( "{$year}-09-04" ), ), "period_lengths" => array(7, 6, 7, 6), ), $paper_config An array whose key is the paper code (e.g., "INFO214"). Each element is an array comprising the following sub-elements: "class_offsets" For each class in a week, specify the offset interval from the start of week (Monday). Thus, a class on Monday will be 'P0D', Wednesday 'P2D', Friday 'P4D', etc. Include as many entries in the list as there are classes per week (e.g., two lectures => two entries). Example (INFO 408 2017, one lecture per week, on Wednesday): "class_offsets" => array( new DateInterval( 'P2D' ), ); A complete example: $period_config = array( ... "FY" => array( "start_dates" => array( new DateTime( "{$year}-02-27" ), new DateTime( "{$year}-04-24" ), new DateTime( "{$year}-07-10" ), new DateTime( "{$year}-09-04" ), ), "period_lengths" => array(7, 6, 7, 6), ), ); $paper_config = array( "COMP101" => array( "class_offsets" = array( new DateInterval( 'P0D' ), new DateInterval( 'P2D' ), ), ), ... ); / $year = date("Y"); require 'lecturedates_config.php'; // Process command line arguments. // This only accepts paper codes in the usual form XXXX999, and will fail for // unusual papers like "INFO5H". However, it's extremely unlikely that such // papers will ever need to use this script. ($argc == 3 && preg_match('/[A-Z]{4}\d{3}/', $argv[1]) && preg_match('/S[S12]\|FY/', $argv[2])) or die("Usage: php generate_lecturedates.php paper_code period_code\n"); $paper_code = $argv[1]; $period_code = $argv[2]; // A handy date interval: seven days to the start of next week. $plus_seven_days = new DateInterval('P7D'); $week_num = 1; printf( "%% Lecture dates for %s %s %s.\n", $paper_code, $period_code, $year ); $period_settings = $period_config[$period_code]; $paper_settings = $paper_config[$paper_code]; print <<<EOT \\newcount\\lecnum \\newcount\\weeknum \\newcommand{\\LectureDate}[1]{% \\lecnum #1\\relax% \\advance\\lecnum by -1\\relax% \\ifcase\\lecnum EOT; $first_lecture = true; foreach ($period_settings['start_dates'] as $period => $period_start) { $week_start = clone($period_start); for ($w = 0; $w < $period_settings['period_lengths'][$period]; $w++) { $lecture_num = 1; foreach ($paper_settings["class_offsets"] as $offset) { $class_date = clone($week_start); $class_date->add($offset); if ($first_lecture) { $first_lecture = false; } else { print " \\or "; } printf("%s%%\n", $class_date->format('j F')); $lecture_num++; } // for every class in week $week_start->add($plus_seven_days); $week_num++; } // for every week in period } // for every period print <<<EOT \\else ????% \\fi% } \\newcommand{\\LectureDateByWeek}[2]{% \\weeknum #1\\relax% \\advance\\weeknum by -1\\relax% \\multiply\\weeknum by 2\\relax% \\advance\\weeknum by #2\\relax% \\LectureDate{\\the\\weeknum}% } EOT; <?php / This script generates a LaTeX include file that contains macros for generating the dates for every lecture in a teaching period. It doesn't generate dates for multiple papers; rather, you should generate a separate include file for each paper individually. The main reason for this approach is that each paper will have different lecture offsets in a week, and possibly also a different number of lectures each week. It's easier to keep track of this in paper- specific files rather than a single file for all papers. The configuration for a specific paper is read from a separate file. The output of the script should be placed at the root of the tree for the target paper, alongside the paper_init.tex file. / // LaTeX macro names can't include numbers, so we have to convert them to words. require 'Numbers/Words.php'; / Configuration requires the following variables to be specified in the file lecturedates_config.php: $year The year for which dates are being generated. This can be used elswhere in the configuration. $period_config An array whose key is the teaching period code (e.g., "SS", "S1", "S2", "FY"). Each element is an array comprising the following sub-elements: "start_dates" A list of starting dates for contiguous teaching weeks, e.g., the six weeks up to mid-semester break, and the seven weeks after. We pretty much ignore breaks, etc., otherwise; all we want to know is what the date(s) are for the lecture(s) in each week. It also means that we don't have to do anything clever for things like full year papers that span more than one semester. "period_lengths" A list of integers representing the length in weeks of each period specifed in $start_dates. Both the "start_dates" and "period_lengths" elements must therefore have the same length! Example (full year with one break in each semester): "full year" => array( "start_dates" => array( new DateTime( "{$year}-02-27" ), new DateTime( "{$year}-04-24" ), new DateTime( "{$year}-07-10" ), new DateTime( "{$year}-09-04" ), ), "period_lengths" => array(7, 6, 7, 6), ), $paper_config An array whose key is the paper code (e.g., "INFO214"). Each element is an array comprising the following sub-elements: "class_offsets" For each class in a week, specify the offset interval from the start of week (Monday). Thus, a class on Monday will be 'P0D', Wednesday 'P2D', Friday 'P4D', etc. Include as many entries in the list as there are classes per week (e.g., two lectures => two entries). Example (INFO 408 2017, one lecture per week, on Wednesday): "class_offsets" => array( new DateInterval( 'P2D' ), ); A complete example: $year = 2017; $period_config = array( ... "FY" => array( "start_dates" => array( new DateTime( "{$year}-02-27" ), new DateTime( "{$year}-04-24" ), new DateTime( "{$year}-07-10" ), new DateTime( "{$year}-09-04" ), ), "period_lengths" => array(7, 6, 7, 6), ), ); $paper_config = array( "COMP101" => array( "class_offsets" = array( new DateInterval( 'P0D' ), new DateInterval( 'P2D' ), ), ), ... ); */ require 'lecturedates_config.php'; // Process command line arguments. // This only accepts paper codes in the usual form XXXX999, and will fail for // unusual papers like "INFO5H". However, it's extremely unlikely that such // papers will ever need to use this script. ($argc == 3 && preg_match('/[A-Z]{4}\d{3}/', $argv[1]) && preg_match('/S[S12]\|FY/', $argv[2])) or die("Usage: php generate_lecturedates.php paper_code period_code\n"); $paper_code = $argv[1]; $period_code = $argv[2]; // A handy date interval: seven days to the start of next week. $plus_seven_days = new DateInterval('P7D'); $week_num = 1; printf( "%% Lecture dates for %s %s %s.\n", $paper_code, $period_code, $year ); $period_settings = $period_config[$period_code]; $paper_settings = $paper_config[$paper_code]; print <<<EOT \\newcount\\lecnum \\newcount\\weeknum \\newcommand{\\LectureDate}[1]{% \\lecnum #1\\relax% \\advance\\lecnum by -1\\relax% \\ifcase\\lecnum EOT; $first_lecture = true; foreach ($period_settings['start_dates'] as $period => $period_start) { $week_start = clone($period_start); for ($w = 0; $w < $period_settings['period_lengths'][$period]; $w++) { $lecture_num = 1; foreach ($paper_settings["class_offsets"] as $offset) { $class_date = clone($week_start); $class_date->add($offset); if ($first_lecture) { $first_lecture = false; } else { print " \\or "; } printf("%s%%\n", $class_date->format('j F')); $lecture_num++; } // for every class in week $week_start->add($plus_seven_days); $week_num++; } // for every week in period } // for every period print <<<EOT \\else ????% \\fi% } \\newcommand{\\LectureDateByWeek}[2]{% \\weeknum #1\\relax% \\advance\\weeknum by -1\\relax% \\multiply\\weeknum by 2\\relax% \\advance\\weeknum by #2\\relax% \\LectureDate{\\the\\weeknum}% } EOT;

Ignore Space Show notes View

calendar/generate_lecturedates.php

<?php

/*
    This script generates a LaTeX include file that contains macros for generating
    the dates for every lecture in a teaching period. It doesn't generate dates
    for multiple papers; rather, you should generate a separate include file for
    each paper individually. The main reason for this approach is that each paper
    will have different lecture offsets in a week, and possibly also a different
    number of lectures each week. It's easier to keep track of this in paper-
    specific files rather than a single file for all papers. The configuration
    for a specific paper is read from a separate file.
    
    The output of the script should be placed at the root of the tree for the
    target paper, alongside the paper_init.tex file.
*/

// LaTeX macro names can't include numbers, so we have to convert them to words.
require 'Numbers/Words.php';

/*
    Configuration requires the following variables to be specified in the file
    lecturedates_config.php:
    
    $period_config
        An array whose key is the teaching period code (e.g., "SS", "S1", "S2",
        "FY"). Each element is an array comprising the following sub-elements:
        
        "start_dates"
        A list of starting dates for contiguous teaching weeks, e.g., the six
        weeks up to mid-semester break, and the seven weeks after. We pretty
        much ignore breaks, etc., otherwise; all we want to know is what the
        date(s) are for the lecture(s) in each week. It also means that we
        don't have to do anything clever for things like full year papers that
        span more than one semester. The variable $year (defined to be current
        year below) can be used here.
        
        "period_lengths"
        A list of integers representing the length in weeks of each period
        specifed in $start_dates. Both the "start_dates" and "period_lengths"
        elements must therefore have the same length!
        
        Example (full year with one break in each semester):
        
            "full year" => array(
                "start_dates" => array(
                    new DateTime( "{$year}-02-27" ),
                    new DateTime( "{$year}-04-24" ),
                    new DateTime( "{$year}-07-10" ),
                    new DateTime( "{$year}-09-04" ),
                ),
                "period_lengths" => array(7, 6, 7, 6),
            ),
       
    $paper_config
        An array whose key is the paper code (e.g., "INFO214"). Each element
        is an array comprising the following sub-elements:
    
        "class_offsets"
        For each class in a week, specify the offset interval from the start
        of week (Monday). Thus, a class on Monday will be 'P0D', Wednesday
        'P2D', Friday 'P4D', etc. Include as many entries in the list as there
        are classes per week (e.g., two lectures => two entries).
        
        Example (INFO 408 2017, one lecture per week, on Wednesday):
        
            "class_offsets" => array(
                new DateInterval( 'P2D' ),
            );
    
    A complete example:
    
    $period_config = array(
        ...
        "FY" => array(
            "start_dates" => array(
                new DateTime( "{$year}-02-27" ),
                new DateTime( "{$year}-04-24" ),
                new DateTime( "{$year}-07-10" ),
                new DateTime( "{$year}-09-04" ),
            ),
            "period_lengths" => array(7, 6, 7, 6),
        ),
    );

$paper_config = array(
        "COMP101" => array(
            "class_offsets" = array(
                new DateInterval( 'P0D' ),
                new DateInterval( 'P2D' ),
            ),
        ),
        ...
    );
*/
$year = date("Y");

require 'lecturedates_config.php';

// Process command line arguments.
// This only accepts paper codes in the usual form XXXX999, and will fail for
// unusual papers like "INFO5H". However, it's extremely unlikely that such
// papers will ever need to use this script.
($argc == 3 && preg_match('/[A-Z]{4}\d{3}/', $argv[1]) && preg_match('/S[S12]|FY/', $argv[2]))
    or die("Usage: php generate_lecturedates.php paper_code period_code\n");

$paper_code = $argv[1];
$period_code = $argv[2];

// A handy date interval: seven days to the start of next week.
$plus_seven_days = new DateInterval('P7D');

$week_num = 1;

printf( "%% Lecture dates for %s %s %s.\n", $paper_code, $period_code, $year );

$period_settings = $period_config[$period_code];
$paper_settings = $paper_config[$paper_code];

print <<<EOT
\\newcount\\lecnum
\\newcount\\weeknum

\\newcommand{\\LectureDate}[1]{%
    \\lecnum #1\\relax%
    \\advance\\lecnum by -1\\relax%
    \\ifcase\\lecnum 
EOT;

$first_lecture = true;

foreach ($period_settings['start_dates'] as $period => $period_start)
{
    $week_start = clone($period_start);
    
    for ($w = 0; $w < $period_settings['period_lengths'][$period]; $w++)
    {
        $lecture_num = 1;
        
        foreach ($paper_settings["class_offsets"] as $offset)
        {
            $class_date = clone($week_start);
            $class_date->add($offset);
            
            if ($first_lecture) {
                $first_lecture = false;
            }
            else {
                print "        \\or ";
            }
            printf("%s%%\n", $class_date->format('j F'));
            $lecture_num++;
        } // for every class in week
        
        $week_start->add($plus_seven_days);
        $week_num++;
    } // for every week in period
} // for every period

print <<<EOT
        \\else ????%
    \\fi%
}

\\newcommand{\\LectureDateByWeek}[2]{%
    \\weeknum #1\\relax%
    \\advance\\weeknum by -1\\relax%
    \\multiply\\weeknum by 2\\relax%
    \\advance\\weeknum by #2\\relax%
    \\LectureDate{\\the\\weeknum}%
}

EOT;

<?php

// LaTeX macro names can't include numbers, so we have to convert them to words.
require 'Numbers/Words.php';

/*
    Configuration requires the following variables to be specified in the file
    lecturedates_config.php:
    
    $year
        The year for which dates are being generated. This can be used elswhere
        in the configuration.
    
    $period_config
        An array whose key is the teaching period code (e.g., "SS", "S1", "S2",
        "FY"). Each element is an array comprising the following sub-elements:
        
        "start_dates"
        A list of starting dates for contiguous teaching weeks, e.g., the six
        weeks up to mid-semester break, and the seven weeks after. We pretty
        much ignore breaks, etc., otherwise; all we want to know is what the
        date(s) are for the lecture(s) in each week. It also means that we
        don't have to do anything clever for things like full year papers that
        span more than one semester.
        
        "period_lengths"
        A list of integers representing the length in weeks of each period
        specifed in $start_dates. Both the "start_dates" and "period_lengths"
        elements must therefore have the same length!
        
        Example (full year with one break in each semester):
        
            "full year" => array(
                "start_dates" => array(
                    new DateTime( "{$year}-02-27" ),
                    new DateTime( "{$year}-04-24" ),
                    new DateTime( "{$year}-07-10" ),
                    new DateTime( "{$year}-09-04" ),
                ),
                "period_lengths" => array(7, 6, 7, 6),
            ),
       
    $paper_config
        An array whose key is the paper code (e.g., "INFO214"). Each element
        is an array comprising the following sub-elements:
    
        "class_offsets"
        For each class in a week, specify the offset interval from the start
        of week (Monday). Thus, a class on Monday will be 'P0D', Wednesday
        'P2D', Friday 'P4D', etc. Include as many entries in the list as there
        are classes per week (e.g., two lectures => two entries).
        
        Example (INFO 408 2017, one lecture per week, on Wednesday):
        
            "class_offsets" => array(
                new DateInterval( 'P2D' ),
            );
    
    A complete example:
    
    $year = 2017;

$period_config = array(
        ...
        "FY" => array(
            "start_dates" => array(
                new DateTime( "{$year}-02-27" ),
                new DateTime( "{$year}-04-24" ),
                new DateTime( "{$year}-07-10" ),
                new DateTime( "{$year}-09-04" ),
            ),
            "period_lengths" => array(7, 6, 7, 6),
        ),
    );

$paper_config = array(
        "COMP101" => array(
            "class_offsets" = array(
                new DateInterval( 'P0D' ),
                new DateInterval( 'P2D' ),
            ),
        ),
        ...
    );
*/
require 'lecturedates_config.php';

$paper_code = $argv[1];
$period_code = $argv[2];

// A handy date interval: seven days to the start of next week.
$plus_seven_days = new DateInterval('P7D');

$week_num = 1;

printf( "%% Lecture dates for %s %s %s.\n", $paper_code, $period_code, $year );

$period_settings = $period_config[$period_code];
$paper_settings = $paper_config[$paper_code];

print <<<EOT
\\newcount\\lecnum
\\newcount\\weeknum

\\newcommand{\\LectureDate}[1]{%
    \\lecnum #1\\relax%
    \\advance\\lecnum by -1\\relax%
    \\ifcase\\lecnum 
EOT;

$first_lecture = true;

print <<<EOT
        \\else ????%
    \\fi%
}

EOT;

Show line notes below