Browse code Removed now obsolete CVS substitutions. master
1 parent 15ac25b commit 3917273bdd5389dac8b0514d8acf26c52fd14597 Nigel Stanger authored on 13 Jun 2013

Showing 28 changed files

• calendar/Makefile
• calendar/generate_calendar.php
• calendar/generate_lecturedates.php
• configuration/Makefile
• configuration/configure.ac
• configuration/include/ac_path_jarfile.m4
• make-includes/build_content_rules.make
• make-includes/build_document_rules.make
• make-includes/build_lecture_rules.make
• make-includes/build_misc_rules.make
• make-includes/build_section_rules.make
• make-includes/local_configuration.make.in
• make-includes/remove_content_marker_files.make
• make-includes/standard_environment.make
• make-includes/standard_paths.make
• make-includes/standard_rules.make
• make-includes/standard_suffixes.make
• make-includes/xslt_functions.make
• makefile-templates/Makefile.content
• makefile-templates/Makefile.document
• makefile-templates/Makefile.handbook
• makefile-templates/Makefile.lecture
• makefile-templates/Makefile.misc
• makefile-templates/Makefile.section
• makefile-templates/answers.patterns
• makefile-templates/install.patterns
• makefile-templates/paper_variables.make
• makefile-templates/questions.patterns

Ignore Space Show notes View calendar/Makefile

SHELL = /bin/sh # Depending on the permissions of your TEXMF directory, you may need to # do a 'sudo make install' # Set this to whatever it should be, e.g., /usr/local/texmf or whatever. # Probably better to install these in your own personal TEXMF tree so that # they don't get wiped out by updates. # TEXMFHOME = LATEX = $(TEXMFHOME)/tex/latex install: @mkdir -p $(LATEX)/local php generate_calendar.php > $(LATEX)/local/calendar_weeks.tex @texhash ################################################################################ # # File: $Id$ # ################################################################################ SHELL = /bin/sh # Depending on the permissions of your TEXMF directory, you may need to # do a 'sudo make install' # Set this to whatever it should be, e.g., /usr/local/texmf or whatever. # Probably better to install these in your own personal TEXMF tree so that # they don't get wiped out by updates. # TEXMFHOME = LATEX = $(TEXMFHOME)/tex/latex install: @mkdir -p $(LATEX)/local php generate_calendar.php > $(LATEX)/local/calendar_weeks.tex @texhash

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. include( "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: start_date: The date of the first day of the first week of the period. num_weeks: The total number of weeks in the period, /including/ any breaks (e.g., 13 teaching weeks plus 1 week mid-semester break = 14 weeks). 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 absolute calendar week number (i.e., week 1 is the first calendar week of the year). The date of the first Monday of the year is stored in $first_monday below (everything is Monday-indexed). */ $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, ), ), ), ); // 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(); 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 /* File: $Id$ 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. include( "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: start_date: The date of the first day of the first week of the period. num_weeks: The total number of weeks in the period, /including/ any breaks (e.g., 13 teaching weeks plus 1 week mid-semester break = 14 weeks). 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 absolute calendar week number (i.e., week 1 is the first calendar week of the year). The date of the first Monday of the year is stored in $first_monday below (everything is Monday-indexed). */ $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, ), ), ), ); // 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(); 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_lecturedates.php

<?php /* This script generates a LaTeX include file that contains macros specifying 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 paper codes include digits, which you can't include in LaTeX macro names. We therefore generate generic macros (\DateLectureOne, \DateLectureTwo, etc.), that don't include any paper information. 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. include( 'Numbers/Words.php' ); /* Configuration requires the following variables to be specified in the file lecturedates_config.php: $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. Example (INFO 405 2012, full year with one break in each semester): $start_dates => array( new DateTime( "2012-02-27" ), new DateTime( "2012-04-02" ), new DateTime( "2012-07-09" ), new DateTime( "2012-09-03" ), ); $period_lengths A list of integers representing the length in weeks of each period specifed in $start_dates. Both $start_dates and $period_lengths must therefore have the same length! Example (INFO 405 2012): $period_lengths => array( 6, 7, 7, 6 ); $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 405 2012, one lecture per week, on Monday): $class_offsets => array( new DateInterval( 'P0D' ), ); */ include( 'lecturedates_config.php' ); $numwords = new Numbers_Words(); // A handy date interval: seven days to the start of next week. $plus_seven_days = new DateInterval( 'P7D' ); $week_num = 1; for ( $period = 0; $period < count( $start_dates ); $period++ ) { $period_start = $start_dates[$period]; $week_start = clone( $start_dates[$period] ); for ( $week = 0; $week < $period_lengths[$period]; $week++ ) { $lecture_num = 1; foreach ( $class_offsets as $class ) { $class_date = clone( $week_start ); $class_date->add( $class ); // Note that the toWords() method generates hyphens in the result, // so we need to strip these out for LaTeX to be happy. Larger // numbers may well include spaces and commas, but it's pretty // unlikely that we'll ever get that high! printf( "\\newcommand{\\DateWeek%sLecture%s}{%s}\n", ucfirst( str_replace( '-', '', $numwords->toWords( $week_num ) ) ), ucfirst( str_replace( '-', '', $numwords->toWords( $lecture_num ) ) ), $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 <?php /* File: $Id$ This script generates a LaTeX include file that contains macros specifying 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 paper codes include digits, which you can't include in LaTeX macro names. We therefore generate generic macros (\DateLectureOne, \DateLectureTwo, etc.), that don't include any paper information. 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. include( 'Numbers/Words.php' ); /* Configuration requires the following variables to be specified in the file lecturedates_config.php: $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. Example (INFO 405 2012, full year with one break in each semester): $start_dates => array( new DateTime( "2012-02-27" ), new DateTime( "2012-04-02" ), new DateTime( "2012-07-09" ), new DateTime( "2012-09-03" ), ); $period_lengths A list of integers representing the length in weeks of each period specifed in $start_dates. Both $start_dates and $period_lengths must therefore have the same length! Example (INFO 405 2012): $period_lengths => array( 6, 7, 7, 6 ); $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 405 2012, one lecture per week, on Monday): $class_offsets => array( new DateInterval( 'P0D' ), ); */ include( 'lecturedates_config.php' ); $numwords = new Numbers_Words(); // A handy date interval: seven days to the start of next week. $plus_seven_days = new DateInterval( 'P7D' ); $week_num = 1; for ( $period = 0; $period < count( $start_dates ); $period++ ) { $period_start = $start_dates[$period]; $week_start = clone( $start_dates[$period] ); for ( $week = 0; $week < $period_lengths[$period]; $week++ ) { $lecture_num = 1; foreach ( $class_offsets as $class ) { $class_date = clone( $week_start ); $class_date->add( $class ); // Note that the toWords() method generates hyphens in the result, // so we need to strip these out for LaTeX to be happy. Larger // numbers may well include spaces and commas, but it's pretty // unlikely that we'll ever get that high! printf( "\\newcommand{\\DateWeek%sLecture%s}{%s}\n", ucfirst( str_replace( '-', '', $numwords->toWords( $week_num ) ) ), ucfirst( str_replace( '-', '', $numwords->toWords( $lecture_num ) ) ), $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

Ignore Space Show notes View configuration/Makefile

################################################################################ # # Makefile to build the handbook configure script and execute it to # produce a local make configuration for the command-line tools used. # ################################################################################ DEPLOY=../make-includes configure: configure.ac install-sh $(wildcard include/*.m4) aclocal -I include autoreconf clean: rm -f aclocal.m4 config.log config.status configure \ $(DEPLOY)/local_configuration.make rm -rf autom4te.cache ################################################################################ # # File: $Id$ # # Makefile to build the handbook configure script and execute it to # produce a local make configuration for the command-line tools used. # ################################################################################ DEPLOY=../make-includes configure: configure.ac install-sh $(wildcard include/*.m4) aclocal -I include autoreconf clean: rm -f aclocal.m4 config.log config.status configure \ $(DEPLOY)/local_configuration.make rm -rf autom4te.cache

Ignore Space Show notes View configuration/configure.ac

dnl dnl Autoconf script for database paper handbooks. It creates a ./configure dnl that sets up the local configuration of tools, so that it's easy to get dnl up and going again quickly should some package suddenly decide to rearange dnl itself and install things in different locations. It also makes things dnl completely independent of whatever package manager we happen to be using. dnl dnl All tools used in the handbook makefiles should be included here, so as dnl to abstract things as much as possible. This includes even "obvious" things dnl like cp, mv, etc., and also any required environment variables. dnl AC_PREREQ([2.61]) AC_INIT([INFO Database Handbook], [2.0]) dnl dnl Files to be generated. Currently this is only make include file containing dnl the list of tools used. We could use autoconf to just insert these directly dnl into each of the files in ../make-includes and ../makefile-templates, as dnl appropriate, but it seems to make more sense to define them all in one dnl place. This will make it easier to reuse them in other (especially dnl non-handbook) contexts. dnl AC_CONFIG_FILES([../make-includes/local_configuration.make]) dnl dnl Check required environment variables. Note that we don't error out if any dnl aren't defined, as the makefiles will warn about this anyway. It's really dnl just more for completeness than anything that they're included here. dnl AC_MSG_NOTICE([checking handbook environment]) AC_ARG_VAR(TEACHING_SHARED, [the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)]) AC_ARG_VAR(ALL_PAPERS_ROOT, [the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)]) AC_ARG_VAR(HANDBOOK_INSTALL_ROOT, [the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)]) AC_ARG_VAR(XSLT, [default XSLT processor (in order of preference: "saxon-b", "saxon", "xalan-j", "xalan-c")]) AC_CHECK_ENVVAR([TEACHING_SHARED]) AC_CHECK_ENVVAR([ALL_PAPERS_ROOT]) AC_CHECK_ENVVAR([HANDBOOK_INSTALL_ROOT]) dnl This one is required for configuration, so handle separately. AC_MSG_CHECKING([variable XSLT]) AS_IF([test -z $XSLT], [ AC_MSG_RESULT([no]) AC_MSG_ERROR([required environment variable XSLT not defined])], [AC_MSG_RESULT([$XSLT])]) dnl dnl Check required tools. dnl AC_MSG_NOTICE([checking for required tools]) dnl dnl File system. dnl AC_PROG_MKDIR_P AC_PATH_PROG(MV, mv) AC_PATH_PROG(CP, cp) AC_PATH_PROG(RM, rm) AC_PATH_PROG(TOUCH, touch) AC_PROG_LN_S dnl dnl Searching. dnl AC_PROG_GREP dnl We need GNU find as we use some of its specific command-line switches. AC_CACHE_CHECK([for GNU find], [ac_cv_path_FIND], [AC_PATH_PROGS_FEATURE_CHECK([FIND], [gnufind gfind find], [AS_IF([( sh -c "$ac_path_FIND --version" 2> /dev/null | grep GNU 2>&1 > /dev/null )], [ ac_cv_path_FIND=$ac_path_FIND ac_path_FIND_found=:], [])], [AC_MSG_ERROR([could not find GNU find (irony)])])]) AC_SUBST([FIND], [$ac_cv_path_FIND]) dnl dnl Tests. dnl AC_PATH_PROG(TEST_PROGRAM, test) AC_PATH_PROG(TRUE, true) AC_PATH_PROG(FALSE, false) dnl dnl Output. dnl AC_PATH_PROG(ECHO, echo) AC_PATH_PROG(CAT, cat) AC_PATH_PROG(ANNOUNCE, announce) dnl dnl Miscellaneous utilities. dnl AC_PROG_SED AC_PATH_PROG(CUT, cut) AC_PROG_PERL_VERSION(5.6.0) AC_PATH_PROG(DATE, date) AC_PATH_PROG(EXPR, expr) AC_PATH_PROG(BASENAME, basename) dnl Java stuff. AC_PROG_JAVA dnl AC_CHECK_CLASS([org.apache.xml.resolver.apps.resolver]) dnl AC_CHECK_CLASS([net.sf.saxon.Transform]) dnl We make heavy use of features specific to GNU make. AC_CACHE_CHECK([for GNU make], [ac_cv_path_MAKE], [AC_PATH_PROGS_FEATURE_CHECK([MAKE], [gnumake gmake make], [AS_IF([( sh -c "$ac_path_MAKE --version" 2> /dev/null | grep GNU 2>&1 > /dev/null )], [ ac_cv_path_MAKE=$ac_path_MAKE ac_path_MAKE_found=:], [])], [AC_MSG_ERROR([could not find GNU make])])]) AC_SUBST([MAKE], [$ac_cv_path_MAKE]) dnl dnl LaTeX and friends. dnl AC_PROG_LATEX AC_PROG_PDFLATEX AC_PROG_XELATEX AC_PROG_DVIPS dnl dnl XML manipulation. dnl AC_PATH_PROG(XMLLINT, xmllint) dnl Use a different variable for the XSLT processor path to keep it distinct dnl from the XSLT environment variable, which serves a slightly different dnl purpose. However, we use the value derived from $XSLT above to seed the dnl executable name. # Figure out the appropriate name of the executable based on $XSLT. AS_CASE([$XSLT], [xalan-c], [AC_PATH_PROG(XSLTPROC, [Xalan])], [xalan-j], [AC_PATH_PROG(XSLTPROC, [xalan])], [saxon-b], [ AC_PATH_JARFILE([saxon9], [SAXON], [/opt/local/share/java /sw/share/java /usr/local/share/java /usr/share/java /opt/local/lib/java /sw/lib/java /usr/local/lib/java /usr/lib/java ${HOME}/Library/Java /Library/Java /System/Library/Java]) AC_MSG_CHECKING([for Saxon-B]) AS_IF([$SAXON_AVAILABLE], [AC_SUBST([XSLTPROC], ["${JAVA} -jar ${SAXON_JAR}"]) AC_MSG_RESULT([$XSLTPROC])], [ AC_MSG_RESULT([no]) AC_MSG_ERROR([could not find Saxon-B])])], [AC_MSG_ERROR([unknown XSLT processor "${XSLT}" specified])]) AC_PATH_JARFILE(resolver, RESOLVER, [/opt/local/share/java /sw/share/java /usr/local/share/java /usr/share/java /opt/local/lib/java /sw/lib/java /usr/local/lib/java /usr/lib/java ${HOME}/Library/Java /Library/Java /System/Library/Java]) AC_MSG_CHECKING([for XML entity resolver]) # We can't use -jar for the entity resolver, because it needs to be able # to use the CLASSPATH to find the CatalogManager.properties file. Using # -jar suppresses the CLASSPATH completely. AS_IF([$RESOLVER_AVAILABLE], [ AC_SUBST([RESOLVER], ["${JAVA} -cp ${RESOLVER_JAR}:${CLASSPATH} org.apache.xml.resolver.apps.resolver"]) AC_MSG_RESULT([$RESOLVER])], [ AC_MSG_RESULT([no]) AC_MSG_ERROR([could not find the XML entity resolver])]) dnl dnl Image manipulation and conversion (includes PDF & PS). dnl AC_PATH_PROG(CONVERT, convert) AC_PATH_PROG(COMPOSITE, composite) AC_PATH_PROG(PDFNUP, pdfnup) AC_PATH_PROG(PDFCROP, pdfcrop) AC_PATH_PROG(PS2EPS, ps2eps) AC_PATH_PROG(PS2PDF, ps2pdf) AC_PATH_PROG(SHIFTBBOX, shiftbbox) AC_PATH_PROG(EPSTOPDF, epstopdf) AC_PATH_PROG(INKSCAPE, inkscape) AC_PATH_PROG(GS, gs) AC_PATH_PROG(XCF2PNG, xcf2png) dnl dnl Plotting tools. dnl AC_PATH_PROG(PLOTICUS, ploticus) AC_PATH_PROG(R, R) dnl dnl Web site synchronisation. dnl AC_PATH_PROG(SITECOPY, sitecopy) dnl dnl CSS development. dnl AC_PATH_PROG(SASS, sass) AC_OUTPUT dnl dnl $Id$ dnl dnl Autoconf script for database paper handbooks. It creates a ./configure dnl that sets up the local configuration of tools, so that it's easy to get dnl up and going again quickly should some package suddenly decide to rearange dnl itself and install things in different locations. It also makes things dnl completely independent of whatever package manager we happen to be using. dnl dnl All tools used in the handbook makefiles should be included here, so as dnl to abstract things as much as possible. This includes even "obvious" things dnl like cp, mv, etc., and also any required environment variables. dnl AC_PREREQ([2.61]) AC_INIT([INFO Database Handbook], [2.0]) dnl dnl Files to be generated. Currently this is only make include file containing dnl the list of tools used. We could use autoconf to just insert these directly dnl into each of the files in ../make-includes and ../makefile-templates, as dnl appropriate, but it seems to make more sense to define them all in one dnl place. This will make it easier to reuse them in other (especially dnl non-handbook) contexts. dnl AC_CONFIG_FILES([../make-includes/local_configuration.make]) dnl dnl Check required environment variables. Note that we don't error out if any dnl aren't defined, as the makefiles will warn about this anyway. It's really dnl just more for completeness than anything that they're included here. dnl AC_MSG_NOTICE([checking handbook environment]) AC_ARG_VAR(TEACHING_SHARED, [the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)]) AC_ARG_VAR(ALL_PAPERS_ROOT, [the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)]) AC_ARG_VAR(HANDBOOK_INSTALL_ROOT, [the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)]) AC_ARG_VAR(XSLT, [default XSLT processor (in order of preference: "saxon-b", "saxon", "xalan-j", "xalan-c")]) AC_CHECK_ENVVAR([TEACHING_SHARED]) AC_CHECK_ENVVAR([ALL_PAPERS_ROOT]) AC_CHECK_ENVVAR([HANDBOOK_INSTALL_ROOT]) dnl This one is required for configuration, so handle separately. AC_MSG_CHECKING([variable XSLT]) AS_IF([test -z $XSLT], [ AC_MSG_RESULT([no]) AC_MSG_ERROR([required environment variable XSLT not defined])], [AC_MSG_RESULT([$XSLT])]) dnl dnl Check required tools. dnl AC_MSG_NOTICE([checking for required tools]) dnl dnl File system. dnl AC_PROG_MKDIR_P AC_PATH_PROG(MV, mv) AC_PATH_PROG(CP, cp) AC_PATH_PROG(RM, rm) AC_PATH_PROG(TOUCH, touch) AC_PROG_LN_S dnl dnl Searching. dnl AC_PROG_GREP dnl We need GNU find as we use some of its specific command-line switches. AC_CACHE_CHECK([for GNU find], [ac_cv_path_FIND], [AC_PATH_PROGS_FEATURE_CHECK([FIND], [gnufind gfind find], [AS_IF([( sh -c "$ac_path_FIND --version" 2> /dev/null | grep GNU 2>&1 > /dev/null )], [ ac_cv_path_FIND=$ac_path_FIND ac_path_FIND_found=:], [])], [AC_MSG_ERROR([could not find GNU find (irony)])])]) AC_SUBST([FIND], [$ac_cv_path_FIND]) dnl dnl Tests. dnl AC_PATH_PROG(TEST_PROGRAM, test) AC_PATH_PROG(TRUE, true) AC_PATH_PROG(FALSE, false) dnl dnl Output. dnl AC_PATH_PROG(ECHO, echo) AC_PATH_PROG(CAT, cat) AC_PATH_PROG(ANNOUNCE, announce) dnl dnl Miscellaneous utilities. dnl AC_PROG_SED AC_PATH_PROG(CUT, cut) AC_PROG_PERL_VERSION(5.6.0) AC_PATH_PROG(DATE, date) AC_PATH_PROG(EXPR, expr) AC_PATH_PROG(BASENAME, basename) dnl Java stuff. AC_PROG_JAVA dnl AC_CHECK_CLASS([org.apache.xml.resolver.apps.resolver]) dnl AC_CHECK_CLASS([net.sf.saxon.Transform]) dnl We make heavy use of features specific to GNU make. AC_CACHE_CHECK([for GNU make], [ac_cv_path_MAKE], [AC_PATH_PROGS_FEATURE_CHECK([MAKE], [gnumake gmake make], [AS_IF([( sh -c "$ac_path_MAKE --version" 2> /dev/null | grep GNU 2>&1 > /dev/null )], [ ac_cv_path_MAKE=$ac_path_MAKE ac_path_MAKE_found=:], [])], [AC_MSG_ERROR([could not find GNU make])])]) AC_SUBST([MAKE], [$ac_cv_path_MAKE]) dnl dnl LaTeX and friends. dnl AC_PROG_LATEX AC_PROG_PDFLATEX AC_PROG_XELATEX AC_PROG_DVIPS dnl dnl XML manipulation. dnl AC_PATH_PROG(XMLLINT, xmllint) dnl Use a different variable for the XSLT processor path to keep it distinct dnl from the XSLT environment variable, which serves a slightly different dnl purpose. However, we use the value derived from $XSLT above to seed the dnl executable name. # Figure out the appropriate name of the executable based on $XSLT. AS_CASE([$XSLT], [xalan-c], [AC_PATH_PROG(XSLTPROC, [Xalan])], [xalan-j], [AC_PATH_PROG(XSLTPROC, [xalan])], [saxon-b], [ AC_PATH_JARFILE([saxon9], [SAXON], [/opt/local/share/java /sw/share/java /usr/local/share/java /usr/share/java /opt/local/lib/java /sw/lib/java /usr/local/lib/java /usr/lib/java ${HOME}/Library/Java /Library/Java /System/Library/Java]) AC_MSG_CHECKING([for Saxon-B]) AS_IF([$SAXON_AVAILABLE], [AC_SUBST([XSLTPROC], ["${JAVA} -jar ${SAXON_JAR}"]) AC_MSG_RESULT([$XSLTPROC])], [ AC_MSG_RESULT([no]) AC_MSG_ERROR([could not find Saxon-B])])], [AC_MSG_ERROR([unknown XSLT processor "${XSLT}" specified])]) AC_PATH_JARFILE(resolver, RESOLVER, [/opt/local/share/java /sw/share/java /usr/local/share/java /usr/share/java /opt/local/lib/java /sw/lib/java /usr/local/lib/java /usr/lib/java ${HOME}/Library/Java /Library/Java /System/Library/Java]) AC_MSG_CHECKING([for XML entity resolver]) # We can't use -jar for the entity resolver, because it needs to be able # to use the CLASSPATH to find the CatalogManager.properties file. Using # -jar suppresses the CLASSPATH completely. AS_IF([$RESOLVER_AVAILABLE], [ AC_SUBST([RESOLVER], ["${JAVA} -cp ${RESOLVER_JAR}:${CLASSPATH} org.apache.xml.resolver.apps.resolver"]) AC_MSG_RESULT([$RESOLVER])], [ AC_MSG_RESULT([no]) AC_MSG_ERROR([could not find the XML entity resolver])]) dnl dnl Image manipulation and conversion (includes PDF & PS). dnl AC_PATH_PROG(CONVERT, convert) AC_PATH_PROG(COMPOSITE, composite) AC_PATH_PROG(PDFNUP, pdfnup) AC_PATH_PROG(PDFCROP, pdfcrop) AC_PATH_PROG(PS2EPS, ps2eps) AC_PATH_PROG(PS2PDF, ps2pdf) AC_PATH_PROG(SHIFTBBOX, shiftbbox) AC_PATH_PROG(EPSTOPDF, epstopdf) AC_PATH_PROG(INKSCAPE, inkscape) AC_PATH_PROG(GS, gs) AC_PATH_PROG(XCF2PNG, xcf2png) dnl dnl Plotting tools. dnl AC_PATH_PROG(PLOTICUS, ploticus) AC_PATH_PROG(R, R) dnl dnl Web site synchronisation. dnl AC_PATH_PROG(SITECOPY, sitecopy) dnl dnl CSS development. dnl AC_PATH_PROG(SASS, sass) AC_OUTPUT

Ignore Space Show notes View configuration/include/ac_path_jarfile.m4

dnl dnl @synopsis AC_PATH_JARFILE dnl dnl AC_PATH_JARFILE returns the absolute path to a jar file given the base dnl name. It searches for files in the directories specified in the PATH dnl argument. dnl dnl Based on the macro IT_FIND_OPTIONAL_JAR from the IcedTea-Web distribution, dnl written by Omair Majid <omajid at redhat.com>, 2011-03-08. dnl http://icedtea.classpath.org/ dnl dnl @category Java dnl @author Nigel Stanger <nstanger at infoscience.otago.ac.nz> dnl @version 2012-04-17 dnl @license AllPermissive # # AC_PATH_JARFILE # -------------------- # Find an optional jar required for building and running # # $1 : jar base name (i.e., without suffix) # $2 : variable name used to set $2_JAR and WITH_$2 # $3 (optional) : used to specify additional file paths for searching # # Sets $2_JAR to the jar location (or blank if not found) # Defines WITH_$2 if jar is found # Sets $2_AVAILABLE to "true" if jar is found (or "false" if not) # AC_DEFUN([AC_PATH_JARFILE], [ AC_MSG_CHECKING([for $1.jar]) AC_ARG_WITH([$1], [AS_HELP_STRING(--with-$1,specify location of the $1 jar)], [ case "${withval}" in yes) $2_JAR=yes ;; no) $2_JAR=no ;; *) if test -f "${withval}"; then $2_JAR="${withval}" elif test -z "${withval}"; then $2_JAR=yes else AC_MSG_RESULT([not found]) AC_MSG_ERROR("The $1 jar ${withval} was not found.") fi ;; esac ], [ $2_JAR=yes ]) it_extra_paths_$1="$3" if test "x${$2_JAR}" = "xyes"; then for path in ${it_extra_paths_$1}; do # Make sure we only get the first one if multiple occurrences are found # under the current path. Supress errors for missing paths as well. found_jar=`find ${path} -name $1.jar 2> /dev/null | sed 1q` if test -n "${found_jar}"; then $2_JAR=${found_jar} break fi done fi if test x"${$2_JAR}" = "xyes"; then if test -f "/usr/share/java/$1.jar"; then $2_JAR=/usr/share/java/$1.jar fi fi if test x"${$2_JAR}" = "xyes"; then $2_JAR=no fi AC_MSG_RESULT(${$2_JAR}) AM_CONDITIONAL(WITH_$2, test x"${$2_JAR}" != "xno") # Clear $2_JAR if it doesn't contain a valid filename if test x"${$2_JAR}" = "xno"; then $2_JAR= fi if test -n "${$2_JAR}" ; then $2_AVAILABLE=true else $2_AVAILABLE=false fi AC_SUBST($2_JAR) AC_SUBST($2_AVAILABLE) ]) dnl dnl $Id$ dnl dnl @synopsis AC_PATH_JARFILE dnl dnl AC_PATH_JARFILE returns the absolute path to a jar file given the base dnl name. It searches for files in the directories specified in the PATH dnl argument. dnl dnl Based on the macro IT_FIND_OPTIONAL_JAR from the IcedTea-Web distribution, dnl written by Omair Majid <omajid at redhat.com>, 2011-03-08. dnl http://icedtea.classpath.org/ dnl dnl @category Java dnl @author Nigel Stanger <nstanger at infoscience.otago.ac.nz> dnl @version 2012-04-17 dnl @license AllPermissive # # AC_PATH_JARFILE # -------------------- # Find an optional jar required for building and running # # $1 : jar base name (i.e., without suffix) # $2 : variable name used to set $2_JAR and WITH_$2 # $3 (optional) : used to specify additional file paths for searching # # Sets $2_JAR to the jar location (or blank if not found) # Defines WITH_$2 if jar is found # Sets $2_AVAILABLE to "true" if jar is found (or "false" if not) # AC_DEFUN([AC_PATH_JARFILE], [ AC_MSG_CHECKING([for $1.jar]) AC_ARG_WITH([$1], [AS_HELP_STRING(--with-$1,specify location of the $1 jar)], [ case "${withval}" in yes) $2_JAR=yes ;; no) $2_JAR=no ;; *) if test -f "${withval}"; then $2_JAR="${withval}" elif test -z "${withval}"; then $2_JAR=yes else AC_MSG_RESULT([not found]) AC_MSG_ERROR("The $1 jar ${withval} was not found.") fi ;; esac ], [ $2_JAR=yes ]) it_extra_paths_$1="$3" if test "x${$2_JAR}" = "xyes"; then for path in ${it_extra_paths_$1}; do # Make sure we only get the first one if multiple occurrences are found # under the current path. Supress errors for missing paths as well. found_jar=`find ${path} -name $1.jar 2> /dev/null | sed 1q` if test -n "${found_jar}"; then $2_JAR=${found_jar} break fi done fi if test x"${$2_JAR}" = "xyes"; then if test -f "/usr/share/java/$1.jar"; then $2_JAR=/usr/share/java/$1.jar fi fi if test x"${$2_JAR}" = "xyes"; then $2_JAR=no fi AC_MSG_RESULT(${$2_JAR}) AM_CONDITIONAL(WITH_$2, test x"${$2_JAR}" != "xno") # Clear $2_JAR if it doesn't contain a valid filename if test x"${$2_JAR}" = "xno"; then $2_JAR= fi if test -n "${$2_JAR}" ; then $2_AVAILABLE=true else $2_AVAILABLE=false fi AC_SUBST($2_JAR) AC_SUBST($2_AVAILABLE) ])

Ignore Space Show notes View make-includes/build_content_rules.make

################################################################################ # # Standard variables and rules for building everything associated with a # content file, including graphics and supporting files. Only content # files that have such supporting files need to have (custom) rules # defined for them, all other content files will be handled by make's # default behaviour. # # Note that all versions of the graphics for a content file will be # generated, regardless of whether we are building the web or print # versions. This may seem a little wasteful, but there are two points to # consider here: # # 1. At the time this makefile is executed, we have no easy way # to determine which "build mode" we are in. (It could be done # with exported variables from the parent makefile, but see below.) # # 2. This makefile will only be executed once for the document in # question anyway, because once make has processed the parent # file, that file will be considered "up-to-date", and make will # therefore not come back to it again, even though both the print # and web targets depend on it. # # So, even if we just were clever enough to set up conditionals based on # the "build mode", if we just went "make", we would almost certainly find # that make would build either the web graphics only, or the print # graphics only, but not both. We therefore leave this file as is, and # build both web and print graphics regardless. It doesn't take that much # longer anyway, especially since we won't be regenerating all of the # graphics for _everything_ when only one file has changed :) # ################################################################################ ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Path to the build directory. This must be passed in from the calling # environment. We don't default to the current directory because it makes # it more difficult to clean up. # BUILD_DIR?=$(error The variable BUILD_DIR has not been defined) ################################################################################ # # Paths. All original graphics should normally be in ./graphics or # ./images (where . represents the current content directory), and derived # versions should normally be placed in $(BUILD_DIR). If you want # something different, write your own rules, you deviant! # vpath %-web.png $(BUILD_DIR) vpath %-web-zoom.png $(BUILD_DIR) # vpath %-web-hires.png $(BUILD_DIR) vpath %-print.pdf $(BUILD_DIR) vpath %.svg graphics images vpath %.eps graphics images vpath %.ps graphics images vpath %-print.png $(BUILD_DIR) vpath %.png graphics images vpath %.pdf graphics images ################################################################################ # # List of possible targets. If you need to add to this for a specific # case, use TARGETS+=xxx in the actual makefile. # TARGETS:=all clean web-clean print-clean targets debug .PHONY: $(TARGETS) ################################################################################ # # Default rule, for those who are misguided enough to try running a bare # "make" on the makefile. # all: $(error You need to call this makefile with the name of a specific content file as the target) ################################################################################ # # Build EPS from Inkscape SVG source. # %.eps: %.svg $(INKSCAPE) --file=$< --export-text-to-path --without-gui --export-eps=$@ ################################################################################ # # Build correctly cropped PDF (for printing) from source EPS or PS. See below # for handling PDF sources. # # Notes on ps2eps options: # # --loose expands the bounding box by one "point" (= pixel?), preventing # it from cropping too closely. However, even this doesn't seem to be # enough in all cases, thus: # # --nohires (not --no-hires as specified in the help) prevents it # generating a hi-res bounding box, which seems to fix things in most # cases. # # --ignoreBB because it seems to occasionally wig out and generate # bizarre crap for the bounding box, which then causes GhostScript to # crash (e.g., I've seen it generate a bounding box of 246 53 0 0, which # is just plain impossible). The help suggests using this if # "BoundingBox in output seems to be wrong". I think this counts :) # # ps2eps seems to have a problem with determining the bounding box of one # of the graphics files (the St Germain ERD), which is solved by passing the # --gsbbox option. # # Notes on gs options: # # -dEPSCrop forces gs to crop the EPS image to its bounding box. If not # specified, gs renders the EPS on the default paper size. # # If the fonts go weird in generated PDFs (in particular, they go jaggy # at high resolutions), add -dNOCACHE to the gs commands. While this is # supposedly only "only for debugging" according to the documentation, # in GhostScript 8.15 this seemed to fix the font rendering issue. It # appears to have been fixed in GhostScript 8.51? # %-print.pdf: %.eps @$(ANNOUNCE) "Generating $@ (print)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | $(PS2PDF) -dEPSCrop - $@ @$(MV) $@ $(BUILD_DIR) %-print.pdf: %.ps @$(ANNOUNCE) "Generating $@ (print)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | $(PS2PDF) -dEPSCrop - $@ @$(MV) $@ $(BUILD_DIR) ################################################################################ # # Build correctly cropped PNGs for web display from source EPS, PS or PDF. # # It might seem to make more sense to generate the PNGs from the print # EPS, which has already been appropriately cropped (see above). However, # the results of directory searches using vpath are rather unpredictable # when the source file is not guaranteed to exist. If we depended on # %-print.eps, which is generated by the rule above, it's not guaranteed # that the file will exist at the time that make performs its directory # search (which seems to be done statically). The source EPS isn't # generated and can thus be guaranteed to always exist. Give me guaranteed # correct operation over efficiency any day! :) # # Build 96 DPI version for normal web display # %-web.png: %.eps @$(ANNOUNCE) "Generating $@ (web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web.png: %.ps @$(ANNOUNCE) "Generating $@ (web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web.png: %.pdf @$(ANNOUNCE) "Generating $@ (web)" $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< @$(MV) $@ $(BUILD_DIR) # # Build 144 DPI version for zoomed web display # %-web-zoom.png: %.eps @$(ANNOUNCE) "Generating $@ (zoomed web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web-zoom.png: %.ps @$(ANNOUNCE) "Generating $@ (zoomed web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web-zoom.png: %.pdf @$(ANNOUNCE) "Generating $@ (zoomed web)" $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< @$(MV) $@ $(BUILD_DIR) # # Are 600 DPI versions even needed?? They don't seem to be used anywhere... # # %-web-hires.png: %.eps # @$(ANNOUNCE) "Generating $@ (600 dpi)" # @$(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r600 \ # -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< # @$(MV) $@ $(BUILD_DIR) ################################################################################ # # Some graphics start out as bitmaps (e.g., screenshots) and will # therefore not have an EPS version. We assume that the source for such # images is a PNG file instead. We don't need to generate anything; rather # we just copy the original file to the build directory, because we're # using PNG for the web version anyway, and PDFLaTeX supports PNG # natively. # %-print.png: %.png @$(ANNOUNCE) "Generating $@ (print)" @$(CP) $< $(BUILD_DIR)/$@ %-web.png: %.png @$(ANNOUNCE) "Generating $@ (web)" @$(CP) $< $(BUILD_DIR)/$@ ################################################################################ # # There may be a few graphics that already come in PDF form (e.g., generated # from Visio originals). We don't need to generate anything; rather # we just copy the original file to the build directory. # %-print.pdf: %.pdf @$(ANNOUNCE) "Generating $@ (print)" @$(CP) $< $(BUILD_DIR)/$@ ################################################################################ # # Clean up. These targets are probably no longer needed, as the build # versions are now generated in the build directory. There should # consequently be no extraneous files floating around in the content # directory that need to be cleaned. # # clean: web-clean print-clean # # web-clean: # $(RM) -f *.png # # print-clean: # $(RM) -f *.pdf ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "BUILD_DIR = [$(BUILD_DIR)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS) ################################################################################ # # File: $Id$ # # Standard variables and rules for building everything associated with a # content file, including graphics and supporting files. Only content # files that have such supporting files need to have (custom) rules # defined for them, all other content files will be handled by make's # default behaviour. # # Note that all versions of the graphics for a content file will be # generated, regardless of whether we are building the web or print # versions. This may seem a little wasteful, but there are two points to # consider here: # # 1. At the time this makefile is executed, we have no easy way # to determine which "build mode" we are in. (It could be done # with exported variables from the parent makefile, but see below.) # # 2. This makefile will only be executed once for the document in # question anyway, because once make has processed the parent # file, that file will be considered "up-to-date", and make will # therefore not come back to it again, even though both the print # and web targets depend on it. # # So, even if we just were clever enough to set up conditionals based on # the "build mode", if we just went "make", we would almost certainly find # that make would build either the web graphics only, or the print # graphics only, but not both. We therefore leave this file as is, and # build both web and print graphics regardless. It doesn't take that much # longer anyway, especially since we won't be regenerating all of the # graphics for _everything_ when only one file has changed :) # ################################################################################ ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Path to the build directory. This must be passed in from the calling # environment. We don't default to the current directory because it makes # it more difficult to clean up. # BUILD_DIR?=$(error The variable BUILD_DIR has not been defined) ################################################################################ # # Paths. All original graphics should normally be in ./graphics or # ./images (where . represents the current content directory), and derived # versions should normally be placed in $(BUILD_DIR). If you want # something different, write your own rules, you deviant! # vpath %-web.png $(BUILD_DIR) vpath %-web-zoom.png $(BUILD_DIR) # vpath %-web-hires.png $(BUILD_DIR) vpath %-print.pdf $(BUILD_DIR) vpath %.svg graphics images vpath %.eps graphics images vpath %.ps graphics images vpath %-print.png $(BUILD_DIR) vpath %.png graphics images vpath %.pdf graphics images ################################################################################ # # List of possible targets. If you need to add to this for a specific # case, use TARGETS+=xxx in the actual makefile. # TARGETS:=all clean web-clean print-clean targets debug .PHONY: $(TARGETS) ################################################################################ # # Default rule, for those who are misguided enough to try running a bare # "make" on the makefile. # all: $(error You need to call this makefile with the name of a specific content file as the target) ################################################################################ # # Build EPS from Inkscape SVG source. # %.eps: %.svg $(INKSCAPE) --file=$< --export-text-to-path --without-gui --export-eps=$@ ################################################################################ # # Build correctly cropped PDF (for printing) from source EPS or PS. See below # for handling PDF sources. # # Notes on ps2eps options: # # --loose expands the bounding box by one "point" (= pixel?), preventing # it from cropping too closely. However, even this doesn't seem to be # enough in all cases, thus: # # --nohires (not --no-hires as specified in the help) prevents it # generating a hi-res bounding box, which seems to fix things in most # cases. # # --ignoreBB because it seems to occasionally wig out and generate # bizarre crap for the bounding box, which then causes GhostScript to # crash (e.g., I've seen it generate a bounding box of 246 53 0 0, which # is just plain impossible). The help suggests using this if # "BoundingBox in output seems to be wrong". I think this counts :) # # ps2eps seems to have a problem with determining the bounding box of one # of the graphics files (the St Germain ERD), which is solved by passing the # --gsbbox option. # # Notes on gs options: # # -dEPSCrop forces gs to crop the EPS image to its bounding box. If not # specified, gs renders the EPS on the default paper size. # # If the fonts go weird in generated PDFs (in particular, they go jaggy # at high resolutions), add -dNOCACHE to the gs commands. While this is # supposedly only "only for debugging" according to the documentation, # in GhostScript 8.15 this seemed to fix the font rendering issue. It # appears to have been fixed in GhostScript 8.51? # %-print.pdf: %.eps @$(ANNOUNCE) "Generating $@ (print)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | $(PS2PDF) -dEPSCrop - $@ @$(MV) $@ $(BUILD_DIR) %-print.pdf: %.ps @$(ANNOUNCE) "Generating $@ (print)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | $(PS2PDF) -dEPSCrop - $@ @$(MV) $@ $(BUILD_DIR) ################################################################################ # # Build correctly cropped PNGs for web display from source EPS, PS or PDF. # # It might seem to make more sense to generate the PNGs from the print # EPS, which has already been appropriately cropped (see above). However, # the results of directory searches using vpath are rather unpredictable # when the source file is not guaranteed to exist. If we depended on # %-print.eps, which is generated by the rule above, it's not guaranteed # that the file will exist at the time that make performs its directory # search (which seems to be done statically). The source EPS isn't # generated and can thus be guaranteed to always exist. Give me guaranteed # correct operation over efficiency any day! :) # # Build 96 DPI version for normal web display # %-web.png: %.eps @$(ANNOUNCE) "Generating $@ (web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web.png: %.ps @$(ANNOUNCE) "Generating $@ (web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web.png: %.pdf @$(ANNOUNCE) "Generating $@ (web)" $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< @$(MV) $@ $(BUILD_DIR) # # Build 144 DPI version for zoomed web display # %-web-zoom.png: %.eps @$(ANNOUNCE) "Generating $@ (zoomed web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web-zoom.png: %.ps @$(ANNOUNCE) "Generating $@ (zoomed web)" @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ - @$(MV) $@ $(BUILD_DIR) %-web-zoom.png: %.pdf @$(ANNOUNCE) "Generating $@ (zoomed web)" $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< @$(MV) $@ $(BUILD_DIR) # # Are 600 DPI versions even needed?? They don't seem to be used anywhere... # # %-web-hires.png: %.eps # @$(ANNOUNCE) "Generating $@ (600 dpi)" # @$(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r600 \ # -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< # @$(MV) $@ $(BUILD_DIR) ################################################################################ # # Some graphics start out as bitmaps (e.g., screenshots) and will # therefore not have an EPS version. We assume that the source for such # images is a PNG file instead. We don't need to generate anything; rather # we just copy the original file to the build directory, because we're # using PNG for the web version anyway, and PDFLaTeX supports PNG # natively. # %-print.png: %.png @$(ANNOUNCE) "Generating $@ (print)" @$(CP) $< $(BUILD_DIR)/$@ %-web.png: %.png @$(ANNOUNCE) "Generating $@ (web)" @$(CP) $< $(BUILD_DIR)/$@ ################################################################################ # # There may be a few graphics that already come in PDF form (e.g., generated # from Visio originals). We don't need to generate anything; rather # we just copy the original file to the build directory. # %-print.pdf: %.pdf @$(ANNOUNCE) "Generating $@ (print)" @$(CP) $< $(BUILD_DIR)/$@ ################################################################################ # # Clean up. These targets are probably no longer needed, as the build # versions are now generated in the build directory. There should # consequently be no extraneous files floating around in the content # directory that need to be cleaned. # # clean: web-clean print-clean # # web-clean: # $(RM) -f *.png # # print-clean: # $(RM) -f *.pdf ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "BUILD_DIR = [$(BUILD_DIR)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS)

Ignore Space Show notes View make-includes/build_document_rules.make

################################################################################ # # Standard variables and rules for building a particular document within a # section of the handbook (e.g., a single tutorial). Altering these # definitions will affect ALL DOCUMENT MAKEFILES FOR ALL PAPERS!! If you # need to do something specific for a particular paper, include a custom # rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Run one-time initialisation stuff, _unless_ NOINIT is defined. Any # "parent" makefile that's already done the same one-time initialisation # and calls this one should define NOINIT (the value doesn't matter) to # switch off one-time initialisation in this makefile. Thus if the # "parent" makefile calls this makefile several times, things like the # content checking will only happen once for a single invocation of the # "parent" makefile. # # When running this makefile standalone, _don't_ define NOINIT, and # everything will still work as expected. # ifndef NOINIT include $(GLOBAL_HANDBOOK_INCLUDE)/remove_content_marker_files.make endif ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Include variables defining the current paper. # include $(LOCAL_HANDBOOK_INCLUDE)/paper_variables.make ################################################################################ # # We make quite a lot of reference to files in the handbook directory, # so set a variable to point to it. PAPER_ROOT is defined in the include # file paper_variables.make. # HANDBOOK_ROOT:=$(PAPER_ROOT)/Handbook ################################################################################ # # Include XSLT functions. # include $(GLOBAL_HANDBOOK_INCLUDE)/xslt_functions.make ################################################################################ # # Defines which section we are currently building. This is actually the # path to the main folder for the section. Normally this is passed in as # an argument to make from a higher-level makefile (i.e., "make # SECTION=path/to/section"). # # Hmm, sh seems to convert uppercase letters in my paths to lowercase. # I'm not sure whether this will break anything or not... # # I _can_ confirm that having spaces anywhere in the parent path causes # serious breakage, because notdir returns bogus results in such cases. # All of the make functions assume whitespace delimitation, and there # doesn't seem to be any obvious way to work around this other than # eliminating spaces from the parent path (quoting the result of the # shell function below makes no difference). Fortunately, this is pretty # easy to do :) # # SECTION?=$(notdir $(shell cd ..; pwd)) ################################################################################ # # Set up the context for the current document. # # We use the same base name for both the directory and the document, which # makes life very easy :) # BASE_NAME:=$(notdir $(CURDIR)) # # SOURCE_XML is the original source XML, from which DERIVED_XML is # generated (the derived source has the includes for questions, etc., # inserted). # SOURCE_XML:=$(BASE_NAME).xml DERIVED_XML:=$(SOURCE_XML:.xml=-derived.xml) # # Define the names of the output files. # WEB_QUESTIONS_HTML:=$(BASE_NAME)-questions.html WEB_ANSWERS_HTML:=$(BASE_NAME)-answers.html PRINT_QUESTIONS_TEX:=$(WEB_QUESTIONS_HTML:.html=.tex) PRINT_ANSWERS_TEX:=$(WEB_ANSWERS_HTML:.html=.tex) PRINT_QUESTIONS_PDF_1UP:=$(PRINT_QUESTIONS_TEX:.tex=.pdf) PRINT_ANSWERS_PDF_1UP:=$(PRINT_ANSWERS_TEX:.tex=.pdf) PRINT_QUESTIONS_PDF_2UP:=$(PRINT_QUESTIONS_TEX:.tex=-2up.pdf) PRINT_ANSWERS_PDF_2UP:=$(PRINT_ANSWERS_TEX:.tex=-2up.pdf) # # Groupings of various web- and print-related files, for easy reference. # Feel free to add to these as necessary :) # DERIVED_WEB_FILES:=$(WEB_QUESTIONS_HTML) $(WEB_ANSWERS_HTML) DERIVED_PRINT_FILES:=$(PRINT_QUESTIONS_TEX) $(PRINT_ANSWERS_TEX) \ $(PRINT_QUESTIONS_PDF_1UP) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) $(PRINT_ANSWERS_PDF_2UP) # # List of XSL stylesheets. If any of these change, we need to rebuild # everything. # # We can't use the resolver approach under Windows because of the DOS # pathnames. The style sheets come out of the resolver with paths like # C:\bar\foo\..., and make interprets the colon as an extra dependency # delimiter (tested and behaviour verified). Of course, this works fine on # any platform with sensible path standards. Quoting the value doesn't # help, unfortunately. Bugger :( # #XSLT_STYLESHEETS:=$(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2html.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2html.xsl' ) | $(CUT) -d':' -f3-) $(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2latex.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2latex.xsl' ) | $(CUT) -d':' -f3-) XSLT_STYLESHEETS:=$(TEACHING_SHARED)/Authoring/XML/xml2html.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xhtml.xsl $(TEACHING_SHARED)/Authoring/XML/xml2latex.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xelatex.xsl ################################################################################ # # Extract the list of included filenames from the source template. Hooray # for the shell function and Perl! Include file paths are found within the # href attributes of XML Include elements (<xi:include href="..." />). # All paths are relative to $(PAPER_ROOT). We don't use # $(PAPER_ROOT)/$(SECTION), because some of the include directories may be # in relatively arbitrary locations. # CONTENT_SRC:=$(shell $(PERL) -ne 'print "$(PAPER_ROOT)/$$2\n" if m{<xi:include .*href="(\.\./)*([^"]+)"};' $(SOURCE_XML)) ################################################################################ # # Directory to install files into on web server. # INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/$(SECTION)/$(BASE_NAME) ################################################################################ # # Files to be installed on web server. # QUESTION_INSTALL_FILES:=$(WEB_QUESTIONS_HTML) $(PRINT_QUESTIONS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) $(wildcard *.png) ANSWER_INSTALL_FILES:=$(WEB_ANSWERS_HTML) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_ANSWERS_PDF_2UP) $(wildcard *.png) ################################################################################ # # Lists of files for cleaning up. Add to these (using +=) as necessary in # derived makefiles. Note that ALL_CLEAN_FILES comprises files that need # to be deleted _in addition_ to those listed in WEB_CLEAN_FILES and # PRINT_CLEAN_FILES (that is, it's the list of additional files for the # "clean" target, which depends on "web-clean" and "print-clean" anyway). # WEB_CLEAN_FILES:=$(DERIVED_WEB_FILES) *-web*.png PRINT_CLEAN_FILES:=$(DERIVED_PRINT_FILES) *-print*.png *.pdf ALL_CLEAN_FILES:=$(DERIVED_XML) ################################################################################ # # List of possible targets. If you need to add to this for a specific # case, use TARGETS+=xxx in the actual makefile. # TARGETS:=all content targets debug install-questions install-answers \ web web-questions web-answers \ print print-questions print-answers \ questions answers \ clean web-clean print-clean .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions or answers only. # questions: web-questions print-questions answers: web-answers print-answers ################################################################################ # # Build web version only. # web: web-questions web-answers web-questions: content $(WEB_QUESTIONS_HTML) $(WEB_QUESTIONS_HTML): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ web-answers: content $(WEB_ANSWERS_HTML) $(WEB_ANSWERS_HTML): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ ################################################################################ # # Build print version only. We add code to the LaTeX source to mark the # first and last pages of the document, so that an individual PDF for this # document can be generated later. \markfirstpage and \marklastpage are # macros defined in handbook_template.tex that write the current physical # page number to the .aux file. # print: print-questions print-answers print-questions: content $(PRINT_QUESTIONS_TEX) $(PRINT_QUESTIONS_TEX): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" @$(ECHO) "\\markfirstpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" > $@ $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'sections/$(SECTION)/$(BASE_NAME)'),$(call xslt_parameter,image-format,'pdf')) >> $@ @$(ECHO) "\\marklastpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" >> $@ %-questions.pdf: %-questions.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook.pdf),,$(error $(HANDBOOK_ROOT)/handbook.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$@.1up.first' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$@.1up.last' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook.pdf %-questions-2up.pdf: %-questions.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook-2up.pdf),,$(error $(HANDBOOK_ROOT)/handbook-2up.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.first' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.last' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook-2up.pdf print-answers: content $(PRINT_ANSWERS_TEX) $(PRINT_ANSWERS_TEX): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" @$(ECHO) "\\markfirstpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" > $@ $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'sections/$(SECTION)/$(BASE_NAME)'),$(call xslt_parameter,image-format,'pdf')) >> $@ @$(ECHO) "\\marklastpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" >> $@ %-answers.pdf: %-answers.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook-answers.pdf),,$(error $(HANDBOOK_ROOT)/handbook-answers.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$@.1up.first' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$@.1up.last' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook-answers.pdf %-answers-2up.pdf: %-answers.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook-answers-2up.pdf),,$(error $(HANDBOOK_ROOT)/handbook-answers-2up.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.first' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.last' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook-answers-2up.pdf ################################################################################ # # Generate the derived XML source from the original XML template. # This is done by simply running the original source through xmllint # with the --xinclude option to process all the xi:include elements. # The result of this could have just been piped into the XSLT processor, # except that (a) not all of the processors support input from stdin, # and (b) combining both xmllint and XSLT processing into one command # means that make won't stop if there's any errors from xmllint. # # Sed is used to add a comment to the derived XML file, warning that this # is generated and shouldn't be edited. Sed was used because the <?xml?> # processing instruction MUST be on the first line. The implication here # is that all input source files have an <?xml?> processing instruction # (which they should anyway). # $(DERIVED_XML): $(SOURCE_XML) $(XSLT_STYLESHEETS) @$(ANNOUNCE) "Generating $@" @$(XMLLINT) --xinclude $< >$@ @$(SED) -i -e '1a <!-- THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT! -->' $@ ################################################################################ # # If any of the content files change, touch the XML template to # ensure that the document gets fully rebuilt. # $(SOURCE_XML): $(CONTENT_SRC) @$(TOUCH) $@ ################################################################################ # # Build the individual content files, etc., as necessary. Note above that # all the primary targets depend on the "content" target, _before_ # anything else. This ensures that the content gets rebuilt (if necessary) # before anything else happens. # # This may seem redundant, given that SOURCE_XML depends on CONTENT_SRC in # the rule above. However, this rule only works if we change one of the # actual content files. What if instead, we change a graphic associated # with one of the content files, without changing the content file itself? # In this case, make assumes that nothing needs to be done, because the # content file is older than the target, and this makefile knows nothing # about any dependencies that the content file might have (that's dealt # with by the makefile in the appropriate content directory). This is the # main downside of having independent makefiles. # # So, the slightly convoluted workaround using the empty "content" target # ensures that the content files will always be checked, regardless of # whether they've changed. If any of their prerequisites for a particular # content file change, then the content file itself will be touched, thus # activating the SOURCE_XML rule above. This process is particularly # important to ensure that associated graphics get rebuilt when they # change. # # All that aside, however, the _real_ trick is to ensure that this rule is # only executed once. If we do a "make", this rule would nominally get # executed four times (once for each of the targets that depend on # "content"). The first time through the rule, therefore, we create a # marker file called "content-checked". If this file exists, the rule # isn't executed. These marker files are cleaned up by a one-off find # command when the makefile is first run (see the include file # one-time-init.make). # # Note: using the wildcard function to test for the existence of the # marker file doesn't work when the makefile is run standalone, because # the function result is expanded at the time the makefile is _loaded_, # _before_ the one-time initialisation has a change to kick in and delete # the file. This has the rather bizarre side-effect of the makefile only # re-checking the content on every second run, and means that we can't use # make conditionals to control rule execution. The solution is to prefix # every command in the rule with "test ! -f" to check whether the marker # file exists. # # Ack! The tribulations of not using a monolithic makefile... # content: # Of course, there's little point in doing anything if there's no content! ifneq ($(strip $(CONTENT_SRC)),) @if $(TEST) ! -f content-checked; then \ $(ANNOUNCE) "Checking content for $(BASE_NAME)"; \ fi # Sanity check: do the content files referenced from the original source # actually exist? The "$(TRUE)" is included because there needs to # be something in the body of the if --- you can't just leave it empty. We # can use the wildcard function here because these files should already # exist --- if they don't, then by definition the filename is wrong! @if $(TEST) ! -f content-checked; then \ $(foreach f,$(CONTENT_SRC),$(if $(wildcard $f),,$(error Content file $f referenced from $(SOURCE_XML) does not exist)) $(TRUE);) \ fi # Remake each individual content file. @if $(TEST) ! -f content-checked; then \ $(foreach f,$(CONTENT_SRC),if $(MAKE) -C $(dir $f) $(notdir $f) BUILD_DIR=$(CURDIR); then $(TRUE); else exit 1; fi;) \ fi # Create the marker file so that this rule doesn't get executed again. @if $(TEST) ! -f content-checked; then \ $(TOUCH) content-checked; \ fi endif ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # This checks each file in the build directory against the corresponding # file in the install directory. The local file is only copied to the # install directory if it is newer, or the remote file doesn't exist. # # I was going to do the testing using a target rule that dealt with # each file individually, but for some weird reason it would ignore any # additional files appended to the *_INSTALL_FILES variables. So I've done # it with a foreach instead, which _does_ work. (Ick, although ironically # the code is shorter.) # # !!! How do we get it to also install any extra files that we require # for a particular content file (e.g., the SQL code for Tutorial 3)? !!! # install-questions: questions @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach f,$(QUESTION_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) install-answers: answers @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach f,$(ANSWER_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) ################################################################################ # # Clean up. # clean: web-clean print-clean ifneq ($(strip $(ALL_CLEAN_FILES)),) -$(RM) -f $(ALL_CLEAN_FILES) endif web-clean: ifneq ($(strip $(WEB_CLEAN_FILES)),) -$(RM) -f $(WEB_CLEAN_FILES) endif print-clean: ifneq ($(strip $(PRINT_CLEAN_FILES)),) -$(RM) -f $(PRINT_CLEAN_FILES) endif ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "ALL_PAPERS_ROOT = [$(ALL_PAPERS_ROOT)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ECHO) "NOINIT = [$(NOINIT)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @$(ECHO) "SUBJECT_CODE = [$(SUBJECT_CODE)]" @$(ECHO) "PAPER_NUMBER = [$(PAPER_NUMBER)]" @$(ECHO) "PAPER_YEAR = [$(PAPER_YEAR)]" @$(ECHO) "PAPER_PERIOD = [$(PAPER_PERIOD)]" @$(ECHO) "PAPER_ROOT = [$(PAPER_ROOT)]" @$(ECHO) "HANDBOOK_ROOT = [$(HANDBOOK_ROOT)]" @$(ECHO) "SECTION = [$(SECTION)]" @$(ECHO) "BASE_NAME = [$(BASE_NAME)]" @$(ECHO) "SOURCE_XML = [$(SOURCE_XML)]" @$(ECHO) "DERIVED_XML = [$(DERIVED_XML)]" @$(ECHO) "WEB_QUESTIONS_HTML = [$(WEB_QUESTIONS_HTML)]" @$(ECHO) "WEB_ANSWERS_HTML = [$(WEB_ANSWERS_HTML)]" @$(ECHO) "PRINT_QUESTIONS_TEX = [$(PRINT_QUESTIONS_TEX)]" @$(ECHO) "PRINT_ANSWERS_TEX = [$(PRINT_ANSWERS_TEX)]" @$(ECHO) "PRINT_QUESTIONS_PDF_1UP = [$(PRINT_QUESTIONS_PDF_1UP)]" @$(ECHO) "PRINT_ANSWERS_PDF_1UP = [$(PRINT_ANSWERS_PDF_1UP)]" @$(ECHO) "PRINT_QUESTIONS_PDF_2UP = [$(PRINT_QUESTIONS_PDF_2UP)]" @$(ECHO) "PRINT_ANSWERS_PDF_2UP = [$(PRINT_ANSWERS_PDF_2UP)]" @$(ECHO) "DERIVED_WEB_FILES = [$(DERIVED_WEB_FILES)]" @$(ECHO) "DERIVED_PRINT_FILES = [$(DERIVED_PRINT_FILES)]" @$(ECHO) "XSLT_STYLESHEETS = [$(XSLT_STYLESHEETS)]" @$(ECHO) "CONTENT_SRC = [$(CONTENT_SRC)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "QUESTION_INSTALL_FILES = [$(QUESTION_INSTALL_FILES)]" @$(ECHO) "ANSWER_INSTALL_FILES = [$(ANSWER_INSTALL_FILES)]" @$(ECHO) "WEB_CLEAN_FILES = [$(WEB_CLEAN_FILES)]" @$(ECHO) "PRINT_CLEAN_FILES = [$(PRINT_CLEAN_FILES)]" @$(ECHO) "ALL_CLEAN_FILES = [$(ALL_CLEAN_FILES)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS) ################################################################################ # # File: $Id$ # # Standard variables and rules for building a particular document within a # section of the handbook (e.g., a single tutorial). Altering these # definitions will affect ALL DOCUMENT MAKEFILES FOR ALL PAPERS!! If you # need to do something specific for a particular paper, include a custom # rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Run one-time initialisation stuff, _unless_ NOINIT is defined. Any # "parent" makefile that's already done the same one-time initialisation # and calls this one should define NOINIT (the value doesn't matter) to # switch off one-time initialisation in this makefile. Thus if the # "parent" makefile calls this makefile several times, things like the # content checking will only happen once for a single invocation of the # "parent" makefile. # # When running this makefile standalone, _don't_ define NOINIT, and # everything will still work as expected. # ifndef NOINIT include $(GLOBAL_HANDBOOK_INCLUDE)/remove_content_marker_files.make endif ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Include variables defining the current paper. # include $(LOCAL_HANDBOOK_INCLUDE)/paper_variables.make ################################################################################ # # We make quite a lot of reference to files in the handbook directory, # so set a variable to point to it. PAPER_ROOT is defined in the include # file paper_variables.make. # HANDBOOK_ROOT:=$(PAPER_ROOT)/Handbook ################################################################################ # # Include XSLT functions. # include $(GLOBAL_HANDBOOK_INCLUDE)/xslt_functions.make ################################################################################ # # Defines which section we are currently building. This is actually the # path to the main folder for the section. Normally this is passed in as # an argument to make from a higher-level makefile (i.e., "make # SECTION=path/to/section"). # # Hmm, sh seems to convert uppercase letters in my paths to lowercase. # I'm not sure whether this will break anything or not... # # I _can_ confirm that having spaces anywhere in the parent path causes # serious breakage, because notdir returns bogus results in such cases. # All of the make functions assume whitespace delimitation, and there # doesn't seem to be any obvious way to work around this other than # eliminating spaces from the parent path (quoting the result of the # shell function below makes no difference). Fortunately, this is pretty # easy to do :) # # SECTION?=$(notdir $(shell cd ..; pwd)) ################################################################################ # # Set up the context for the current document. # # We use the same base name for both the directory and the document, which # makes life very easy :) # BASE_NAME:=$(notdir $(CURDIR)) # # SOURCE_XML is the original source XML, from which DERIVED_XML is # generated (the derived source has the includes for questions, etc., # inserted). # SOURCE_XML:=$(BASE_NAME).xml DERIVED_XML:=$(SOURCE_XML:.xml=-derived.xml) # # Define the names of the output files. # WEB_QUESTIONS_HTML:=$(BASE_NAME)-questions.html WEB_ANSWERS_HTML:=$(BASE_NAME)-answers.html PRINT_QUESTIONS_TEX:=$(WEB_QUESTIONS_HTML:.html=.tex) PRINT_ANSWERS_TEX:=$(WEB_ANSWERS_HTML:.html=.tex) PRINT_QUESTIONS_PDF_1UP:=$(PRINT_QUESTIONS_TEX:.tex=.pdf) PRINT_ANSWERS_PDF_1UP:=$(PRINT_ANSWERS_TEX:.tex=.pdf) PRINT_QUESTIONS_PDF_2UP:=$(PRINT_QUESTIONS_TEX:.tex=-2up.pdf) PRINT_ANSWERS_PDF_2UP:=$(PRINT_ANSWERS_TEX:.tex=-2up.pdf) # # Groupings of various web- and print-related files, for easy reference. # Feel free to add to these as necessary :) # DERIVED_WEB_FILES:=$(WEB_QUESTIONS_HTML) $(WEB_ANSWERS_HTML) DERIVED_PRINT_FILES:=$(PRINT_QUESTIONS_TEX) $(PRINT_ANSWERS_TEX) \ $(PRINT_QUESTIONS_PDF_1UP) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) $(PRINT_ANSWERS_PDF_2UP) # # List of XSL stylesheets. If any of these change, we need to rebuild # everything. # # We can't use the resolver approach under Windows because of the DOS # pathnames. The style sheets come out of the resolver with paths like # C:\bar\foo\..., and make interprets the colon as an extra dependency # delimiter (tested and behaviour verified). Of course, this works fine on # any platform with sensible path standards. Quoting the value doesn't # help, unfortunately. Bugger :( # #XSLT_STYLESHEETS:=$(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2html.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2html.xsl' ) | $(CUT) -d':' -f3-) $(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2latex.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2latex.xsl' ) | $(CUT) -d':' -f3-) XSLT_STYLESHEETS:=$(TEACHING_SHARED)/Authoring/XML/xml2html.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xhtml.xsl $(TEACHING_SHARED)/Authoring/XML/xml2latex.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xelatex.xsl ################################################################################ # # Extract the list of included filenames from the source template. Hooray # for the shell function and Perl! Include file paths are found within the # href attributes of XML Include elements (<xi:include href="..." />). # All paths are relative to $(PAPER_ROOT). We don't use # $(PAPER_ROOT)/$(SECTION), because some of the include directories may be # in relatively arbitrary locations. # CONTENT_SRC:=$(shell $(PERL) -ne 'print "$(PAPER_ROOT)/$$2\n" if m{<xi:include .*href="(\.\./)*([^"]+)"};' $(SOURCE_XML)) ################################################################################ # # Directory to install files into on web server. # INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/$(SECTION)/$(BASE_NAME) ################################################################################ # # Files to be installed on web server. # QUESTION_INSTALL_FILES:=$(WEB_QUESTIONS_HTML) $(PRINT_QUESTIONS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) $(wildcard *.png) ANSWER_INSTALL_FILES:=$(WEB_ANSWERS_HTML) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_ANSWERS_PDF_2UP) $(wildcard *.png) ################################################################################ # # Lists of files for cleaning up. Add to these (using +=) as necessary in # derived makefiles. Note that ALL_CLEAN_FILES comprises files that need # to be deleted _in addition_ to those listed in WEB_CLEAN_FILES and # PRINT_CLEAN_FILES (that is, it's the list of additional files for the # "clean" target, which depends on "web-clean" and "print-clean" anyway). # WEB_CLEAN_FILES:=$(DERIVED_WEB_FILES) *-web*.png PRINT_CLEAN_FILES:=$(DERIVED_PRINT_FILES) *-print*.png *.pdf ALL_CLEAN_FILES:=$(DERIVED_XML) ################################################################################ # # List of possible targets. If you need to add to this for a specific # case, use TARGETS+=xxx in the actual makefile. # TARGETS:=all content targets debug install-questions install-answers \ web web-questions web-answers \ print print-questions print-answers \ questions answers \ clean web-clean print-clean .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions or answers only. # questions: web-questions print-questions answers: web-answers print-answers ################################################################################ # # Build web version only. # web: web-questions web-answers web-questions: content $(WEB_QUESTIONS_HTML) $(WEB_QUESTIONS_HTML): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ web-answers: content $(WEB_ANSWERS_HTML) $(WEB_ANSWERS_HTML): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ ################################################################################ # # Build print version only. We add code to the LaTeX source to mark the # first and last pages of the document, so that an individual PDF for this # document can be generated later. \markfirstpage and \marklastpage are # macros defined in handbook_template.tex that write the current physical # page number to the .aux file. # print: print-questions print-answers print-questions: content $(PRINT_QUESTIONS_TEX) $(PRINT_QUESTIONS_TEX): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" @$(ECHO) "\\markfirstpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" > $@ $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'sections/$(SECTION)/$(BASE_NAME)'),$(call xslt_parameter,image-format,'pdf')) >> $@ @$(ECHO) "\\marklastpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" >> $@ %-questions.pdf: %-questions.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook.pdf),,$(error $(HANDBOOK_ROOT)/handbook.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$@.1up.first' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$@.1up.last' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook.pdf %-questions-2up.pdf: %-questions.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook-2up.pdf),,$(error $(HANDBOOK_ROOT)/handbook-2up.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.first' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.last' $(HANDBOOK_ROOT)/handbook.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook-2up.pdf print-answers: content $(PRINT_ANSWERS_TEX) $(PRINT_ANSWERS_TEX): $(DERIVED_XML) @$(ANNOUNCE) "Building $@ from $<" @$(ECHO) "\\markfirstpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" > $@ $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'sections/$(SECTION)/$(BASE_NAME)'),$(call xslt_parameter,image-format,'pdf')) >> $@ @$(ECHO) "\\marklastpage{$(SECTION)/$(BASE_NAME)/$(@:.tex=.pdf)}" >> $@ %-answers.pdf: %-answers.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook-answers.pdf),,$(error $(HANDBOOK_ROOT)/handbook-answers.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$@.1up.first' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$@.1up.last' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook-answers.pdf %-answers-2up.pdf: %-answers.tex @$(ANNOUNCE) "Generating $@" @$(if $(wildcard $(HANDBOOK_ROOT)/handbook-answers-2up.pdf),,$(error $(HANDBOOK_ROOT)/handbook-answers-2up.pdf is missing)) @gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=$@ \ -dFirstPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.first' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) \ -dLastPage=$(shell $(GREP) '$(@:-2up.pdf=.pdf).2up.last' $(HANDBOOK_ROOT)/handbook-answers.aux | $(CUT) -d= -f2) $(HANDBOOK_ROOT)/handbook-answers-2up.pdf ################################################################################ # # Generate the derived XML source from the original XML template. # This is done by simply running the original source through xmllint # with the --xinclude option to process all the xi:include elements. # The result of this could have just been piped into the XSLT processor, # except that (a) not all of the processors support input from stdin, # and (b) combining both xmllint and XSLT processing into one command # means that make won't stop if there's any errors from xmllint. # # Sed is used to add a comment to the derived XML file, warning that this # is generated and shouldn't be edited. Sed was used because the <?xml?> # processing instruction MUST be on the first line. The implication here # is that all input source files have an <?xml?> processing instruction # (which they should anyway). # $(DERIVED_XML): $(SOURCE_XML) $(XSLT_STYLESHEETS) @$(ANNOUNCE) "Generating $@" @$(XMLLINT) --xinclude $< >$@ @$(SED) -i -e '1a <!-- THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT! -->' $@ ################################################################################ # # If any of the content files change, touch the XML template to # ensure that the document gets fully rebuilt. # $(SOURCE_XML): $(CONTENT_SRC) @$(TOUCH) $@ ################################################################################ # # Build the individual content files, etc., as necessary. Note above that # all the primary targets depend on the "content" target, _before_ # anything else. This ensures that the content gets rebuilt (if necessary) # before anything else happens. # # This may seem redundant, given that SOURCE_XML depends on CONTENT_SRC in # the rule above. However, this rule only works if we change one of the # actual content files. What if instead, we change a graphic associated # with one of the content files, without changing the content file itself? # In this case, make assumes that nothing needs to be done, because the # content file is older than the target, and this makefile knows nothing # about any dependencies that the content file might have (that's dealt # with by the makefile in the appropriate content directory). This is the # main downside of having independent makefiles. # # So, the slightly convoluted workaround using the empty "content" target # ensures that the content files will always be checked, regardless of # whether they've changed. If any of their prerequisites for a particular # content file change, then the content file itself will be touched, thus # activating the SOURCE_XML rule above. This process is particularly # important to ensure that associated graphics get rebuilt when they # change. # # All that aside, however, the _real_ trick is to ensure that this rule is # only executed once. If we do a "make", this rule would nominally get # executed four times (once for each of the targets that depend on # "content"). The first time through the rule, therefore, we create a # marker file called "content-checked". If this file exists, the rule # isn't executed. These marker files are cleaned up by a one-off find # command when the makefile is first run (see the include file # one-time-init.make). # # Note: using the wildcard function to test for the existence of the # marker file doesn't work when the makefile is run standalone, because # the function result is expanded at the time the makefile is _loaded_, # _before_ the one-time initialisation has a change to kick in and delete # the file. This has the rather bizarre side-effect of the makefile only # re-checking the content on every second run, and means that we can't use # make conditionals to control rule execution. The solution is to prefix # every command in the rule with "test ! -f" to check whether the marker # file exists. # # Ack! The tribulations of not using a monolithic makefile... # content: # Of course, there's little point in doing anything if there's no content! ifneq ($(strip $(CONTENT_SRC)),) @if $(TEST) ! -f content-checked; then \ $(ANNOUNCE) "Checking content for $(BASE_NAME)"; \ fi # Sanity check: do the content files referenced from the original source # actually exist? The "$(TRUE)" is included because there needs to # be something in the body of the if --- you can't just leave it empty. We # can use the wildcard function here because these files should already # exist --- if they don't, then by definition the filename is wrong! @if $(TEST) ! -f content-checked; then \ $(foreach f,$(CONTENT_SRC),$(if $(wildcard $f),,$(error Content file $f referenced from $(SOURCE_XML) does not exist)) $(TRUE);) \ fi # Remake each individual content file. @if $(TEST) ! -f content-checked; then \ $(foreach f,$(CONTENT_SRC),if $(MAKE) -C $(dir $f) $(notdir $f) BUILD_DIR=$(CURDIR); then $(TRUE); else exit 1; fi;) \ fi # Create the marker file so that this rule doesn't get executed again. @if $(TEST) ! -f content-checked; then \ $(TOUCH) content-checked; \ fi endif ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # This checks each file in the build directory against the corresponding # file in the install directory. The local file is only copied to the # install directory if it is newer, or the remote file doesn't exist. # # I was going to do the testing using a target rule that dealt with # each file individually, but for some weird reason it would ignore any # additional files appended to the *_INSTALL_FILES variables. So I've done # it with a foreach instead, which _does_ work. (Ick, although ironically # the code is shorter.) # # !!! How do we get it to also install any extra files that we require # for a particular content file (e.g., the SQL code for Tutorial 3)? !!! # install-questions: questions @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach f,$(QUESTION_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) install-answers: answers @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach f,$(ANSWER_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) ################################################################################ # # Clean up. # clean: web-clean print-clean ifneq ($(strip $(ALL_CLEAN_FILES)),) -$(RM) -f $(ALL_CLEAN_FILES) endif web-clean: ifneq ($(strip $(WEB_CLEAN_FILES)),) -$(RM) -f $(WEB_CLEAN_FILES) endif print-clean: ifneq ($(strip $(PRINT_CLEAN_FILES)),) -$(RM) -f $(PRINT_CLEAN_FILES) endif ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "ALL_PAPERS_ROOT = [$(ALL_PAPERS_ROOT)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ECHO) "NOINIT = [$(NOINIT)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @$(ECHO) "SUBJECT_CODE = [$(SUBJECT_CODE)]" @$(ECHO) "PAPER_NUMBER = [$(PAPER_NUMBER)]" @$(ECHO) "PAPER_YEAR = [$(PAPER_YEAR)]" @$(ECHO) "PAPER_PERIOD = [$(PAPER_PERIOD)]" @$(ECHO) "PAPER_ROOT = [$(PAPER_ROOT)]" @$(ECHO) "HANDBOOK_ROOT = [$(HANDBOOK_ROOT)]" @$(ECHO) "SECTION = [$(SECTION)]" @$(ECHO) "BASE_NAME = [$(BASE_NAME)]" @$(ECHO) "SOURCE_XML = [$(SOURCE_XML)]" @$(ECHO) "DERIVED_XML = [$(DERIVED_XML)]" @$(ECHO) "WEB_QUESTIONS_HTML = [$(WEB_QUESTIONS_HTML)]" @$(ECHO) "WEB_ANSWERS_HTML = [$(WEB_ANSWERS_HTML)]" @$(ECHO) "PRINT_QUESTIONS_TEX = [$(PRINT_QUESTIONS_TEX)]" @$(ECHO) "PRINT_ANSWERS_TEX = [$(PRINT_ANSWERS_TEX)]" @$(ECHO) "PRINT_QUESTIONS_PDF_1UP = [$(PRINT_QUESTIONS_PDF_1UP)]" @$(ECHO) "PRINT_ANSWERS_PDF_1UP = [$(PRINT_ANSWERS_PDF_1UP)]" @$(ECHO) "PRINT_QUESTIONS_PDF_2UP = [$(PRINT_QUESTIONS_PDF_2UP)]" @$(ECHO) "PRINT_ANSWERS_PDF_2UP = [$(PRINT_ANSWERS_PDF_2UP)]" @$(ECHO) "DERIVED_WEB_FILES = [$(DERIVED_WEB_FILES)]" @$(ECHO) "DERIVED_PRINT_FILES = [$(DERIVED_PRINT_FILES)]" @$(ECHO) "XSLT_STYLESHEETS = [$(XSLT_STYLESHEETS)]" @$(ECHO) "CONTENT_SRC = [$(CONTENT_SRC)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "QUESTION_INSTALL_FILES = [$(QUESTION_INSTALL_FILES)]" @$(ECHO) "ANSWER_INSTALL_FILES = [$(ANSWER_INSTALL_FILES)]" @$(ECHO) "WEB_CLEAN_FILES = [$(WEB_CLEAN_FILES)]" @$(ECHO) "PRINT_CLEAN_FILES = [$(PRINT_CLEAN_FILES)]" @$(ECHO) "ALL_CLEAN_FILES = [$(ALL_CLEAN_FILES)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS)

Ignore Space Show notes View make-includes/build_lecture_rules.make

################################################################################ # # Standard variables and rules for building a set of lecture files. # Altering these definitions will affect ALL LECTURE MAKEFILES FOR ALL # PAPERS!! If you need to do something specific for a particular paper, # include a custom rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Add standard file suffixes. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_suffixes.make ################################################################################ # # Standard directories. # IMGDIR=images ################################################################################ # # Standard paths. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_paths.make ################################################################################ # # Files to be cleaned by the various "clean" targets. Note that we don't # "tidy" .aux files because they may be needed by the xr package for inter- # document cross references, but won't get regenerated if the final target # PDF files exist. They will be caught by by the "clean" target though. # TIDY_FILES+=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi \ slides-combined.pdf slides-notes.pdf CLEAN_FILES+=*.aux *.pdf ################################################################################ # # Various environment variables. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_environment.make # # Base file names for the various documents. # SLIDES?=Chapter$(CHAPTER)slides FIGURES?=Chapter$(CHAPTER)figures COMBINED?=Chapter$(CHAPTER)combined NOTES?=Chapter$(CHAPTER)notes # # Standard files to be installed on the web server. # ifneq ($(strip $(SLIDES)),) INSTALL_FILES+=$(SLIDES).pdf endif ifneq ($(strip $(FIGURES)),) INSTALL_FILES+=$(FIGURES).pdf $(FIGURES)-reduced.pdf endif ifneq ($(strip $(COMBINED)),) INSTALL_FILES+=$(COMBINED).pdf endif INSTALL_FILES+=$(wildcard *.mp3) # # List of standard "phony" build targets. # TARGETS+=slides notes slides-combined slides-notes figures figures2up combined # .PHONY: $(TARGETS) ################################################################################ # # Display a message if someone tries to build a target that has been # disabled (by setting the appropriate variable to empty in the makefile). # disabled_message=@$(ECHO) The \"$(1)\" target has been disabled for this chapter. ################################################################################ # # Build everything. # all: slides notes figures figures2up combined ################################################################################ # # Build presentation slides. If $(SLIDES) is empty, these rules are ignored. # ifneq ($(strip $(SLIDES)),) # # Set the prerequisites for the "slides" build target, depending on # whether the figures document exists. If $(FIGURES) is non-empty, we need # to include the figures .aux file for inter-document cross-references. # ifeq ($(strip $(FIGURES)),) SLIDES_PREREQS:=$(SLIDES).pdf else SLIDES_PREREQS:=figures $(SLIDES).pdf endif # # Build the slides for the presentation. # slides: $(SLIDES_PREREQS) $(SLIDES).pdf: $(SLIDES).tex $(SLIDE_IMAGES) $(SLIDE_BACKGROUNDS) $(SLIDE_FILES) $(PDFLATEX) --jobname=$(SLIDES) '\documentclass[$(LATEX_OPTS)]{lectureslides}\input{$(SLIDES)}' $(PDFLATEX) --jobname=$(SLIDES) '\documentclass[$(LATEX_OPTS)]{lectureslides}\input{$(SLIDES)}' else slides: $(call disabled_message,$@) endif ################################################################################ # # Build the presentation notes. If $(NOTES) is empty, these rules are # ignored. # ifneq ($(strip $(NOTES)),) # # Build the slides with notes. # slides-notes: slides-notes.pdf slides-notes.pdf: $(SLIDES).tex $(SLIDE_IMAGES) $(SLIDE_BACKGROUNDS) $(SLIDE_FILES) $(PDFLATEX) --jobname=slides-notes '\documentclass[$(LATEX_OPTS),notes=onlyslideswithnotes]{lectureslides}\input{$(SLIDES)}' $(PDFLATEX) --jobname=slides-notes '\documentclass[$(LATEX_OPTS),notes=onlyslideswithnotes]{lectureslides}\input{$(SLIDES)}' # # Build the slides with notes, 6-up. # notes: $(NOTES).pdf $(NOTES).pdf: $(NOTES).tex slides-notes.pdf $(PDFLATEX) $< $(PDFLATEX) $< else notes slides-notes: $(call disabled_message,$@) endif ################################################################################ # # Build the complete combined lecture document. If $(COMBINED) is empty, # these rules are ignored. # ifneq ($(strip $(COMBINED)),) # # Set the prerequisites for the "combined" build target, depending on # whether the figures document exists. If $(FIGURES) is empty, they are # omitted from the combined document. # ifeq ($(strip $(FIGURES)),) COMBINED_PREREQS:=$(COMBINED).tex slides-combined.pdf else COMBINED_PREREQS:=$(COMBINED).tex slides-combined.pdf $(FIGURES).pdf endif # # Build the slides for the combined document. # slides-combined: slides-combined.pdf slides-combined.pdf: $(SLIDES).tex $(SLIDE_IMAGES) $(SLIDE_BACKGROUNDS) $(PDFLATEX) --jobname=slides-combined '\documentclass[$(LATEX_OPTS),handout]{lectureslides}\input{$(SLIDES)}' $(PDFLATEX) --jobname=slides-combined '\documentclass[$(LATEX_OPTS),handout]{lectureslides}\input{$(SLIDES)}' # # Build the complete combined document. # combined: $(COMBINED).pdf $(COMBINED).pdf: $(COMBINED_PREREQS) $(COMBI_IMAGES) $(COMBI_FILES) $(PDFLATEX) $< $(PDFLATEX) $< else combined slides-combined: $(call disabled_message,$@) endif ################################################################################ # # Build the figures and examples document. If $(FIGURES) is empty, these # rules are ignored. # ifneq ($(strip $(FIGURES)),) figures: $(FIGURES).pdf $(FIGURES).pdf: $(FIGURES).tex $(FIG_IMAGES) $(FIG_FILES) $(PDFLATEX) $< $(PDFLATEX) $< figures2up: $(FIGURES)-reduced.pdf $(FIGURES)-reduced.pdf: $(FIGURES).pdf $(PDFNUP) $< --nup 2x1 --outfile $@ else figures figures2up: $(call disabled_message,$@) endif ################################################################################ # # Build the test document. # test: test.pdf test.pdf: test.tex ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackbaord. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # See build_document_rules.make for an explanation of why the install # uses a foreach. # # Note that this won't do anything clever if you give it files that are # in subdirectories of the current directory. Everything will be flattened # at the other end. That is, something like "images/foo.pdf" will go into # the installation directory as "foo.pdf", not "images/foo.pdf". # # If the variable NOSYNC is set (to anything), then files won't be synchronised # with Blackboard. # install: ifndef NOSYNC @$(SITECOPY) --update --keep-going Blackboard$(PAPER_NUMBER) @$(SITECOPY) --catchup Blackboard$(PAPER_NUMBER) endif @$(ANNOUNCE) "Deploying files into $(INSTALL_DIRECTORY)" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach f,$(INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/`$(BASENAME) $(f)` -o $(f) -nt $(INSTALL_DIRECTORY)/`$(BASENAME) $(f)`; then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) ifndef NOSYNC @$(ANNOUNCE) "Synchronising with Blackboard" @$(SITECOPY) --update Blackboard$(PAPER_NUMBER) endif ################################################################################ # # Debugging: print the values of the standard variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ECHO) "CHAPTER = [$(CHAPTER)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "SUBJECT_CODE = [$(SUBJECT_CODE)]" @$(ECHO) "PAPER_NUMBER = [$(PAPER_NUMBER)]" @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "BUILD_DIR = [$(BUILD_DIR)]" @$(ECHO) "INSTALL_FILES = [$(INSTALL_FILES)]" @$(ECHO) "SLIDE_IMAGES = [$(SLIDE_IMAGES)]" @$(ECHO) "SLIDE_BACKGROUNDS = [$(SLIDE_BACKGROUNDS)]" @$(ECHO) "SLIDE_FILES = [$(SLIDE_FILES)]" @$(ECHO) "FIG_IMAGES = [$(FIG_IMAGES)]" @$(ECHO) "FIG_FILES = [$(FIG_FILES)]" @$(ECHO) "TIDY_FILES = [$(TIDY_FILES)]" @$(ECHO) "CLEAN_FILES = [$(CLEAN_FILES)]" @$(ECHO) "DRAFT = [$(DRAFT)]" @$(ECHO) "LATEX_OPTS = [$(LATEX_OPTS)]" @$(ECHO) "SLIDES = [$(SLIDES)]" @$(ECHO) "FIGURES = [$(FIGURES)]" @$(ECHO) "COMBINED = [$(COMBINED)]" @$(ECHO) "NOTES = [$(NOTES)]" @$(ECHO) "SLIDES_PREREQS = [$(SLIDES_PREREQS)]" @$(ECHO) "COMBINED_PREREQS = [$(COMBINED_PREREQS)]" @$(ECHO) "TARGETS = [$(TARGETS)]" ################################################################################ # # Clean up: get rid of all the temporary files. # tidy: $(RM) -f $(TIDY_FILES) # # Clean up: get rid of everything except the original source. # clean: tidy $(RM) -f $(CLEAN_FILES) ################################################################################ # # List all "phony" build targets. # targets: @$(ECHO) "targets: $(TARGETS)" ################################################################################ # # Standard default rules. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_rules.make ################################################################################ # # File: $Id$ # # Standard variables and rules for building a set of lecture files. # Altering these definitions will affect ALL LECTURE MAKEFILES FOR ALL # PAPERS!! If you need to do something specific for a particular paper, # include a custom rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Add standard file suffixes. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_suffixes.make ################################################################################ # # Standard directories. # IMGDIR=images ################################################################################ # # Standard paths. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_paths.make ################################################################################ # # Files to be cleaned by the various "clean" targets. Note that we don't # "tidy" .aux files because they may be needed by the xr package for inter- # document cross references, but won't get regenerated if the final target # PDF files exist. They will be caught by by the "clean" target though. # TIDY_FILES+=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi \ slides-combined.pdf slides-notes.pdf CLEAN_FILES+=*.aux *.pdf ################################################################################ # # Various environment variables. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_environment.make # # Base file names for the various documents. # SLIDES?=Chapter$(CHAPTER)slides FIGURES?=Chapter$(CHAPTER)figures COMBINED?=Chapter$(CHAPTER)combined NOTES?=Chapter$(CHAPTER)notes # # Standard files to be installed on the web server. # ifneq ($(strip $(SLIDES)),) INSTALL_FILES+=$(SLIDES).pdf endif ifneq ($(strip $(FIGURES)),) INSTALL_FILES+=$(FIGURES).pdf $(FIGURES)-reduced.pdf endif ifneq ($(strip $(COMBINED)),) INSTALL_FILES+=$(COMBINED).pdf endif INSTALL_FILES+=$(wildcard *.mp3) # # List of standard "phony" build targets. # TARGETS+=slides notes slides-combined slides-notes figures figures2up combined # .PHONY: $(TARGETS) ################################################################################ # # Display a message if someone tries to build a target that has been # disabled (by setting the appropriate variable to empty in the makefile). # disabled_message=@$(ECHO) The \"$(1)\" target has been disabled for this chapter. ################################################################################ # # Build everything. # all: slides notes figures figures2up combined ################################################################################ # # Build presentation slides. If $(SLIDES) is empty, these rules are ignored. # ifneq ($(strip $(SLIDES)),) # # Set the prerequisites for the "slides" build target, depending on # whether the figures document exists. If $(FIGURES) is non-empty, we need # to include the figures .aux file for inter-document cross-references. # ifeq ($(strip $(FIGURES)),) SLIDES_PREREQS:=$(SLIDES).pdf else SLIDES_PREREQS:=figures $(SLIDES).pdf endif # # Build the slides for the presentation. # slides: $(SLIDES_PREREQS) $(SLIDES).pdf: $(SLIDES).tex $(SLIDE_IMAGES) $(SLIDE_BACKGROUNDS) $(SLIDE_FILES) $(PDFLATEX) --jobname=$(SLIDES) '\documentclass[$(LATEX_OPTS)]{lectureslides}\input{$(SLIDES)}' $(PDFLATEX) --jobname=$(SLIDES) '\documentclass[$(LATEX_OPTS)]{lectureslides}\input{$(SLIDES)}' else slides: $(call disabled_message,$@) endif ################################################################################ # # Build the presentation notes. If $(NOTES) is empty, these rules are # ignored. # ifneq ($(strip $(NOTES)),) # # Build the slides with notes. # slides-notes: slides-notes.pdf slides-notes.pdf: $(SLIDES).tex $(SLIDE_IMAGES) $(SLIDE_BACKGROUNDS) $(SLIDE_FILES) $(PDFLATEX) --jobname=slides-notes '\documentclass[$(LATEX_OPTS),notes=onlyslideswithnotes]{lectureslides}\input{$(SLIDES)}' $(PDFLATEX) --jobname=slides-notes '\documentclass[$(LATEX_OPTS),notes=onlyslideswithnotes]{lectureslides}\input{$(SLIDES)}' # # Build the slides with notes, 6-up. # notes: $(NOTES).pdf $(NOTES).pdf: $(NOTES).tex slides-notes.pdf $(PDFLATEX) $< $(PDFLATEX) $< else notes slides-notes: $(call disabled_message,$@) endif ################################################################################ # # Build the complete combined lecture document. If $(COMBINED) is empty, # these rules are ignored. # ifneq ($(strip $(COMBINED)),) # # Set the prerequisites for the "combined" build target, depending on # whether the figures document exists. If $(FIGURES) is empty, they are # omitted from the combined document. # ifeq ($(strip $(FIGURES)),) COMBINED_PREREQS:=$(COMBINED).tex slides-combined.pdf else COMBINED_PREREQS:=$(COMBINED).tex slides-combined.pdf $(FIGURES).pdf endif # # Build the slides for the combined document. # slides-combined: slides-combined.pdf slides-combined.pdf: $(SLIDES).tex $(SLIDE_IMAGES) $(SLIDE_BACKGROUNDS) $(PDFLATEX) --jobname=slides-combined '\documentclass[$(LATEX_OPTS),handout]{lectureslides}\input{$(SLIDES)}' $(PDFLATEX) --jobname=slides-combined '\documentclass[$(LATEX_OPTS),handout]{lectureslides}\input{$(SLIDES)}' # # Build the complete combined document. # combined: $(COMBINED).pdf $(COMBINED).pdf: $(COMBINED_PREREQS) $(COMBI_IMAGES) $(COMBI_FILES) $(PDFLATEX) $< $(PDFLATEX) $< else combined slides-combined: $(call disabled_message,$@) endif ################################################################################ # # Build the figures and examples document. If $(FIGURES) is empty, these # rules are ignored. # ifneq ($(strip $(FIGURES)),) figures: $(FIGURES).pdf $(FIGURES).pdf: $(FIGURES).tex $(FIG_IMAGES) $(FIG_FILES) $(PDFLATEX) $< $(PDFLATEX) $< figures2up: $(FIGURES)-reduced.pdf $(FIGURES)-reduced.pdf: $(FIGURES).pdf $(PDFNUP) $< --nup 2x1 --outfile $@ else figures figures2up: $(call disabled_message,$@) endif ################################################################################ # # Build the test document. # test: test.pdf test.pdf: test.tex ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackbaord. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # See build_document_rules.make for an explanation of why the install # uses a foreach. # # Note that this won't do anything clever if you give it files that are # in subdirectories of the current directory. Everything will be flattened # at the other end. That is, something like "images/foo.pdf" will go into # the installation directory as "foo.pdf", not "images/foo.pdf". # # If the variable NOSYNC is set (to anything), then files won't be synchronised # with Blackboard. # install: ifndef NOSYNC @$(SITECOPY) --update --keep-going Blackboard$(PAPER_NUMBER) @$(SITECOPY) --catchup Blackboard$(PAPER_NUMBER) endif @$(ANNOUNCE) "Deploying files into $(INSTALL_DIRECTORY)" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach f,$(INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/`$(BASENAME) $(f)` -o $(f) -nt $(INSTALL_DIRECTORY)/`$(BASENAME) $(f)`; then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) ifndef NOSYNC @$(ANNOUNCE) "Synchronising with Blackboard" @$(SITECOPY) --update Blackboard$(PAPER_NUMBER) endif ################################################################################ # # Debugging: print the values of the standard variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ECHO) "CHAPTER = [$(CHAPTER)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "SUBJECT_CODE = [$(SUBJECT_CODE)]" @$(ECHO) "PAPER_NUMBER = [$(PAPER_NUMBER)]" @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "BUILD_DIR = [$(BUILD_DIR)]" @$(ECHO) "INSTALL_FILES = [$(INSTALL_FILES)]" @$(ECHO) "SLIDE_IMAGES = [$(SLIDE_IMAGES)]" @$(ECHO) "SLIDE_BACKGROUNDS = [$(SLIDE_BACKGROUNDS)]" @$(ECHO) "SLIDE_FILES = [$(SLIDE_FILES)]" @$(ECHO) "FIG_IMAGES = [$(FIG_IMAGES)]" @$(ECHO) "FIG_FILES = [$(FIG_FILES)]" @$(ECHO) "TIDY_FILES = [$(TIDY_FILES)]" @$(ECHO) "CLEAN_FILES = [$(CLEAN_FILES)]" @$(ECHO) "DRAFT = [$(DRAFT)]" @$(ECHO) "LATEX_OPTS = [$(LATEX_OPTS)]" @$(ECHO) "SLIDES = [$(SLIDES)]" @$(ECHO) "FIGURES = [$(FIGURES)]" @$(ECHO) "COMBINED = [$(COMBINED)]" @$(ECHO) "NOTES = [$(NOTES)]" @$(ECHO) "SLIDES_PREREQS = [$(SLIDES_PREREQS)]" @$(ECHO) "COMBINED_PREREQS = [$(COMBINED_PREREQS)]" @$(ECHO) "TARGETS = [$(TARGETS)]" ################################################################################ # # Clean up: get rid of all the temporary files. # tidy: $(RM) -f $(TIDY_FILES) # # Clean up: get rid of everything except the original source. # clean: tidy $(RM) -f $(CLEAN_FILES) ################################################################################ # # List all "phony" build targets. # targets: @$(ECHO) "targets: $(TARGETS)" ################################################################################ # # Standard default rules. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_rules.make

Ignore Space Show notes View make-includes/build_misc_rules.make

################################################################################ # # Standard variables and rules for building a general standalone document # that doesn't fall into any partcular category (such as lecture, tutorial). # The makefile assumes a single document source file. Anything more # complex than this will need to be handled by a custom makefile. # # Altering these definitions will affect ALL MAKEFILES FOR ALL PAPERS!! If # you need to do something specific for a particular paper, include a # custom rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Include XSLT functions. # include $(TEACHING_SHARED)/Authoring/Handbook/make-includes/xslt_functions.make ################################################################################ # # Required make variables. These should be defined by the calling makefile. # # BASE_NAMES # The base name(s) of the document source file(s). It may be a list, which # enables multiple different documents to be built by the one Makefile. # BASE_NAMES?=$(error The required make variable BASE_NAMES has not been defined. Please set it to the base name(s) of the document source file(s)) ################################################################################ # # Set up the context for the current document. # # SOURCE_XML is the original source XML, from which DERIVED_XML is # generated (the derived source has the includes for questions, etc., # inserted). # SOURCE_XML:=$(foreach n,$(BASE_NAMES),$(n).xml) DERIVED_XML:=$(SOURCE_XML:.xml=-derived.xml) # # Define the names of the output files. # ifdef HAS_ANSWERS WEB_QUESTIONS_HTML:=$(SOURCE_XML:.xml=-questions.html) WEB_ANSWERS_HTML:=$(SOURCE_XML:.xml=-answers.html) PRINT_QUESTIONS_TEX:=$(WEB_QUESTIONS_HTML:.html=.tex) PRINT_ANSWERS_TEX:=$(WEB_ANSWERS_HTML:.html=.tex) PRINT_QUESTIONS_PDF_1UP:=$(PRINT_QUESTIONS_TEX:.tex=.pdf) PRINT_ANSWERS_PDF_1UP:=$(PRINT_ANSWERS_TEX:.tex=.pdf) PRINT_QUESTIONS_PDF_2UP:=$(PRINT_QUESTIONS_TEX:.tex=-2up.pdf) PRINT_ANSWERS_PDF_2UP:=$(PRINT_ANSWERS_TEX:.tex=-2up.pdf) else WEB_HTML:=$(SOURCE_XML:.xml=.html) PRINT_TEX:=$(SOURCE_XML:.xml=.tex) PRINT_PDF_1UP:=$(SOURCE_XML:.xml=.pdf) PRINT_PDF_2UP:=$(SOURCE_XML:.xml=-2up.pdf) endif # # List of XSL stylesheets. If any of these change, we need to rebuild # everything. # # We can't use the resolver approach under Windows because of the DOS # pathnames. The style sheets come out of the resolver with paths like # C:\bar\foo\..., and make interprets the colon as an extra dependency # delimiter (tested and behaviour verified). Of course, this works fine on # any platform with sensible path standards. Quoting the value doesn't # help, unfortunately. Bugger :( # #XSLT_STYLESHEETS:=$(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2html.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2html.xsl' ) | $(CUT) -d':' -f3-) $(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2latex.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2latex.xsl' ) | $(CUT) -d':' -f3-) XSLT_STYLESHEETS:=$(TEACHING_SHARED)/Authoring/XML/xml2html.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xhtml.xsl $(TEACHING_SHARED)/Authoring/XML/xml2latex.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xelatex.xsl ################################################################################ # # Add standard file suffixes. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_suffixes.make ################################################################################ # # Standard directories. # IMGDIR=images ################################################################################ # # Standard paths. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_paths.make ################################################################################ # # Files to be installed on web server. # ifdef HAS_ANSWERS QUESTION_INSTALL_FILES:=$(WEB_QUESTIONS_HTML) $(PRINT_QUESTIONS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) ANSWER_INSTALL_FILES:=$(WEB_ANSWERS_HTML) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_ANSWERS_PDF_2UP) else INSTALL_FILES:=$(WEB_HTML) $(PRINT_PDF_1UP) $(PRINT_PDF_2UP) endif ################################################################################ # # Files to be cleaned by the various "clean" targets. Note that we don't # "tidy" .aux files because they may be needed by the xr package for inter- # document cross references, but won't get regenerated if the final target # PDF files exist. They will be caught by by the "clean" target though. # TIDY_FILES+=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi *-derived.xml CLEAN_FILES+=*.aux $(IMGDIR)/*-print.pdf $(IMGDIR)/*-print.png \ $(IMGDIR)/*-web.png $(IMGDIR)/*-web-zoom.png ifdef HAS_ANSWERS TIDY_FILES+=$(PRINT_QUESTIONS_TEX) $(PRINT_ANSWERS_TEX) CLEAN_FILES+=$(WEB_QUESTIONS_HTML) $(WEB_ANSWERS_HTML) \ $(PRINT_QUESTIONS_PDF_1UP) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) $(PRINT_ANSWERS_PDF_2UP) else TIDY_FILES+=$(PRINT_TEX) CLEAN_FILES+=$(WEB_HTML) $(PRINT_PDF_1UP) $(PRINT_PDF_2UP) endif ################################################################################ # # Various environment variables. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_environment.make # # List of standard "phony" build targets. Varies depending on whether # answers are enabled. # TARGETS+=web print $(BASE_NAMES) ifdef HAS_ANSWERS TARGETS+=web-questions web-answers \ print-questions print-answers \ questions answers endif # .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions or answers only. # ifdef HAS_ANSWERS questions: web-questions print-questions answers: web-answers print-answers endif ################################################################################ # # Build web version only. # ifdef HAS_ANSWERS web: web-questions web-answers web-questions: $(WEB_QUESTIONS_HTML) $(WEB_IMAGES) $(WEB_FILES) $(WEB_QUESTIONS_HTML): %-questions.html: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xhtml.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ else $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ endif web-answers: $(WEB_ANSWERS_HTML) $(WEB_IMAGES) $(WEB_FILES) $(WEB_ANSWERS_HTML): %-answers.html: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xhtml.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ else $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ endif else web: $(WEB_HTML) $(WEB_IMAGES) $(WEB_FILES) endif ################################################################################ # # Build print version only. # ifdef HAS_ANSWERS print: print-questions print-answers print-questions: $(PRINT_QUESTIONS_PDF_1UP) $(PRINT_QUESTIONS_PDF_2UP) $(PRINT_QUESTIONS_PDF_1UP): $(PRINT_IMAGES) $(PRINT_FILES) $(PRINT_QUESTIONS_TEX): %-questions.tex: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xelatex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ else $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ endif print-answers: $(PRINT_ANSWERS_PDF_1UP) $(PRINT_ANSWERS_PDF_2UP) $(PRINT_ANSWERS_PDF_1UP): $(PRINT_IMAGES) $(PRINT_FILES) $(PRINT_ANSWERS_TEX): %-answers.tex: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xelatex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ else $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ endif else print: $(PRINT_PDF_1UP) $(PRINT_PDF_2UP) $(PRINT_PDF_1UP): $(PRINT_IMAGES) $(PRINT_FILES) endif ################################################################################ # # Generate the derived XML source from the original XML template. # This is done by simply running the original source through xmllint # with the --xinclude option to process all the xi:include elements. # The result of this could have just been piped into the XSLT processor, # except that (a) not all of the processors support input from stdin, # and (b) combining both xmllint and XSLT processing into one command # means that make won't stop if there's any errors from xmllint. # # Sed is used to add a comment to the derived XML file, warning that this # is generated and shouldn't be edited. Sed was used because the <?xml?> # processing instruction MUST be on the first line. The implication here # is that all input source files have an <?xml?> processing instruction # (which they should anyway). # $(DERIVED_XML): %-derived.xml: %.xml $(XSLT_STYLESHEETS) $(XMLLINT) --xinclude $< >$@ @$(SED) -i -e '1a <!-- THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT! -->' $@ ################################################################################ # # Build the test document. # test: test.pdf test.pdf: test.tex ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # See build_document_rules.make for an explanation of why the install # uses a foreach. # # Note that this won't do anything clever if you give it files that are # in subdirectories of the current directory. Everything will be flattened # at the other end. That is, something like "images/foo.pdf" will go into # the installation directory as "foo.pdf", not "images/foo.pdf". # install: all @$(SITECOPY) --update --keep-going Blackboard$(PAPER_NUMBER) @$(SITECOPY) --catchup Blackboard$(PAPER_NUMBER) @$(ANNOUNCE) "Deploying files into $(INSTALL_DIRECTORY)" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @if $(TEST) -n "$(WEB_IMAGES)"; then $(MKDIR_P) $(INSTALL_DIRECTORY)/$(IMGDIR); fi ifdef HAS_ANSWERS @$(foreach f,$(QUESTION_INSTALL_FILES) $(ANSWER_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) else @$(foreach f,$(INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) endif @$(foreach f,$(WEB_IMAGES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(IMGDIR)/$(f) -o $(IMGDIR)/$(f) -nt $(INSTALL_DIRECTORY)/$(IMGDIR)/$(f); then $(ECHO) "Deploying $(IMGDIR)/$(f)"; $(CP) $(IMGDIR)/$(f) $(INSTALL_DIRECTORY)/$(IMGDIR); fi;) @$(ANNOUNCE) "Synchronising with Blackboard" @$(SITECOPY) --update Blackboard$(PAPER_NUMBER) ################################################################################ # # Debugging: print the values of the standard variables. # debug: @announce Externally defined variables @echo "TEACHING_SHARED = [$(TEACHING_SHARED)]" @announce Internally defined variables @echo "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @echo "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @echo "BUILD_DIR = [$(BUILD_DIR)]" @echo "BASE_NAMES = [$(BASE_NAMES)]" @echo "SOURCE_XML = [$(SOURCE_XML)]" @echo "DERIVED_XML = [$(DERIVED_XML)]" @echo "SUBJECT_CODE = [$(SUBJECT_CODE)]" @echo "PAPER_NUMBER = [$(PAPER_NUMBER)]" @echo "HAS_ANSWERS = [$(HAS_ANSWERS)]" ifdef HAS_ANSWERS @echo "WEB_QUESTIONS_HTML = [$(WEB_QUESTIONS_HTML)]" @echo "WEB_ANSWERS_HTML = [$(WEB_ANSWERS_HTML)]" @echo "PRINT_QUESTIONS_TEX = [$(PRINT_QUESTIONS_TEX)]" @echo "PRINT_ANSWERS_TEX = [$(PRINT_ANSWERS_TEX)]" @echo "PRINT_QUESTIONS_PDF_1UP = [$(PRINT_QUESTIONS_PDF_1UP)]" @echo "PRINT_ANSWERS_PDF_1UP = [$(PRINT_ANSWERS_PDF_1UP)]" @echo "PRINT_QUESTIONS_PDF_2UP = [$(PRINT_QUESTIONS_PDF_2UP)]" @echo "PRINT_ANSWERS_PDF_2UP = [$(PRINT_ANSWERS_PDF_2UP)]" @echo "QUESTION_INSTALL_FILES = [$(QUESTION_INSTALL_FILES)]" @echo "ANSWER_INSTALL_FILES = [$(ANSWER_INSTALL_FILES)]" else @echo "WEB_HTML = [$(WEB_HTML)]" @echo "PRINT_TEX = [$(PRINT_TEX)]" @echo "PRINT_PDF_1UP = [$(PRINT_PDF_1UP)]" @echo "PRINT_PDF_2UP = [$(PRINT_PDF_2UP)]" @echo "INSTALL_FILES = [$(INSTALL_FILES)]" endif @echo "XSLT_STYLESHEETS = [$(XSLT_STYLESHEETS)]" @echo "PRINT_IMAGES = [$(PRINT_IMAGES)]" @echo "PRINT_FILES = [$(PRINT_FILES)]" @echo "WEB_IMAGES = [$(WEB_IMAGES)]" @echo "WEB_FILES = [$(WEB_FILES)]" @echo "TIDY_FILES = [$(TIDY_FILES)]" @echo "CLEAN_FILES = [$(CLEAN_FILES)]" @echo "DRAFT = [$(DRAFT)]" @echo "LATEX_OPTS = [$(LATEX_OPTS)]" @echo "TARGETS = [$(TARGETS)]" ################################################################################ # # Clean up: get rid of all the temporary files. # tidy: $(RM) -f $(TIDY_FILES) # # Clean up: get rid of everything except the original source. # clean: tidy $(RM) -f $(CLEAN_FILES) ################################################################################ # # List all "phony" build targets. # targets: @echo "targets: $(TARGETS)" ################################################################################ # # Standard default rules. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_rules.make ################################################################################ # # File: $Id$ # # Standard variables and rules for building a general standalone document # that doesn't fall into any partcular category (such as lecture, tutorial). # The makefile assumes a single document source file. Anything more # complex than this will need to be handled by a custom makefile. # # Altering these definitions will affect ALL MAKEFILES FOR ALL PAPERS!! If # you need to do something specific for a particular paper, include a # custom rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Include XSLT functions. # include $(TEACHING_SHARED)/Authoring/Handbook/make-includes/xslt_functions.make ################################################################################ # # Required make variables. These should be defined by the calling makefile. # # BASE_NAMES # The base name(s) of the document source file(s). It may be a list, which # enables multiple different documents to be built by the one Makefile. # BASE_NAMES?=$(error The required make variable BASE_NAMES has not been defined. Please set it to the base name(s) of the document source file(s)) ################################################################################ # # Set up the context for the current document. # # SOURCE_XML is the original source XML, from which DERIVED_XML is # generated (the derived source has the includes for questions, etc., # inserted). # SOURCE_XML:=$(foreach n,$(BASE_NAMES),$(n).xml) DERIVED_XML:=$(SOURCE_XML:.xml=-derived.xml) # # Define the names of the output files. # ifdef HAS_ANSWERS WEB_QUESTIONS_HTML:=$(SOURCE_XML:.xml=-questions.html) WEB_ANSWERS_HTML:=$(SOURCE_XML:.xml=-answers.html) PRINT_QUESTIONS_TEX:=$(WEB_QUESTIONS_HTML:.html=.tex) PRINT_ANSWERS_TEX:=$(WEB_ANSWERS_HTML:.html=.tex) PRINT_QUESTIONS_PDF_1UP:=$(PRINT_QUESTIONS_TEX:.tex=.pdf) PRINT_ANSWERS_PDF_1UP:=$(PRINT_ANSWERS_TEX:.tex=.pdf) PRINT_QUESTIONS_PDF_2UP:=$(PRINT_QUESTIONS_TEX:.tex=-2up.pdf) PRINT_ANSWERS_PDF_2UP:=$(PRINT_ANSWERS_TEX:.tex=-2up.pdf) else WEB_HTML:=$(SOURCE_XML:.xml=.html) PRINT_TEX:=$(SOURCE_XML:.xml=.tex) PRINT_PDF_1UP:=$(SOURCE_XML:.xml=.pdf) PRINT_PDF_2UP:=$(SOURCE_XML:.xml=-2up.pdf) endif # # List of XSL stylesheets. If any of these change, we need to rebuild # everything. # # We can't use the resolver approach under Windows because of the DOS # pathnames. The style sheets come out of the resolver with paths like # C:\bar\foo\..., and make interprets the colon as an extra dependency # delimiter (tested and behaviour verified). Of course, this works fine on # any platform with sensible path standards. Quoting the value doesn't # help, unfortunately. Bugger :( # #XSLT_STYLESHEETS:=$(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2html.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2html.xsl' ) | $(CUT) -d':' -f3-) $(shell $(JAVA) org.apache.xml.resolver.apps.resolver -u file:///xml2latex.xsl uri | ( $(GREP) 'Result: file:' || $(ECHO) '::xml2latex.xsl' ) | $(CUT) -d':' -f3-) XSLT_STYLESHEETS:=$(TEACHING_SHARED)/Authoring/XML/xml2html.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xhtml.xsl $(TEACHING_SHARED)/Authoring/XML/xml2latex.xsl $(TEACHING_SHARED)/Authoring/XML/xml2xelatex.xsl ################################################################################ # # Add standard file suffixes. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_suffixes.make ################################################################################ # # Standard directories. # IMGDIR=images ################################################################################ # # Standard paths. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_paths.make ################################################################################ # # Files to be installed on web server. # ifdef HAS_ANSWERS QUESTION_INSTALL_FILES:=$(WEB_QUESTIONS_HTML) $(PRINT_QUESTIONS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) ANSWER_INSTALL_FILES:=$(WEB_ANSWERS_HTML) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_ANSWERS_PDF_2UP) else INSTALL_FILES:=$(WEB_HTML) $(PRINT_PDF_1UP) $(PRINT_PDF_2UP) endif ################################################################################ # # Files to be cleaned by the various "clean" targets. Note that we don't # "tidy" .aux files because they may be needed by the xr package for inter- # document cross references, but won't get regenerated if the final target # PDF files exist. They will be caught by by the "clean" target though. # TIDY_FILES+=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi *-derived.xml CLEAN_FILES+=*.aux $(IMGDIR)/*-print.pdf $(IMGDIR)/*-print.png \ $(IMGDIR)/*-web.png $(IMGDIR)/*-web-zoom.png ifdef HAS_ANSWERS TIDY_FILES+=$(PRINT_QUESTIONS_TEX) $(PRINT_ANSWERS_TEX) CLEAN_FILES+=$(WEB_QUESTIONS_HTML) $(WEB_ANSWERS_HTML) \ $(PRINT_QUESTIONS_PDF_1UP) $(PRINT_ANSWERS_PDF_1UP) \ $(PRINT_QUESTIONS_PDF_2UP) $(PRINT_ANSWERS_PDF_2UP) else TIDY_FILES+=$(PRINT_TEX) CLEAN_FILES+=$(WEB_HTML) $(PRINT_PDF_1UP) $(PRINT_PDF_2UP) endif ################################################################################ # # Various environment variables. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_environment.make # # List of standard "phony" build targets. Varies depending on whether # answers are enabled. # TARGETS+=web print $(BASE_NAMES) ifdef HAS_ANSWERS TARGETS+=web-questions web-answers \ print-questions print-answers \ questions answers endif # .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions or answers only. # ifdef HAS_ANSWERS questions: web-questions print-questions answers: web-answers print-answers endif ################################################################################ # # Build web version only. # ifdef HAS_ANSWERS web: web-questions web-answers web-questions: $(WEB_QUESTIONS_HTML) $(WEB_IMAGES) $(WEB_FILES) $(WEB_QUESTIONS_HTML): %-questions.html: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xhtml.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ else $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ endif web-answers: $(WEB_ANSWERS_HTML) $(WEB_IMAGES) $(WEB_FILES) $(WEB_ANSWERS_HTML): %-answers.html: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xhtml.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ else $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'png')) > $@ endif else web: $(WEB_HTML) $(WEB_IMAGES) $(WEB_FILES) endif ################################################################################ # # Build print version only. # ifdef HAS_ANSWERS print: print-questions print-answers print-questions: $(PRINT_QUESTIONS_PDF_1UP) $(PRINT_QUESTIONS_PDF_2UP) $(PRINT_QUESTIONS_PDF_1UP): $(PRINT_IMAGES) $(PRINT_FILES) $(PRINT_QUESTIONS_TEX): %-questions.tex: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xelatex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ else $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ endif print-answers: $(PRINT_ANSWERS_PDF_1UP) $(PRINT_ANSWERS_PDF_2UP) $(PRINT_ANSWERS_PDF_1UP): $(PRINT_IMAGES) $(PRINT_FILES) $(PRINT_ANSWERS_TEX): %-answers.tex: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xelatex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ else $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)'),$(call xslt_parameter,standalone,'yes'),$(call xslt_parameter,showanswers,'yes'),$(call xslt_parameter,base-path,'.'),$(call xslt_parameter,image-format,'pdf')) > $@ endif else print: $(PRINT_PDF_1UP) $(PRINT_PDF_2UP) $(PRINT_PDF_1UP): $(PRINT_IMAGES) $(PRINT_FILES) endif ################################################################################ # # Generate the derived XML source from the original XML template. # This is done by simply running the original source through xmllint # with the --xinclude option to process all the xi:include elements. # The result of this could have just been piped into the XSLT processor, # except that (a) not all of the processors support input from stdin, # and (b) combining both xmllint and XSLT processing into one command # means that make won't stop if there's any errors from xmllint. # # Sed is used to add a comment to the derived XML file, warning that this # is generated and shouldn't be edited. Sed was used because the <?xml?> # processing instruction MUST be on the first line. The implication here # is that all input source files have an <?xml?> processing instruction # (which they should anyway). # $(DERIVED_XML): %-derived.xml: %.xml $(XSLT_STYLESHEETS) $(XMLLINT) --xinclude $< >$@ @$(SED) -i -e '1a <!-- THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT! -->' $@ ################################################################################ # # Build the test document. # test: test.pdf test.pdf: test.tex ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # See build_document_rules.make for an explanation of why the install # uses a foreach. # # Note that this won't do anything clever if you give it files that are # in subdirectories of the current directory. Everything will be flattened # at the other end. That is, something like "images/foo.pdf" will go into # the installation directory as "foo.pdf", not "images/foo.pdf". # install: all @$(SITECOPY) --update --keep-going Blackboard$(PAPER_NUMBER) @$(SITECOPY) --catchup Blackboard$(PAPER_NUMBER) @$(ANNOUNCE) "Deploying files into $(INSTALL_DIRECTORY)" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @if $(TEST) -n "$(WEB_IMAGES)"; then $(MKDIR_P) $(INSTALL_DIRECTORY)/$(IMGDIR); fi ifdef HAS_ANSWERS @$(foreach f,$(QUESTION_INSTALL_FILES) $(ANSWER_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) else @$(foreach f,$(INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) endif @$(foreach f,$(WEB_IMAGES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(IMGDIR)/$(f) -o $(IMGDIR)/$(f) -nt $(INSTALL_DIRECTORY)/$(IMGDIR)/$(f); then $(ECHO) "Deploying $(IMGDIR)/$(f)"; $(CP) $(IMGDIR)/$(f) $(INSTALL_DIRECTORY)/$(IMGDIR); fi;) @$(ANNOUNCE) "Synchronising with Blackboard" @$(SITECOPY) --update Blackboard$(PAPER_NUMBER) ################################################################################ # # Debugging: print the values of the standard variables. # debug: @announce Externally defined variables @echo "TEACHING_SHARED = [$(TEACHING_SHARED)]" @announce Internally defined variables @echo "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @echo "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @echo "BUILD_DIR = [$(BUILD_DIR)]" @echo "BASE_NAMES = [$(BASE_NAMES)]" @echo "SOURCE_XML = [$(SOURCE_XML)]" @echo "DERIVED_XML = [$(DERIVED_XML)]" @echo "SUBJECT_CODE = [$(SUBJECT_CODE)]" @echo "PAPER_NUMBER = [$(PAPER_NUMBER)]" @echo "HAS_ANSWERS = [$(HAS_ANSWERS)]" ifdef HAS_ANSWERS @echo "WEB_QUESTIONS_HTML = [$(WEB_QUESTIONS_HTML)]" @echo "WEB_ANSWERS_HTML = [$(WEB_ANSWERS_HTML)]" @echo "PRINT_QUESTIONS_TEX = [$(PRINT_QUESTIONS_TEX)]" @echo "PRINT_ANSWERS_TEX = [$(PRINT_ANSWERS_TEX)]" @echo "PRINT_QUESTIONS_PDF_1UP = [$(PRINT_QUESTIONS_PDF_1UP)]" @echo "PRINT_ANSWERS_PDF_1UP = [$(PRINT_ANSWERS_PDF_1UP)]" @echo "PRINT_QUESTIONS_PDF_2UP = [$(PRINT_QUESTIONS_PDF_2UP)]" @echo "PRINT_ANSWERS_PDF_2UP = [$(PRINT_ANSWERS_PDF_2UP)]" @echo "QUESTION_INSTALL_FILES = [$(QUESTION_INSTALL_FILES)]" @echo "ANSWER_INSTALL_FILES = [$(ANSWER_INSTALL_FILES)]" else @echo "WEB_HTML = [$(WEB_HTML)]" @echo "PRINT_TEX = [$(PRINT_TEX)]" @echo "PRINT_PDF_1UP = [$(PRINT_PDF_1UP)]" @echo "PRINT_PDF_2UP = [$(PRINT_PDF_2UP)]" @echo "INSTALL_FILES = [$(INSTALL_FILES)]" endif @echo "XSLT_STYLESHEETS = [$(XSLT_STYLESHEETS)]" @echo "PRINT_IMAGES = [$(PRINT_IMAGES)]" @echo "PRINT_FILES = [$(PRINT_FILES)]" @echo "WEB_IMAGES = [$(WEB_IMAGES)]" @echo "WEB_FILES = [$(WEB_FILES)]" @echo "TIDY_FILES = [$(TIDY_FILES)]" @echo "CLEAN_FILES = [$(CLEAN_FILES)]" @echo "DRAFT = [$(DRAFT)]" @echo "LATEX_OPTS = [$(LATEX_OPTS)]" @echo "TARGETS = [$(TARGETS)]" ################################################################################ # # Clean up: get rid of all the temporary files. # tidy: $(RM) -f $(TIDY_FILES) # # Clean up: get rid of everything except the original source. # clean: tidy $(RM) -f $(CLEAN_FILES) ################################################################################ # # List all "phony" build targets. # targets: @echo "targets: $(TARGETS)" ################################################################################ # # Standard default rules. # include $(GLOBAL_HANDBOOK_INCLUDE)/standard_rules.make

Ignore Space Show notes View make-includes/build_section_rules.make

################################################################################ # # Standard variables and rules for building a particular section of the # handbook. Altering these definitions will affect ALL SECTION MAKEFILES # FOR ALL PAPERS!! If you need to do something specific for a particular # paper, include a custom rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Run one-time initialisation stuff, _unless_ NOINIT is defined. Any # "parent" makefile that's already done the same one-time initialisation # and calls this one should define NOINIT (the value doesn't matter) to # switch off one-time initialisation in this makefile. Thus if the # "parent" makefile calls this makefile several times, things like the # content checking will only happen once for a single invocation of the # "parent" makefile. # # When running this makefile standalone, _don't_ define NOINIT, and # everything will still work as expected. # ifndef NOINIT include $(GLOBAL_HANDBOOK_INCLUDE)/remove_content_marker_files.make # # Ensure that the patterns files exist. If they don't, copy the originals # across from the shared directory and abort the run so that the user can # edit them appropriately. # CHECK_ANSWERS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/answers.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "answers")) CHECK_QUESTIONS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/questions.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "questions")) CHECK_INSTALL_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/install.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/install.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "install")) CHECK_ALL_PATTERNS:=$(CHECK_ANSWERS_PATTERNS) $(CHECK_QUESTIONS_PATTERNS) $(CHECK_INSTALL_PATTERNS) ifneq "$(strip $(CHECK_ALL_PATTERNS))" "" $(error Patterns files have been restored from defaults ($(CHECK_ALL_PATTERNS)), please check them before continuing) endif endif # Now that the one-time initialsation is out of the way, ensure that # NOINIT (the value doesn't matter) is exported to all sub-makefiles to # prevent them from repeating the one-time initialisation. This prevents # the situation where we go "make" and content checking happens twice, # once for the web version and once for the print version. (Although I'm # not sure why it only happens twice --- I would have expected four times. # Go figure.) # export NOINIT?=x ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Include variables defining the current paper. # include $(LOCAL_HANDBOOK_INCLUDE)/paper_variables.make ################################################################################ # # Defines which section we are currently building. This is actually the # path to the main folder for the section. Normally this is exported from # a higher-level makefile (i.e., "export SECTION=path/to/section"). # export SECTION?=$(notdir $(CURDIR)) ################################################################################ # # Define patterns for required source files. We define the basic variables # first (empty), then scan the make-includes directory for patterns files. # Each patterns file should add its patterns (using +=) to the appropriate # pattern variable from the following. # # QUESTIONS_PATTERNS defines the patterns for the "questions" version of # the handbook (both web and print). # QUESTIONS_PATTERNS:= # # ANSWERS_PATTERNS defines the patterns for the "answers" version of # the handbook (both web and print). # ANSWERS_PATTERNS:= # # *_INSTALL_PATTERNS defines the patterns for installing on the web server. # QUESTION_INSTALL_PATTERNS:= ANSWER_INSTALL_PATTERNS:= # # Now go looking for patterns files in the local make-includes directory. # files should be named "*.patterns" # include $(LOCAL_HANDBOOK_INCLUDE)/*.patterns ################################################################################ # # Define lists of source directories that contain documents to be included # in the handbook. These are generated according to the values of the # patterns defined in the various pattern include files. # # Note that all the find commands are relative to the working directory of # the makefile that includes this file. Thus, if we are in the Tutorials # directory, all finds will be relative to this (and thus the lab patterns # won't find anything). The main consequence of this is that the # CLEAN_DIRS find will only generate a list of the directories that can be # cleaned _for the current section_. In practice, however, this will still # work as expected; if we're cleaning just that section, this is what we # want anyway, and if we're cleaning the entire handbook, the master # handbook makefile will call the makefile for each section separately. # ################################################################################ # # Directories for the complete collection of documents to be built for the # "questions" and "answers" versions of the handbook, respectively. Since # the tutorials variables will be empty when we're in the labs directory, # and vice versa, everything just works! # QUESTION_SRC_DIRS:=$(foreach p,$(QUESTIONS_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) ANSWER_SRC_DIRS:=$(foreach p,$(ANSWERS_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) QUESTION_INSTALL_DIRS:=$(foreach p,$(QUESTION_INSTALL_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) ANSWER_INSTALL_DIRS:=$(foreach p,$(ANSWER_INSTALL_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) # # List of directories that can be cleaned. "-mindepth 2" ensures # that we only include sub-directories of the current directory. # CLEAN_DIRS:=$(dir $(shell $(FIND) . -mindepth 2 -name Makefile)) ################################################################################ # # Define lists of LaTeX source files. These will be written out to the # appropriate manifest file, so that the master handbook makefile can # import them into the handbook LaTeX build. Only the files specified by # the file patterns are included. The manifest file is also only updated # when necessary, i.e., when the list of files changes. # QUESTION_TEX_SOURCE:=$(foreach d,$(QUESTION_SRC_DIRS),$d/$d-questions.tex) ANSWER_TEX_SOURCE:=$(foreach d,$(ANSWER_SRC_DIRS),$d/$d-answers.tex) QUESTION_TEX_INPUTS:=$(foreach f,$(QUESTION_TEX_SOURCE),\\input{sections/$(SECTION)/$(basename $f)}) ANSWER_TEX_INPUTS:=$(foreach f,$(ANSWER_TEX_SOURCE),\\input{sections/$(SECTION)/$(basename $f)}) ################################################################################ # # Directory to install files into on web server. # INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/$(SECTION) ################################################################################ # # Files to be installed on web server. # INSTALL_FILES:= ################################################################################ # # Lists of files for cleaning up. Add to these (using +=) as necessary in # derived makefiles. # WEB_CLEAN_FILES:= PRINT_CLEAN_FILES:=*-manifest.tex ALL_CLEAN_FILES:=$(WEB_CLEAN_FILES) $(PRINT_CLEAN_FILES) ################################################################################ # # List of possible targets. If you need to add to this for a specific # case, use TARGETS+=xxx in the actual makefile. # TARGETS:=all targets debug install \ web web-questions web-answers \ print print-questions print-answers \ questions answers \ print-question-docs print-answer-docs \ clean web-clean print-clean .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions or answers only. # questions: web-questions print-questions answers: web-answers print-answers ################################################################################ # # Build web version only. # # Note the weird dance with the ifs in the recursive make calls. If we # don't do this, the foreach just keeps going even if one of the sub-makes # dies. We therefore have to do our own error detection and dying. Bummer. # web: web-questions web-answers web-questions: @$(foreach d,$(QUESTION_SRC_DIRS),if $(MAKE) -C $d web-questions; then $(TRUE); else exit 1; fi;) web-answers: @$(foreach d,$(ANSWER_SRC_DIRS),if $(MAKE) -C $d web-answers; then $(TRUE); else exit 1; fi;) ################################################################################ # # Build print version only. We also need to build the manifest files that # will be \input into the master handbook.tex document. # print: print-questions print-answers print-questions: print-question-docs question-manifest.tex print-question-docs: @$(foreach d,$(QUESTION_SRC_DIRS),if $(MAKE) -C $d print-questions; then $(TRUE); else exit 1; fi;) question-manifest.tex: $(QUESTION_TEX_SOURCE) $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns @$(ANNOUNCE) "Generating questions version manifest file in $(SECTION)" @$(ECHO) $(QUESTION_TEX_INPUTS) > $@ question-pdfs: @$(foreach d,$(QUESTION_SRC_DIRS),if $(MAKE) -C $d $d-questions.pdf $d-questions-2up.pdf; then $(TRUE); else exit 1; fi;) print-answers: print-answer-docs answer-manifest.tex print-answer-docs: @$(foreach d,$(ANSWER_SRC_DIRS),if $(MAKE) -C $d print-answers; then $(TRUE); else exit 1; fi;) answer-manifest.tex: $(ANSWER_TEX_SOURCE) $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns @$(ANNOUNCE) "Generating answers version manifest file in $(SECTION)" @$(ECHO) $(ANSWER_TEX_INPUTS) > $@ answer-pdfs: @$(foreach d,$(ANSWER_SRC_DIRS),if $(MAKE) -C $d $d-answers.pdf $d-answers-2up.pdf; then $(TRUE); else exit 1; fi;) ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # Most of the work is carried out by recursive make calls to the # subordinate document makefiles. Files that are generic to the entire # section are dealt with here, though. Each file in the build directory is # checked against the corresponding file in the deployment directory. The # local file is only copied to the install directory if it is newer, or # the remote file doesn't exist. # # See build_document_rules.make for an explanation of why it's implemented # using a foreach. # install: questions answers @$(ANNOUNCE) "Deploying files from $(SECTION) into $(INSTALL_DIRECTORY)" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach d,$(QUESTION_INSTALL_DIRS),if $(MAKE) -C $d install-questions; then $(TRUE); else exit 1; fi;) @$(foreach d,$(ANSWER_INSTALL_DIRS),if $(MAKE) -C $d install-answers; then $(TRUE); else exit 1; fi;) @$(foreach f,$(INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) ################################################################################ # # Clean up all generated files. # "web-clean" and "print-clean" only clean up files for the web and print # versions, respectively. Note that "clean" isn't dependent on either # "web-clean" or "print-clean", to ensure that the correct target is # used when calling the sub-makefile. # clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(ALL_CLEAN_FILES)),) -$(RM) -f $(ALL_CLEAN_FILES) endif web-clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(WEB_CLEAN_FILES)),) -$(RM) -f $(WEB_CLEAN_FILES) endif print-clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(PRINT_CLEAN_FILES)),) -$(RM) -f $(PRINT_CLEAN_FILES) endif # # "init-clean" is a dummy target that can be used to ensure that the # content-checked marker files get deleted. Do a "make -C xxx" (i.e., # don't define NOINIT). The actual deletion is done by the one-time # initialisation in remove_content_marker_files.make. Note that there's no # point in this rule printing anything, because the output will probably # end up buried in a one-time initialisation "variable". # init-clean: ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ECHO) "NOINIT = [$(NOINIT)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @$(ECHO) "QUESTIONS_PATTERNS = [$(QUESTIONS_PATTERNS)]" @$(ECHO) "ANSWERS_PATTERNS = [$(ANSWERS_PATTERNS)]" @$(ECHO) "QUESTION_INSTALL_PATTERNS = [$(QUESTION_INSTALL_PATTERNS)]" @$(ECHO) "ANSWER_INSTALL_PATTERNS = [$(ANSWER_INSTALL_PATTERNS)]" @$(ECHO) "SECTION = [$(SECTION)]" @$(ECHO) "QUESTION_SRC_DIRS = [$(QUESTION_SRC_DIRS)]" @$(ECHO) "ANSWER_SRC_DIRS = [$(ANSWER_SRC_DIRS)]" @$(ECHO) "QUESTION_INSTALL_DIRS = [$(QUESTION_INSTALL_DIRS)]" @$(ECHO) "ANSWER_INSTALL_DIRS = [$(ANSWER_INSTALL_DIRS)]" @$(ECHO) "CLEAN_DIRS = [$(CLEAN_DIRS)]" @$(ECHO) "QUESTION_TEX_SOURCE = [$(QUESTION_TEX_SOURCE)]" @$(ECHO) "ANSWER_TEX_SOURCE = [$(ANSWER_TEX_SOURCE)]" @$(ECHO) "QUESTION_TEX_INPUTS = [$(QUESTION_TEX_INPUTS)]" @$(ECHO) "ANSWER_TEX_INPUTS = [$(ANSWER_TEX_INPUTS)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "INSTALL_FILES = [$(INSTALL_FILES)]" @$(ECHO) "WEB_CLEAN_FILES = [$(WEB_CLEAN_FILES)]" @$(ECHO) "PRINT_CLEAN_FILES = [$(PRINT_CLEAN_FILES)]" @$(ECHO) "ALL_CLEAN_FILES = [$(ALL_CLEAN_FILES)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS) ################################################################################ # # File: $Id$ # # Standard variables and rules for building a particular section of the # handbook. Altering these definitions will affect ALL SECTION MAKEFILES # FOR ALL PAPERS!! If you need to do something specific for a particular # paper, include a custom rule in its makefile. DON'T add it here! # ################################################################################ ################################################################################ # # Run one-time initialisation stuff, _unless_ NOINIT is defined. Any # "parent" makefile that's already done the same one-time initialisation # and calls this one should define NOINIT (the value doesn't matter) to # switch off one-time initialisation in this makefile. Thus if the # "parent" makefile calls this makefile several times, things like the # content checking will only happen once for a single invocation of the # "parent" makefile. # # When running this makefile standalone, _don't_ define NOINIT, and # everything will still work as expected. # ifndef NOINIT include $(GLOBAL_HANDBOOK_INCLUDE)/remove_content_marker_files.make # # Ensure that the patterns files exist. If they don't, copy the originals # across from the shared directory and abort the run so that the user can # edit them appropriately. # CHECK_ANSWERS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/answers.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "answers")) CHECK_QUESTIONS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/questions.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "questions")) CHECK_INSTALL_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/install.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/install.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "install")) CHECK_ALL_PATTERNS:=$(CHECK_ANSWERS_PATTERNS) $(CHECK_QUESTIONS_PATTERNS) $(CHECK_INSTALL_PATTERNS) ifneq "$(strip $(CHECK_ALL_PATTERNS))" "" $(error Patterns files have been restored from defaults ($(CHECK_ALL_PATTERNS)), please check them before continuing) endif endif # Now that the one-time initialsation is out of the way, ensure that # NOINIT (the value doesn't matter) is exported to all sub-makefiles to # prevent them from repeating the one-time initialisation. This prevents # the situation where we go "make" and content checking happens twice, # once for the web version and once for the print version. (Although I'm # not sure why it only happens twice --- I would have expected four times. # Go figure.) # export NOINIT?=x ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Include variables defining the current paper. # include $(LOCAL_HANDBOOK_INCLUDE)/paper_variables.make ################################################################################ # # Defines which section we are currently building. This is actually the # path to the main folder for the section. Normally this is exported from # a higher-level makefile (i.e., "export SECTION=path/to/section"). # export SECTION?=$(notdir $(CURDIR)) ################################################################################ # # Define patterns for required source files. We define the basic variables # first (empty), then scan the make-includes directory for patterns files. # Each patterns file should add its patterns (using +=) to the appropriate # pattern variable from the following. # # QUESTIONS_PATTERNS defines the patterns for the "questions" version of # the handbook (both web and print). # QUESTIONS_PATTERNS:= # # ANSWERS_PATTERNS defines the patterns for the "answers" version of # the handbook (both web and print). # ANSWERS_PATTERNS:= # # *_INSTALL_PATTERNS defines the patterns for installing on the web server. # QUESTION_INSTALL_PATTERNS:= ANSWER_INSTALL_PATTERNS:= # # Now go looking for patterns files in the local make-includes directory. # files should be named "*.patterns" # include $(LOCAL_HANDBOOK_INCLUDE)/*.patterns ################################################################################ # # Define lists of source directories that contain documents to be included # in the handbook. These are generated according to the values of the # patterns defined in the various pattern include files. # # Note that all the find commands are relative to the working directory of # the makefile that includes this file. Thus, if we are in the Tutorials # directory, all finds will be relative to this (and thus the lab patterns # won't find anything). The main consequence of this is that the # CLEAN_DIRS find will only generate a list of the directories that can be # cleaned _for the current section_. In practice, however, this will still # work as expected; if we're cleaning just that section, this is what we # want anyway, and if we're cleaning the entire handbook, the master # handbook makefile will call the makefile for each section separately. # ################################################################################ # # Directories for the complete collection of documents to be built for the # "questions" and "answers" versions of the handbook, respectively. Since # the tutorials variables will be empty when we're in the labs directory, # and vice versa, everything just works! # QUESTION_SRC_DIRS:=$(foreach p,$(QUESTIONS_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) ANSWER_SRC_DIRS:=$(foreach p,$(ANSWERS_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) QUESTION_INSTALL_DIRS:=$(foreach p,$(QUESTION_INSTALL_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) ANSWER_INSTALL_DIRS:=$(foreach p,$(ANSWER_INSTALL_PATTERNS),$(notdir $(shell $(FIND) . -regex '.*/'$(p) | sort))) # # List of directories that can be cleaned. "-mindepth 2" ensures # that we only include sub-directories of the current directory. # CLEAN_DIRS:=$(dir $(shell $(FIND) . -mindepth 2 -name Makefile)) ################################################################################ # # Define lists of LaTeX source files. These will be written out to the # appropriate manifest file, so that the master handbook makefile can # import them into the handbook LaTeX build. Only the files specified by # the file patterns are included. The manifest file is also only updated # when necessary, i.e., when the list of files changes. # QUESTION_TEX_SOURCE:=$(foreach d,$(QUESTION_SRC_DIRS),$d/$d-questions.tex) ANSWER_TEX_SOURCE:=$(foreach d,$(ANSWER_SRC_DIRS),$d/$d-answers.tex) QUESTION_TEX_INPUTS:=$(foreach f,$(QUESTION_TEX_SOURCE),\\input{sections/$(SECTION)/$(basename $f)}) ANSWER_TEX_INPUTS:=$(foreach f,$(ANSWER_TEX_SOURCE),\\input{sections/$(SECTION)/$(basename $f)}) ################################################################################ # # Directory to install files into on web server. # INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/$(SECTION) ################################################################################ # # Files to be installed on web server. # INSTALL_FILES:= ################################################################################ # # Lists of files for cleaning up. Add to these (using +=) as necessary in # derived makefiles. # WEB_CLEAN_FILES:= PRINT_CLEAN_FILES:=*-manifest.tex ALL_CLEAN_FILES:=$(WEB_CLEAN_FILES) $(PRINT_CLEAN_FILES) ################################################################################ # # List of possible targets. If you need to add to this for a specific # case, use TARGETS+=xxx in the actual makefile. # TARGETS:=all targets debug install \ web web-questions web-answers \ print print-questions print-answers \ questions answers \ print-question-docs print-answer-docs \ clean web-clean print-clean .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions or answers only. # questions: web-questions print-questions answers: web-answers print-answers ################################################################################ # # Build web version only. # # Note the weird dance with the ifs in the recursive make calls. If we # don't do this, the foreach just keeps going even if one of the sub-makes # dies. We therefore have to do our own error detection and dying. Bummer. # web: web-questions web-answers web-questions: @$(foreach d,$(QUESTION_SRC_DIRS),if $(MAKE) -C $d web-questions; then $(TRUE); else exit 1; fi;) web-answers: @$(foreach d,$(ANSWER_SRC_DIRS),if $(MAKE) -C $d web-answers; then $(TRUE); else exit 1; fi;) ################################################################################ # # Build print version only. We also need to build the manifest files that # will be \input into the master handbook.tex document. # print: print-questions print-answers print-questions: print-question-docs question-manifest.tex print-question-docs: @$(foreach d,$(QUESTION_SRC_DIRS),if $(MAKE) -C $d print-questions; then $(TRUE); else exit 1; fi;) question-manifest.tex: $(QUESTION_TEX_SOURCE) $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns @$(ANNOUNCE) "Generating questions version manifest file in $(SECTION)" @$(ECHO) $(QUESTION_TEX_INPUTS) > $@ question-pdfs: @$(foreach d,$(QUESTION_SRC_DIRS),if $(MAKE) -C $d $d-questions.pdf $d-questions-2up.pdf; then $(TRUE); else exit 1; fi;) print-answers: print-answer-docs answer-manifest.tex print-answer-docs: @$(foreach d,$(ANSWER_SRC_DIRS),if $(MAKE) -C $d print-answers; then $(TRUE); else exit 1; fi;) answer-manifest.tex: $(ANSWER_TEX_SOURCE) $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns @$(ANNOUNCE) "Generating answers version manifest file in $(SECTION)" @$(ECHO) $(ANSWER_TEX_INPUTS) > $@ answer-pdfs: @$(foreach d,$(ANSWER_SRC_DIRS),if $(MAKE) -C $d $d-answers.pdf $d-answers-2up.pdf; then $(TRUE); else exit 1; fi;) ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # Most of the work is carried out by recursive make calls to the # subordinate document makefiles. Files that are generic to the entire # section are dealt with here, though. Each file in the build directory is # checked against the corresponding file in the deployment directory. The # local file is only copied to the install directory if it is newer, or # the remote file doesn't exist. # # See build_document_rules.make for an explanation of why it's implemented # using a foreach. # install: questions answers @$(ANNOUNCE) "Deploying files from $(SECTION) into $(INSTALL_DIRECTORY)" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach d,$(QUESTION_INSTALL_DIRS),if $(MAKE) -C $d install-questions; then $(TRUE); else exit 1; fi;) @$(foreach d,$(ANSWER_INSTALL_DIRS),if $(MAKE) -C $d install-answers; then $(TRUE); else exit 1; fi;) @$(foreach f,$(INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) ################################################################################ # # Clean up all generated files. # "web-clean" and "print-clean" only clean up files for the web and print # versions, respectively. Note that "clean" isn't dependent on either # "web-clean" or "print-clean", to ensure that the correct target is # used when calling the sub-makefile. # clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(ALL_CLEAN_FILES)),) -$(RM) -f $(ALL_CLEAN_FILES) endif web-clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(WEB_CLEAN_FILES)),) -$(RM) -f $(WEB_CLEAN_FILES) endif print-clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(PRINT_CLEAN_FILES)),) -$(RM) -f $(PRINT_CLEAN_FILES) endif # # "init-clean" is a dummy target that can be used to ensure that the # content-checked marker files get deleted. Do a "make -C xxx" (i.e., # don't define NOINIT). The actual deletion is done by the one-time # initialisation in remove_content_marker_files.make. Note that there's no # point in this rule printing anything, because the output will probably # end up buried in a one-time initialisation "variable". # init-clean: ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ECHO) "NOINIT = [$(NOINIT)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @$(ECHO) "QUESTIONS_PATTERNS = [$(QUESTIONS_PATTERNS)]" @$(ECHO) "ANSWERS_PATTERNS = [$(ANSWERS_PATTERNS)]" @$(ECHO) "QUESTION_INSTALL_PATTERNS = [$(QUESTION_INSTALL_PATTERNS)]" @$(ECHO) "ANSWER_INSTALL_PATTERNS = [$(ANSWER_INSTALL_PATTERNS)]" @$(ECHO) "SECTION = [$(SECTION)]" @$(ECHO) "QUESTION_SRC_DIRS = [$(QUESTION_SRC_DIRS)]" @$(ECHO) "ANSWER_SRC_DIRS = [$(ANSWER_SRC_DIRS)]" @$(ECHO) "QUESTION_INSTALL_DIRS = [$(QUESTION_INSTALL_DIRS)]" @$(ECHO) "ANSWER_INSTALL_DIRS = [$(ANSWER_INSTALL_DIRS)]" @$(ECHO) "CLEAN_DIRS = [$(CLEAN_DIRS)]" @$(ECHO) "QUESTION_TEX_SOURCE = [$(QUESTION_TEX_SOURCE)]" @$(ECHO) "ANSWER_TEX_SOURCE = [$(ANSWER_TEX_SOURCE)]" @$(ECHO) "QUESTION_TEX_INPUTS = [$(QUESTION_TEX_INPUTS)]" @$(ECHO) "ANSWER_TEX_INPUTS = [$(ANSWER_TEX_INPUTS)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "INSTALL_FILES = [$(INSTALL_FILES)]" @$(ECHO) "WEB_CLEAN_FILES = [$(WEB_CLEAN_FILES)]" @$(ECHO) "PRINT_CLEAN_FILES = [$(PRINT_CLEAN_FILES)]" @$(ECHO) "ALL_CLEAN_FILES = [$(ALL_CLEAN_FILES)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS)

Ignore Space Show notes View make-includes/local_configuration.make.in

################################################################################ # # @configure_input@ # # This file sets up items that are system dependent (mostly paths to various) # tools, so it must always be loaded FIRST, before any other make includes! In # particular, it MUST be loaded before files that assume its existence, such # as standard_rules.make. # ################################################################################ # File system. MKDIR_P=@MKDIR_P@ MV=@MV@ CP=@CP@ RM=@RM@ TOUCH=@TOUCH@ LN_S=@LN_S@ # Searching. GREP=@GREP@ FIND=@FIND@ # Tests. TEST=@TEST_PROGRAM@ TRUE=@TRUE@ FALSE=@FALSE@ # Output. ECHO=@ECHO@ CAT=@CAT@ ANNOUNCE=@ANNOUNCE@ # Miscellaneous. SED=@SED@ CUT=@CUT@ PERL=@PERL@ DATE=@DATE@ EXPR=@EXPR@ BASENAME=@BASENAME@ JAVA=@JAVA@ MAKE=@MAKE@ # LaTeX and friends. LATEX=@latex@ PDFLATEX=@pdflatex@ XELATEX=@xelatex@ DVIPS=@dvips@ # XML manipulation. XMLLINT=@XMLLINT@ # Note: XSLTPROC is distinct from the XSLT environment variable. # We may not even use this directly, as the command-line arguments are # different for each processor anyway, which means that the current # approach of parameterised make functions is better in general. XSLTPROC=@XSLTPROC@ RESOLVER=@RESOLVER@ # Image manipulation and conversion (includes PDF & PS). CONVERT=@CONVERT@ COMPOSITE=@COMPOSITE@ PDFNUP=@PDFNUP@ PDFCROP=@PDFCROP@ PS2EPS=@PS2EPS@ PS2PDF=@PS2PDF@ SHIFTBBOX=@SHIFTBBOX@ EPSTOPDF=@EPSTOPDF@ INKSCAPE=@INKSCAPE@ GS=@GS@ XCF2PNG=@XCF2PNG@ # Plotting tools. PLOTICUS=@PLOTICUS@ R=@R@ # Web site synchronisation. SITECOPY=@SITECOPY@ # CSS development. SASS=@SASS@ ################################################################################ # # $Id$ # # @configure_input@ # # This file sets up items that are system dependent (mostly paths to various) # tools, so it must always be loaded FIRST, before any other make includes! In # particular, it MUST be loaded before files that assume its existence, such # as standard_rules.make. # ################################################################################ # File system. MKDIR_P=@MKDIR_P@ MV=@MV@ CP=@CP@ RM=@RM@ TOUCH=@TOUCH@ LN_S=@LN_S@ # Searching. GREP=@GREP@ FIND=@FIND@ # Tests. TEST=@TEST_PROGRAM@ TRUE=@TRUE@ FALSE=@FALSE@ # Output. ECHO=@ECHO@ CAT=@CAT@ ANNOUNCE=@ANNOUNCE@ # Miscellaneous. SED=@SED@ CUT=@CUT@ PERL=@PERL@ DATE=@DATE@ EXPR=@EXPR@ BASENAME=@BASENAME@ JAVA=@JAVA@ MAKE=@MAKE@ # LaTeX and friends. LATEX=@latex@ PDFLATEX=@pdflatex@ XELATEX=@xelatex@ DVIPS=@dvips@ # XML manipulation. XMLLINT=@XMLLINT@ # Note: XSLTPROC is distinct from the XSLT environment variable. # We may not even use this directly, as the command-line arguments are # different for each processor anyway, which means that the current # approach of parameterised make functions is better in general. XSLTPROC=@XSLTPROC@ RESOLVER=@RESOLVER@ # Image manipulation and conversion (includes PDF & PS). CONVERT=@CONVERT@ COMPOSITE=@COMPOSITE@ PDFNUP=@PDFNUP@ PDFCROP=@PDFCROP@ PS2EPS=@PS2EPS@ PS2PDF=@PS2PDF@ SHIFTBBOX=@SHIFTBBOX@ EPSTOPDF=@EPSTOPDF@ INKSCAPE=@INKSCAPE@ GS=@GS@ XCF2PNG=@XCF2PNG@ # Plotting tools. PLOTICUS=@PLOTICUS@ R=@R@ # Web site synchronisation. SITECOPY=@SITECOPY@ # CSS development. SASS=@SASS@

Ignore Space Show notes View make-includes/remove_content_marker_files.make

################################################################################ # # Remove all the marker files used to indicate that we've already checked # the content for a document. If we don't delete them, make won't check # the content again, so we need to delete them every time we make # something. # # This should be executed only once when a makefile is loaded. This is # achieved by the chicanery of assigning the result of a shell command # (using the shell function) to a variable. The variable only ever gets # defined once, and so the command only ever gets executed once. Voila! # The name of the variable is irrelevant, as it's never actually used for # anything else (or at least, it shouldn't be!). # # This applies equally whether we're making a complete section, or just a # single document. To avoid "double-deleting" when calling a sub-makefile # in a sub-directory, call the sub-makefile with the variable NOINIT # defined (the value doesn't matter), e.g., "$(MAKE) -C xxx NOINIT=x". # This isn't necessary if the sub-makefile is not in a sub-directory. # # The -type predicate is probably unnecessary, but it never hurts to be # paranoid... # ################################################################################ CLEANUP_MARKER_FILES:=$(shell $(FIND) . -type f -name content-checked -exec $(RM) -f {} \;) ################################################################################ # # File: $Id$ # # Remove all the marker files used to indicate that we've already checked # the content for a document. If we don't delete them, make won't check # the content again, so we need to delete them every time we make # something. # # This should be executed only once when a makefile is loaded. This is # achieved by the chicanery of assigning the result of a shell command # (using the shell function) to a variable. The variable only ever gets # defined once, and so the command only ever gets executed once. Voila! # The name of the variable is irrelevant, as it's never actually used for # anything else (or at least, it shouldn't be!). # # This applies equally whether we're making a complete section, or just a # single document. To avoid "double-deleting" when calling a sub-makefile # in a sub-directory, call the sub-makefile with the variable NOINIT # defined (the value doesn't matter), e.g., "$(MAKE) -C xxx NOINIT=x". # This isn't necessary if the sub-makefile is not in a sub-directory. # # The -type predicate is probably unnecessary, but it never hurts to be # paranoid... # ################################################################################ CLEANUP_MARKER_FILES:=$(shell $(FIND) . -type f -name content-checked -exec $(RM) -f {} \;)

Ignore Space Show notes View make-includes/standard_environment.make

################################################################################ # # Specify standard environmental variables. These can be either actual # shell environment variables, or make variables. # ################################################################################ ################################################################################ # # Various environment variables. # # Set DRAFT to anything to run in draft mode (e.g., make DRAFT=draft xxx). # DRAFT= # # Specify LaTeX document options (comma-separated list). # We need to add a comma if there is something there already! # ifdef LATEX_OPTS LATEX_OPTS+=, endif LATEX_OPTS+=pdftex,usepdftitle=false,$(DRAFT) # # List of standard "phony" build targets. # TARGETS+=all debug test clean tidy targets ################################################################################ # # File: $Id$ # # Specify standard environmental variables. These can be either actual # shell environment variables, or make variables. # ################################################################################ ################################################################################ # # Various environment variables. # # Set DRAFT to anything to run in draft mode (e.g., make DRAFT=draft xxx). # DRAFT= # # Specify LaTeX document options (comma-separated list). # We need to add a comma if there is something there already! # ifdef LATEX_OPTS LATEX_OPTS+=, endif LATEX_OPTS+=pdftex,usepdftitle=false,$(DRAFT) # # List of standard "phony" build targets. # TARGETS+=all debug test clean tidy targets

Ignore Space Show notes View make-includes/standard_paths.make

################################################################################ # # Specify standard file path list. # ################################################################################ ################################################################################ # # Required make variables. These should be defined by the calling makefile. # # IMGDIR # The path to the directory that contains images, e.g., "images". # IMGDIR?=$(error The required make variable IMGDIR has not been defined. Please set it to the directory in which images are located) ################################################################################ # # Standard paths. # vpath %.pdf $(IMGDIR) vpath %.png $(IMGDIR) vpath %.tif $(IMGDIR) vpath %.jpg $(IMGDIR) vpath %.plo $(IMGDIR) vpath %.ps $(IMGDIR) vpath %.eps $(IMGDIR) vpath %.svg $(IMGDIR) vpath %.pict $(IMGDIR) vpath %.xcf $(IMGDIR) vpath %.R $(IMGDIR) ################################################################################ # # File: $Id$ # # Specify standard file path list. # ################################################################################ ################################################################################ # # Required make variables. These should be defined by the calling makefile. # # IMGDIR # The path to the directory that contains images, e.g., "images". # IMGDIR?=$(error The required make variable IMGDIR has not been defined. Please set it to the directory in which images are located) ################################################################################ # # Standard paths. # vpath %.pdf $(IMGDIR) vpath %.png $(IMGDIR) vpath %.tif $(IMGDIR) vpath %.jpg $(IMGDIR) vpath %.plo $(IMGDIR) vpath %.ps $(IMGDIR) vpath %.eps $(IMGDIR) vpath %.svg $(IMGDIR) vpath %.pict $(IMGDIR) vpath %.xcf $(IMGDIR) vpath %.R $(IMGDIR)

Ignore Space Show notes View make-includes/standard_rules.make

################################################################################ # # Standard rules for a variety of situations. Includes standard suffixes and # paths. # # ################################################################################ ################################################################################ # # Required make variables. These should be defined by the calling makefile. # # PAPER_NUMBER # The paper number for the current paper, e.g., 212. # PAPER_NUMBER?=$(error The required make variable PAPER_NUMBER has not been defined. Please set it to the correct value) # # IMGDIR # The path to the directory that contains images, e.g., images. # IMGDIR?=$(error The required make variable IMGDIR has not been defined. Please set it to the directory in which images are located) ################################################################################ # # Default rules. # # # PDF from LaTeX via DVI, typically for images drawn using PSTricks). # %.pdf %-print.pdf: $(IMGDIR)/%.tex $(LATEX) --jobname=$(IMGDIR)/$* $< $(DVIPS) -q -f $(IMGDIR)/$* | $(PS2EPS) --quiet --loose | $(EPSTOPDF) --filter --outfile=$(IMGDIR)/$@ # # PDF from LaTeX. # %.pdf: %.tex ifdef UNICODE $(XELATEX) $< $(XELATEX) $< else $(PDFLATEX) $< $(PDFLATEX) $< endif # # 2-up PDF from 1-up PDF. # %-2up.pdf: %.pdf $(PDFNUP) $< --nup 2x1 --outfile $@ # # Derived XML with inclusions from source XML without inclusions. # # This is done by simply running the original source through xmllint # with the --xinclude option to process any xi:include elements. # The result of this could just be piped into the XSLT processor, # except that (a) not all of the processors support input from stdin, # and (b) combining both xmllint and XSLT processing into one command # means that make won't stop if there's any errors from xmllint. # # Sed is used to add a comment to the derived XML file, warning that this # is generated and shouldn't be edited. Sed was used because the <?xml?> # processing instruction MUST be on the first line. The implication here # is that all input source files have an <?xml?> processing instruction # (which they should anyway). # %-derived.xml: %.xml $(XMLLINT) --xinclude $< > $@ @$(SED) --in-place --expression='1a <!-- THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT! -->' $@ # # LaTeX from derived XML. # %.tex: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xelatex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ else $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ endif # # HTML from derived XML. # %.html: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xhtml.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ else $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ endif # # Image rules can be a bit messy, because the prerequisite might be in any one # of several different formats, but we want to apply the same commands anyway # (e.g., ImageMagick convert) to generate the target. It would be nice if we # could specify variable file types in a prerequisite of a pattern rule (e.g., # %-foo.png: %.png %.jpg %.tif), but unfortunately we can't :(. The solution is # to create a make function to refactor the commands, and then specify as many # rules as required depending on the number of file formats. We still end up # repeating the rule actions, but at least the guts of the action is coded only # once in the function. # # PNG from TIFF, JPEG, PICT (normal image) # Note: PNG prerequisites are dealt with further down. # convert_normal = $(CONVERT) "$(1)" "$(2)" %.png %-print.png %-web.png: %.tif $(call convert_normal,$<,$(IMGDIR)/$@) %.png %-print.png %-web.png: %.jpg $(call convert_normal,$<,$(IMGDIR)/$@) %.png %-print.png %-web.png: %.pict $(call convert_normal,$<,$(IMGDIR)/$@) # # PNG from PNG, TIFF, JPEG, PICT (slide background) # # We lighten these so that they don't overwhelm the text. Note that 15% is # too light for most data projectors, so let's try 33% and see what # happens... (this looks far too much on screen, but data projectors tend # to wash things out much, much more). # # Includes both blurred and unblurred versions, use as required. # # Unblurred: convert_bg = $(CONVERT) "$(1)" -threshold "-1" -depth 16 - | $(COMPOSITE) -dissolve 33% "$(1)" - "$(2)" %-BG.png: %.tif $(call convert_bg,$<,$(IMGDIR)/$@) %-BG.png: %.png $(call convert_bg,$<,$(IMGDIR)/$@) %-BG.png: %.jpg $(call convert_bg,$<,$(IMGDIR)/$@) %-BG.png: %.pict $(call convert_bg,$<,$(IMGDIR)/$@) # # Blurred: convert_bg_blur = $(CONVERT) -blur 0.5 "$(1)" "$(2)"; $(CONVERT) "$(2)" -threshold "-1" -depth 16 - | $(COMPOSITE) -dissolve 33% "$(2)" - "$(3)"; rm -f "$(2)" %-BG-blur.png: %.tif $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) %-BG-blur.png: %.png $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) %-BG-blur.png: %.jpg $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) %-BG-blur.png: %.pict $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) # # PNG from XCF. # %.png: %.xcf $(XCF2PNG) -o $(IMGDIR)/$@ $< # # PNG from EPS. # %.png %-print.png %-web.png: %.eps $(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - %-web-zoom.png: %.eps $(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - # # PNG from PS. # %-web.png: %.ps @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - %-web-zoom.png: %.ps @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - # # PNG from PDF. # %-web.png: %.pdf $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ $< %-web-zoom.png: %.pdf $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ $< # # PDF from Ploticus. # %.pdf %-print.pdf: %.plo $(PLOTICUS) -eps -tightcrop -o stdout $< | $(SHIFTBBOX) | $(EPSTOPDF) --filter --outfile=$(IMGDIR)/$@ # # PDF from R. # This assumes that the first argument to the R script is the output filename # for the resultant PDF. # %.pdf %-print.pdf: %.R $(R) --slave --file=$< --args "$(IMGDIR)/$@" $(PDFCROP) $(IMGDIR)/$@ $(IMGDIR)/$*-crop.pdf -$(MV) $(IMGDIR)/$*-crop.pdf $(IMGDIR)/$@ # # PDF from PS # %.pdf %-print.pdf: %.ps $(PS2EPS) --quiet --ignoreBB --nohires --loose < $< | $(EPSTOPDF) --filter --outfile=$(IMGDIR)/$@ # # PDF from EPS # %.pdf %-print.pdf: %.eps $(EPSTOPDF) --outfile=$(IMGDIR)/$@ $< # $(PS2EPS) --ignoreBB --nohires --loose < $< | $(PS2PDF) -dEPSCrop - $(IMGDIR)/$@ # # PDF from SVG (via Inkscape) # The --export-area-drawing option now appears to behave correctly with # PDFs (previously it over-cropped slightly). # %.pdf %-print.pdf: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-pdf=$(IMGDIR)/$@ # # PNG from SVG (via Inkscape) # %.png %-print.png %-web.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=1.0 --export-dpi=96 --export-png=$(IMGDIR)/$@ %-web-zoom.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=1.0 --export-dpi=144 --export-png=$(IMGDIR)/$@ %-print-zoom.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=1.0 --export-dpi=300 --export-png=$(IMGDIR)/$@ %-print-zoom-transparent.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=0 --export-dpi=300 --export-png=$(IMGDIR)/$@ %-transparent.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=0 --export-dpi=96 --export-png=$(IMGDIR)/$@ # # PNG from PNG (change the name). # These appear to need to be separate rules. If both variants need to be # created (i.e., both %-web.png and %-print.png), it only generates one of # them (most likely %-web.png as it's first in the rule) if the rules are # combined into one. This is Kind of Weird. # %-print.png: %.png $(CP) $< $(IMGDIR)/$@ %-web.png: %.png $(CP) $< $(IMGDIR)/$@ # # CSS from Sass (both syntaxes). # %.css: %.sass $(SASS) $< $@ %.css: %.scss $(SASS) $< $@ ################################################################################ # # File: $Id$ # # Standard rules for a variety of situations. Includes standard suffixes and # paths. # # ################################################################################ ################################################################################ # # Required make variables. These should be defined by the calling makefile. # # PAPER_NUMBER # The paper number for the current paper, e.g., 212. # PAPER_NUMBER?=$(error The required make variable PAPER_NUMBER has not been defined. Please set it to the correct value) # # IMGDIR # The path to the directory that contains images, e.g., images. # IMGDIR?=$(error The required make variable IMGDIR has not been defined. Please set it to the directory in which images are located) ################################################################################ # # Default rules. # # # PDF from LaTeX via DVI, typically for images drawn using PSTricks). # %.pdf %-print.pdf: $(IMGDIR)/%.tex $(LATEX) --jobname=$(IMGDIR)/$* $< $(DVIPS) -q -f $(IMGDIR)/$* | $(PS2EPS) --quiet --loose | $(EPSTOPDF) --filter --outfile=$(IMGDIR)/$@ # # PDF from LaTeX. # %.pdf: %.tex ifdef UNICODE $(XELATEX) $< $(XELATEX) $< else $(PDFLATEX) $< $(PDFLATEX) $< endif # # 2-up PDF from 1-up PDF. # %-2up.pdf: %.pdf $(PDFNUP) $< --nup 2x1 --outfile $@ # # Derived XML with inclusions from source XML without inclusions. # # This is done by simply running the original source through xmllint # with the --xinclude option to process any xi:include elements. # The result of this could just be piped into the XSLT processor, # except that (a) not all of the processors support input from stdin, # and (b) combining both xmllint and XSLT processing into one command # means that make won't stop if there's any errors from xmllint. # # Sed is used to add a comment to the derived XML file, warning that this # is generated and shouldn't be edited. Sed was used because the <?xml?> # processing instruction MUST be on the first line. The implication here # is that all input source files have an <?xml?> processing instruction # (which they should anyway). # %-derived.xml: %.xml $(XMLLINT) --xinclude $< > $@ @$(SED) --in-place --expression='1a <!-- THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT! -->' $@ # # LaTeX from derived XML. # %.tex: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xelatex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ else $(call xslt,$<,xml2latex.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ endif # # HTML from derived XML. # %.html: %-derived.xml ifdef UNICODE $(call xslt,$<,xml2xhtml.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ else $(call xslt,$<,xml2html.xsl,$(call xslt_parameter,subject-code,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper-number,'$(PAPER_NUMBER)'),$(call xslt_parameter,paper-year,'$(PAPER_YEAR)'),$(call xslt_parameter,period-code,'$(PAPER_PERIOD)')) > $@ endif # # Image rules can be a bit messy, because the prerequisite might be in any one # of several different formats, but we want to apply the same commands anyway # (e.g., ImageMagick convert) to generate the target. It would be nice if we # could specify variable file types in a prerequisite of a pattern rule (e.g., # %-foo.png: %.png %.jpg %.tif), but unfortunately we can't :(. The solution is # to create a make function to refactor the commands, and then specify as many # rules as required depending on the number of file formats. We still end up # repeating the rule actions, but at least the guts of the action is coded only # once in the function. # # PNG from TIFF, JPEG, PICT (normal image) # Note: PNG prerequisites are dealt with further down. # convert_normal = $(CONVERT) "$(1)" "$(2)" %.png %-print.png %-web.png: %.tif $(call convert_normal,$<,$(IMGDIR)/$@) %.png %-print.png %-web.png: %.jpg $(call convert_normal,$<,$(IMGDIR)/$@) %.png %-print.png %-web.png: %.pict $(call convert_normal,$<,$(IMGDIR)/$@) # # PNG from PNG, TIFF, JPEG, PICT (slide background) # # We lighten these so that they don't overwhelm the text. Note that 15% is # too light for most data projectors, so let's try 33% and see what # happens... (this looks far too much on screen, but data projectors tend # to wash things out much, much more). # # Includes both blurred and unblurred versions, use as required. # # Unblurred: convert_bg = $(CONVERT) "$(1)" -threshold "-1" -depth 16 - | $(COMPOSITE) -dissolve 33% "$(1)" - "$(2)" %-BG.png: %.tif $(call convert_bg,$<,$(IMGDIR)/$@) %-BG.png: %.png $(call convert_bg,$<,$(IMGDIR)/$@) %-BG.png: %.jpg $(call convert_bg,$<,$(IMGDIR)/$@) %-BG.png: %.pict $(call convert_bg,$<,$(IMGDIR)/$@) # # Blurred: convert_bg_blur = $(CONVERT) -blur 0.5 "$(1)" "$(2)"; $(CONVERT) "$(2)" -threshold "-1" -depth 16 - | $(COMPOSITE) -dissolve 33% "$(2)" - "$(3)"; rm -f "$(2)" %-BG-blur.png: %.tif $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) %-BG-blur.png: %.png $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) %-BG-blur.png: %.jpg $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) %-BG-blur.png: %.pict $(call convert_bg_blur,$<,$(IMGDIR)/$*-tmp.png,$(IMGDIR)/$@) # # PNG from XCF. # %.png: %.xcf $(XCF2PNG) -o $(IMGDIR)/$@ $< # # PNG from EPS. # %.png %-print.png %-web.png: %.eps $(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - %-web-zoom.png: %.eps $(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - # # PNG from PS. # %-web.png: %.ps @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - %-web-zoom.png: %.ps @$(PS2EPS) --ignoreBB --nohires --loose --gsbbox < $< | \ $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ - # # PNG from PDF. # %-web.png: %.pdf $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r96 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ $< %-web-zoom.png: %.pdf $(GS) -q -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -r144 \ -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$(IMGDIR)/$@ $< # # PDF from Ploticus. # %.pdf %-print.pdf: %.plo $(PLOTICUS) -eps -tightcrop -o stdout $< | $(SHIFTBBOX) | $(EPSTOPDF) --filter --outfile=$(IMGDIR)/$@ # # PDF from R. # This assumes that the first argument to the R script is the output filename # for the resultant PDF. # %.pdf %-print.pdf: %.R $(R) --slave --file=$< --args "$(IMGDIR)/$@" $(PDFCROP) $(IMGDIR)/$@ $(IMGDIR)/$*-crop.pdf -$(MV) $(IMGDIR)/$*-crop.pdf $(IMGDIR)/$@ # # PDF from PS # %.pdf %-print.pdf: %.ps $(PS2EPS) --quiet --ignoreBB --nohires --loose < $< | $(EPSTOPDF) --filter --outfile=$(IMGDIR)/$@ # # PDF from EPS # %.pdf %-print.pdf: %.eps $(EPSTOPDF) --outfile=$(IMGDIR)/$@ $< # $(PS2EPS) --ignoreBB --nohires --loose < $< | $(PS2PDF) -dEPSCrop - $(IMGDIR)/$@ # # PDF from SVG (via Inkscape) # The --export-area-drawing option now appears to behave correctly with # PDFs (previously it over-cropped slightly). # %.pdf %-print.pdf: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-pdf=$(IMGDIR)/$@ # # PNG from SVG (via Inkscape) # %.png %-print.png %-web.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=1.0 --export-dpi=96 --export-png=$(IMGDIR)/$@ %-web-zoom.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=1.0 --export-dpi=144 --export-png=$(IMGDIR)/$@ %-print-zoom.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=1.0 --export-dpi=300 --export-png=$(IMGDIR)/$@ %-print-zoom-transparent.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=0 --export-dpi=300 --export-png=$(IMGDIR)/$@ %-transparent.png: %.svg $(INKSCAPE) --file=$< --without-gui --export-area-drawing --export-background-opacity=0 --export-dpi=96 --export-png=$(IMGDIR)/$@ # # PNG from PNG (change the name). # These appear to need to be separate rules. If both variants need to be # created (i.e., both %-web.png and %-print.png), it only generates one of # them (most likely %-web.png as it's first in the rule) if the rules are # combined into one. This is Kind of Weird. # %-print.png: %.png $(CP) $< $(IMGDIR)/$@ %-web.png: %.png $(CP) $< $(IMGDIR)/$@ # # CSS from Sass (both syntaxes). # %.css: %.sass $(SASS) $< $@ %.css: %.scss $(SASS) $< $@

Ignore Space Show notes View make-includes/standard_suffixes.make

################################################################################ # # Specify standard file suffix list. # ################################################################################ ################################################################################ # # Add standard file suffixes. # .SUFFIXES: .svg .pdf .tex .dvi .png .tif .plo .jpg .pict .eps .ps .R .xml ################################################################################ # # $Id$ # # Specify standard file suffix list. # ################################################################################ ################################################################################ # # Add standard file suffixes. # .SUFFIXES: .svg .pdf .tex .dvi .png .tif .plo .jpg .pict .eps .ps .R .xml

Ignore Space Show notes View make-includes/xslt_functions.make

################################################################################ # # Make functions for handling XSLT tasks. # ################################################################################ ################################################################################ # # XSLT must be defined as an environment variable. It's an error not to do so. # XSLT?=$(error The required environment variable XSLT has not been defined. Please set it to either "saxon", "xalan-c" or "xalan-j", to indicate to your preferred XSLT processor) ################################################################################ # # Resolve a URI for some XML entity such as a stylesheet into a path to # the actual item. This works by calling the example resolver application # that comes with the entity resolver, then extracting the full path from # the result. If the URI cannot be resolved, the function returns the # original filename so that the XSLT processor can fail with a meaningful # error message. # # This is a workaround for the mysterious breakage that occured on Nigel's # machine in early 2006 where all of the XSLT processors suddenly stopped # accepting resolver class names as command line arguments. # # This approach, while apparently kludgey, does have a particular # advantage, however, in that it can be used with non-Java based XSLT # processors such as Xalan C++, whereas the previous approach only worked # with Saxon and Xalan-J. In other words, this will work with ANY XSLT # processor. # # Note that the function adds the "file:///" protocol to the front of the # argument, so callers should NOT add this themselves! # # For reference, the typical output from the resolver application looks # something like this for a successful resolution: # # % java org.apache.xml.resolver.apps.resolver -u file:///foo.xsl uri # Resolve URI (uri): # uri: file:///foo.xsl # Result: file:/path/to/item/foo.xsl # # and like this for a failure: # # % java org.apache.xml.resolver.apps.resolver -u file:///missing.xsl uri # Resolve URI (uri): # uri: file:///missing.xsl # Result: null # # Update (2007-07-11): Added fix for mysterious breakage on Chris's machine # that occurred for no apparent reason. An extra / was being put on the # front of the returned Windows path, e.g., /D:/blah/blah. Added a sed # to remove it when necessary. # # Arguments: # $(1) file name of item to be resolved, WITHOUT the "file:///" # resolve_uri = `$(RESOLVER) -u file:///$(1) uri | ( $(GREP) 'Result: file:' || $(ECHO) '::$(1)' ) | $(CUT) -d':' -f3- | $(SED) -e 's|/\([A-Z]:\)|\1|'` ################################################################################ # # Pass stylesheet parameters as appropriate to the XSLT processor. # $(XSLT) should be either defined as an environment variable, or # passed in as a parameter to make. # # Note: we expect the value of the stylesheet parameter to be quoted, # because it may potentially contain spaces. If it's not quoted before # being passed to this function, Weird Things May Occur. # # Arguments: # $(1) name of stylesheet parameter # $(2) value for stylesheet parameter (quoted) # xslt_parameter = $(if $(findstring $(XSLT),'xalan-c'),-p $(1) $(2),$(if $(findstring $(XSLT),'xalan-j'),-param $(1) $(2),$(if $(findstring $(XSLT),'saxon'),$(1)=$(2),$(if $(findstring $(XSLT),'saxon-b'),$(1)=$(2))))) ################################################################################ # # XSLT processor specific calling templates/functions, with parameters for # subject-code, paper-number, standalone, showanswers and base-path. # Unfortunately each of the major XSLT processors differs in the way it # handles command-line arguments :( Even worse, Xalan-C differs from # Xalan-J!! # # Note that the path to the XSLT processor is stored in the make variable # XSLTPROC, which is set by the local configuration script. # # Examples: # # Xalan -p department "'INFO'" -p paper "'111'" -p standalone "'no'" # -p showanswers "'no'" -p base-path "'../Tutorials'" # -p image-format "'eps'" $< xml2latex.xsl > $@ # # saxon $< xml2latex.xsl department='INFO' paper='111' standalone='no' # showanswers='no' base-path='../Tutorials' image-format='eps' > $@ # # Arguments: # $(1) source XML file # $(2) XSL stylesheet # $(3)-> Parameter strings for various stylesheet parameters, as many # as required. Currently supported are "department", "paper", # "standalone", "showanswers", "base-path", "image-format"). # The order of parameters doesn't matter. # # Parameter strings must be pre-formatted using the xslt_parameter function. # # # Xalan-C # # xalanc = Xalan $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) $(1) $(2) # xalanc = $(XSLTPROC) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) $(1) $(call resolve_uri,$(2)) # # Xalan-J # # xalanj = xalan -in $(1) -xsl $(2) \ # -uriresolver org.apache.xml.resolver.tools.CatalogResolver \ # $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # xalanj = $(XSLTPROC) -in $(1) -xsl $(call resolve_uri,$(2)) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # # SAXON # # saxon = saxon -x org.apache.xml.resolver.tools.ResolvingXMLReader \ # -y org.apache.xml.resolver.tools.ResolvingXMLReader \ # -r org.apache.xml.resolver.tools.CatalogResolver \ # $(1) file:///$(2) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # saxon = $(XSLTPROC) $(1) $(call resolve_uri,$(2)) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # # SAXON-B # # saxon = saxon-b -s:$(1) -xsl:file:///$(2) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # saxonb = $(XSLTPROC) -s:$(1) -xsl:$(call resolve_uri,$(2)) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) ################################################################################ # # Generic function for runnning the local preferred XSLT processor. # Redirecting the output to an appropriate output file is handled by the # caller. # # Arguments: # $(1) source XML file # $(2) XSL stylesheet # $(3)-> Parameter strings for various stylesheet arguments, as many # as required. Currently supported are "subject-code", # "paper-number", "standalone", "showanswers", "base-path", # "image-format"). The order of parameters doesn't matter. # # Parameter strings must be pre-formatted using the xslt_parameter function. # xslt = $(if $(findstring $(XSLT),'xalan-c'),$(call xalanc,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)),$(if $(findstring $(XSLT),'xalan-j'),$(call xalanj,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)),$(if $(findstring $(XSLT),'saxon'),$(call saxon,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)),$(if $(findstring $(XSLT),'saxon-b'),$(call saxonb,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)))))) # xslt_debug: # @announce "XSLT invocation (change value of XSLT to test others)" # @echo "$(call xslt,input.xml,stylesheet.xsl,$(call xslt_parameter,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'$(SECTION)'),$(call xslt_parameter,image-format,'pdf')) > output_file" ################################################################################ # # File: $Id$ # # Make functions for handling XSLT tasks. # ################################################################################ ################################################################################ # # XSLT must be defined as an environment variable. It's an error not to do so. # XSLT?=$(error The required environment variable XSLT has not been defined. Please set it to either "saxon", "xalan-c" or "xalan-j", to indicate to your preferred XSLT processor) ################################################################################ # # Resolve a URI for some XML entity such as a stylesheet into a path to # the actual item. This works by calling the example resolver application # that comes with the entity resolver, then extracting the full path from # the result. If the URI cannot be resolved, the function returns the # original filename so that the XSLT processor can fail with a meaningful # error message. # # This is a workaround for the mysterious breakage that occured on Nigel's # machine in early 2006 where all of the XSLT processors suddenly stopped # accepting resolver class names as command line arguments. # # This approach, while apparently kludgey, does have a particular # advantage, however, in that it can be used with non-Java based XSLT # processors such as Xalan C++, whereas the previous approach only worked # with Saxon and Xalan-J. In other words, this will work with ANY XSLT # processor. # # Note that the function adds the "file:///" protocol to the front of the # argument, so callers should NOT add this themselves! # # For reference, the typical output from the resolver application looks # something like this for a successful resolution: # # % java org.apache.xml.resolver.apps.resolver -u file:///foo.xsl uri # Resolve URI (uri): # uri: file:///foo.xsl # Result: file:/path/to/item/foo.xsl # # and like this for a failure: # # % java org.apache.xml.resolver.apps.resolver -u file:///missing.xsl uri # Resolve URI (uri): # uri: file:///missing.xsl # Result: null # # Update (2007-07-11): Added fix for mysterious breakage on Chris's machine # that occurred for no apparent reason. An extra / was being put on the # front of the returned Windows path, e.g., /D:/blah/blah. Added a sed # to remove it when necessary. # # Arguments: # $(1) file name of item to be resolved, WITHOUT the "file:///" # resolve_uri = `$(RESOLVER) -u file:///$(1) uri | ( $(GREP) 'Result: file:' || $(ECHO) '::$(1)' ) | $(CUT) -d':' -f3- | $(SED) -e 's|/\([A-Z]:\)|\1|'` ################################################################################ # # Pass stylesheet parameters as appropriate to the XSLT processor. # $(XSLT) should be either defined as an environment variable, or # passed in as a parameter to make. # # Note: we expect the value of the stylesheet parameter to be quoted, # because it may potentially contain spaces. If it's not quoted before # being passed to this function, Weird Things May Occur. # # Arguments: # $(1) name of stylesheet parameter # $(2) value for stylesheet parameter (quoted) # xslt_parameter = $(if $(findstring $(XSLT),'xalan-c'),-p $(1) $(2),$(if $(findstring $(XSLT),'xalan-j'),-param $(1) $(2),$(if $(findstring $(XSLT),'saxon'),$(1)=$(2),$(if $(findstring $(XSLT),'saxon-b'),$(1)=$(2))))) ################################################################################ # # XSLT processor specific calling templates/functions, with parameters for # subject-code, paper-number, standalone, showanswers and base-path. # Unfortunately each of the major XSLT processors differs in the way it # handles command-line arguments :( Even worse, Xalan-C differs from # Xalan-J!! # # Note that the path to the XSLT processor is stored in the make variable # XSLTPROC, which is set by the local configuration script. # # Examples: # # Xalan -p department "'INFO'" -p paper "'111'" -p standalone "'no'" # -p showanswers "'no'" -p base-path "'../Tutorials'" # -p image-format "'eps'" $< xml2latex.xsl > $@ # # saxon $< xml2latex.xsl department='INFO' paper='111' standalone='no' # showanswers='no' base-path='../Tutorials' image-format='eps' > $@ # # Arguments: # $(1) source XML file # $(2) XSL stylesheet # $(3)-> Parameter strings for various stylesheet parameters, as many # as required. Currently supported are "department", "paper", # "standalone", "showanswers", "base-path", "image-format"). # The order of parameters doesn't matter. # # Parameter strings must be pre-formatted using the xslt_parameter function. # # # Xalan-C # # xalanc = Xalan $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) $(1) $(2) # xalanc = $(XSLTPROC) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) $(1) $(call resolve_uri,$(2)) # # Xalan-J # # xalanj = xalan -in $(1) -xsl $(2) \ # -uriresolver org.apache.xml.resolver.tools.CatalogResolver \ # $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # xalanj = $(XSLTPROC) -in $(1) -xsl $(call resolve_uri,$(2)) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # # SAXON # # saxon = saxon -x org.apache.xml.resolver.tools.ResolvingXMLReader \ # -y org.apache.xml.resolver.tools.ResolvingXMLReader \ # -r org.apache.xml.resolver.tools.CatalogResolver \ # $(1) file:///$(2) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # saxon = $(XSLTPROC) $(1) $(call resolve_uri,$(2)) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # # SAXON-B # # saxon = saxon-b -s:$(1) -xsl:file:///$(2) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) # saxonb = $(XSLTPROC) -s:$(1) -xsl:$(call resolve_uri,$(2)) $(3) $(4) $(5) $(6) $(7) $(8) $(9) $(10) ################################################################################ # # Generic function for runnning the local preferred XSLT processor. # Redirecting the output to an appropriate output file is handled by the # caller. # # Arguments: # $(1) source XML file # $(2) XSL stylesheet # $(3)-> Parameter strings for various stylesheet arguments, as many # as required. Currently supported are "subject-code", # "paper-number", "standalone", "showanswers", "base-path", # "image-format"). The order of parameters doesn't matter. # # Parameter strings must be pre-formatted using the xslt_parameter function. # xslt = $(if $(findstring $(XSLT),'xalan-c'),$(call xalanc,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)),$(if $(findstring $(XSLT),'xalan-j'),$(call xalanj,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)),$(if $(findstring $(XSLT),'saxon'),$(call saxon,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)),$(if $(findstring $(XSLT),'saxon-b'),$(call saxonb,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8),$(9),$(10)))))) # xslt_debug: # @announce "XSLT invocation (change value of XSLT to test others)" # @echo "$(call xslt,input.xml,stylesheet.xsl,$(call xslt_parameter,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(call xslt_parameter,standalone,'no'),$(call xslt_parameter,showanswers,'no'),$(call xslt_parameter,base-path,'$(SECTION)'),$(call xslt_parameter,image-format,'pdf')) > output_file"

Ignore Space Show notes View makefile-templates/Makefile.content

################################################################################ # # Template makefile for building a particular content file for a document. # Place a copy of this file in the directory containing the content file, # and modify as appropriate. The makefile should be called with the name # of a specific content file as target. It will then check whether there # are any prerequisites to that file that may have changed, and rebuild # them if necessary. Most of the work is done by the include files, and # should cater for almost all cases. However, if custom rules are needed # for a section, they can be appended to the end of the document's # makefile. # # Note that the ONLY mode of operation for this makefile is to be called # from the makefile for a particular document, with the name of a specific # content file as the target. This makefile cannot be easily executed # standalone! This is because the content directory can exist at a # relatively arbitrary location within the paper's directory hierarchy. We # therefore don't know where to look, relative to the current directory, # to find the local include directory, and thus cannot provide a # meaningful value for the variable LOCAL_HANDBOOK_INCLUDE. The value of # LOCAL_HANDBOOK_INCLUDE must therefore be passed in from the calling # environment. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. Since we don't know our current location in the paper's # directory hierarchy, this has to be defined by the makefile's calling # environment. It's an error not to define this variable. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined) ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include standard variables and rules for building content files. (Mainly # oriented towards graphics generation.) # include $(GLOBAL_HANDBOOK_INCLUDE)/build_content_rules.make ################################################################################ # # Add custom rules below here, as necessary. Rules should ensure that they # at least touch their targets. # ################################################################################ # # File: $Id$ # # Template makefile for building a particular content file for a document. # Place a copy of this file in the directory containing the content file, # and modify as appropriate. The makefile should be called with the name # of a specific content file as target. It will then check whether there # are any prerequisites to that file that may have changed, and rebuild # them if necessary. Most of the work is done by the include files, and # should cater for almost all cases. However, if custom rules are needed # for a section, they can be appended to the end of the document's # makefile. # # Note that the ONLY mode of operation for this makefile is to be called # from the makefile for a particular document, with the name of a specific # content file as the target. This makefile cannot be easily executed # standalone! This is because the content directory can exist at a # relatively arbitrary location within the paper's directory hierarchy. We # therefore don't know where to look, relative to the current directory, # to find the local include directory, and thus cannot provide a # meaningful value for the variable LOCAL_HANDBOOK_INCLUDE. The value of # LOCAL_HANDBOOK_INCLUDE must therefore be passed in from the calling # environment. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. Since we don't know our current location in the paper's # directory hierarchy, this has to be defined by the makefile's calling # environment. It's an error not to define this variable. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined) ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include standard variables and rules for building content files. (Mainly # oriented towards graphics generation.) # include $(GLOBAL_HANDBOOK_INCLUDE)/build_content_rules.make ################################################################################ # # Add custom rules below here, as necessary. Rules should ensure that they # at least touch their targets. #

Ignore Space Show notes View makefile-templates/Makefile.document

################################################################################ # # Template makefile for building a particular document within a section of # the handbook (e.g., Tutorials 5). Place a copy of this file in the # directory for each document, and modify as appropriate. The default # makefile checks (and rebuilds if necessary) all of the content files for # the current document, using recursive make calls to each content file. # Most of the work is done by the include files, and should cater for # almost all cases. However, if custom rules are needed for a section, # they can be appended to the end of the document's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include standard variables and rules for building a document. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_document_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+= ################################################################################ # # File: $Id$ # # Template makefile for building a particular document within a section of # the handbook (e.g., Tutorials 5). Place a copy of this file in the # directory for each document, and modify as appropriate. The default # makefile checks (and rebuilds if necessary) all of the content files for # the current document, using recursive make calls to each content file. # Most of the work is done by the include files, and should cater for # almost all cases. However, if custom rules are needed for a section, # they can be appended to the end of the document's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include standard variables and rules for building a document. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_document_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+=

Ignore Space Show notes View makefile-templates/Makefile.handbook

################################################################################ # # Makefile for DBCOURSES handbooks. Revamped completely from old # monolithic version to a "many-makefiles" model. Each major sub-unit of # the handbook has its own makefile, and is called recursively from here. # This makes management of the whole process a bit more complex, but a lot # more flexible. It's now possible, for example, to build many of the # files for a single tutorial by going into that tutorial's directory and # running a make there. The old scheme was also wont to rebuild lots of # extraneous stuff when only one file changed (especially with graphics). # This does not appear to be (and should not) be a problem with the new # scheme. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell pwd)/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include variables defining the current paper. # include $(LOCAL_HANDBOOK_INCLUDE)/paper_variables.make ################################################################################ # # Directories for the major sections. Add to as necessary. Sections should # be listed in the order that they will appear in the handbook. Remember to # exclude CVS directories (doh!). # SECTION_DIRS:=$(shell $(FIND) sections -mindepth 1 -maxdepth 1 -type d -not -name CVS) ################################################################################ # # Run one-time initialisation stuff. # # Ensure that the patterns files exist. If they don't, copy the originals # across from the shared directory and abort the run so that the user can # edit them appropriately. # CHECK_ANSWERS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/answers.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "answers")) CHECK_QUESTIONS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/questions.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "questions")) CHECK_INSTALL_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/install.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/install.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "install")) CHECK_ALL_PATTERNS:=$(CHECK_ANSWERS_PATTERNS) $(CHECK_QUESTIONS_PATTERNS) $(CHECK_INSTALL_PATTERNS) ifneq "$(strip $(CHECK_ALL_PATTERNS))" "" $(error Patterns files have been restored from defaults ($(CHECK_ALL_PATTERNS)), please check them before continuing) endif # # Delete the marker file that indicates that we've already initialised the # sub-sections by removing their "content checked" marker files. There's # only one of these, so it's much easier to deal with :) # # Note: NOINIT should _not_ be exported to this sub-make, to ensure that # the sub-makefile's one-time initialisation is executed. # CLEANUP_MARKER_FILES:=$(foreach d,$(SECTION_DIRS),$(shell $(MAKE) -C $d init-clean)) ################################################################################ # # Load in patterns for which items to install. In particular, we are looking # for the value "handbook_root" to appear in either QUESTION_INSTALL_PATTERNS # or ANSWER_INSTALL_PATTERNS. This tells us whether to install links for the # questions and answers versions of the handbook, respectively. Yes, this is # a hack! # # *_INSTALL_PATTERNS defines the patterns for installing on the web server. # QUESTION_INSTALL_PATTERNS:= ANSWER_INSTALL_PATTERNS:= # # Load in the install patterns from the local make-includes directory. # include $(LOCAL_HANDBOOK_INCLUDE)/install.patterns ################################################################################ # # Lists of LaTeX files to be \input into the master LaTeX document. Just # build a single list for everything; we can extract the sections we want # at the time using make's filter function, as the sections have distinct # names. These are statically defined rather than using a find command, # because the files may not exist at the time the find command is # executed. This Would Be Non-Useful. # QUESTION_TEX_INPUTS:=$(foreach d,$(SECTION_DIRS),$d/question-manifest.tex) ANSWER_TEX_INPUTS:=$(foreach d,$(SECTION_DIRS),$d/answer-manifest.tex) LATEX_INCLUDES:=$(shell $(FIND) latex-includes -name "*.tex") ################################################################################ # # Additional options for the coursehandbook document class to set up # the details of the paper. These get included in a call to the # \papersetup macro in the template file (including the options # directly into the \documentclass is problematic --- see # coursehandbook.cls for details). The values are set in # latex-includes/paper_variables.make. # PAPER_OPTIONS:=subjectcode=$(SUBJECT_CODE),papernumber=$(PAPER_NUMBER),papertitle=$(PAPER_TITLE),paperyear=$(PAPER_YEAR),paperperiod=$(PAPER_PERIOD),authors=$(HANDBOOK_AUTHORS) ################################################################################ # # Directory to install files into on web server. # INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/Handbook ################################################################################ # # Files to be installed on web server. # QUESTION_INSTALL_FILES:=handbook.pdf handbook-2up.pdf $(wildcard *.png) ANSWER_INSTALL_FILES:= handbook-answers.pdf handbook-answers-2up.pdf \ $(wildcard *.png) # Sorting gets rid of any duplicates (e.g., the PNG files). INSTALL_FILES:=$(sort $(QUESTION_INSTALL_FILES) $(ANSWER_INSTALL_FILES)) ################################################################################ # # Lists of files for cleaning up. # WEB_CLEAN_FILES:=*.png PRINT_CLEAN_FILES:=handbook.tex handbook-answers.tex \ *.pdf *.ps *.dvi *.aux *.log *.toc *.idx *.ind *.tex~ *.out ALL_CLEAN_FILES:=$(WEB_CLEAN_FILES) $(PRINT_CLEAN_FILES) ################################################################################ # # List of possible targets. # TARGETS:=all targets debug install \ web web-questions web-answers \ print print-questions print-answers \ questions answers \ section-questions section-answers \ question-pdfs answer-pdfs \ clean web-clean print-clean .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions/answers only. # questions: web-questions print-questions answers: web-answers print-answers ################################################################################ # # Build web version only. NOINIT and SECTION should be exported to all # these sub-makes. # web: general-graphics web-questions web-answers web-questions: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d web-questions NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) web-answers: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d web-answers NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) ################################################################################ # # Build print version only. NOINIT and SECTION should be exported to all # these sub-makes. # print: general-graphics print-questions print-answers print-questions: section-questions handbook.pdf handbook-2up.pdf question-pdfs section-questions: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d print-questions NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) handbook.tex: handbook_template.tex $(QUESTION_TEX_INPUTS) $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns $(LATEX_INCLUDES) @$(ANNOUNCE) "Generating $@" @$(ECHO) "% THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!" > $@ @$(ECHO) >> $@ @$(PERL) -p -e "s|\<\@SHOWANSWERS\@\>|hideanswers|;" \ -e "s|\<\@PAPEROPTIONS\@\>|$(PAPER_OPTIONS)|;" \ $(foreach sect,$(SECTION_DIRS),-e "s|\<\@SECTION\[$(notdir $(sect))\]\@\>|\\\\input{$(basename $(filter $(sect)/%,$(QUESTION_TEX_INPUTS)))}|;") $< >> $@ question-pdfs: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d question-pdfs NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) # # Answers # print-answers: section-answers handbook-answers.pdf handbook-answers-2up.pdf answer-pdfs section-answers: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d print-answers NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) handbook-answers.tex: handbook_template.tex $(ANSWER_TEX_INPUTS) $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns $(LATEX_INCLUDES) @$(ANNOUNCE) "Generating $@" @$(ECHO) "% THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!" > $@ @$(ECHO) >> $@ @$(PERL) -p -e "s|\<\@SHOWANSWERS\@\>|showanswers|;" \ -e "s|\<\@PAPEROPTIONS\@\>|$(PAPER_OPTIONS)|;" \ $(foreach sect,$(SECTION_DIRS),-e "s|\<\@SECTION\[$(notdir $(sect))\]\@\>|\\\\input{$(basename $(filter $(sect)/%,$(ANSWER_TEX_INPUTS)))}|;") $< >> $@ answer-pdfs: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d answer-pdfs NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) # # Generic rules for print version. # %.pdf: %.tex @$(ANNOUNCE) "pdflatex $< (pass 1)" $(PDFLATEX) $< @$(ANNOUNCE) "pdflatex $< (pass 2)" $(PDFLATEX) $< %-2up.pdf: %.pdf @$(ANNOUNCE) "Generating $@" $(PDFNUP) --nup 2x1 --outfile $@ $< ################################################################################ # # Build any general graphics that are used throughout the handbook. This uses # the standard makefile for a content directory, but the only files in this # directory are graphics files. # general-graphics: @if $(MAKE) -C graphics general-graphics BUILD_DIR=$(CURDIR); then $(TRUE); else exit 1; fi ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # See build_document_rules.make for an explanation of why the install # uses a foreach. # install: questions answers @$(SITECOPY) --catchup Blackboard$(PAPER_NUMBER) @$(ANNOUNCE) "Deploying handbook files to Blackboard --- make sure that you have the share mounted!" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d $@ NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) @$(ANNOUNCE) "Deploying files into $(INSTALL_DIRECTORY)" @$(foreach f,$(QUESTION_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) @$(foreach f,$(ANSWER_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) @$(ANNOUNCE) "Synchronising with Blackboard" @$(SITECOPY) --update Blackboard$(PAPER_NUMBER) ################################################################################ # # Clean up all generated files. # "web-clean" and "print-clean" only clean up files for the web and print # versions, respectively. Note that "clean" isn't dependent on either # "web-clean" or "print-clean", to ensure that the correct target is # used when calling the sub-makefile. # clean: @$(foreach d,$(SECTION_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(ALL_CLEAN_FILES)),) -$(RM) -f $(ALL_CLEAN_FILES) @$(MAKE) -C graphics clean BUILD_DIR=$(CURDIR) endif web-clean: @$(foreach d,$(SECTION_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(WEB_CLEAN_FILES)),) -$(RM) -f $(WEB_CLEAN_FILES) endif print-clean: @$(foreach d,$(SECTION_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(PRINT_CLEAN_FILES)),) -$(RM) -f $(PRINT_CLEAN_FILES) endif ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @$(ECHO) "SECTION_DIRS = [$(SECTION_DIRS)]" @$(ECHO) "QUESTION_TEX_INPUTS = [$(QUESTION_TEX_INPUTS)]" @$(ECHO) "ANSWER_TEX_INPUTS = [$(ANSWER_TEX_INPUTS)]" @$(ECHO) "LATEX_INCLUDES = [$(LATEX_INCLUDES)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "INSTALL_FILES = [$(INSTALL_FILES)]" @$(ECHO) "QUESTION_INSTALL_FILES = [$(QUESTION_INSTALL_FILES)]" @$(ECHO) "ANSWER_INSTALL_FILES = [$(ANSWER_INSTALL_FILES)]" @$(ECHO) "QUESTION_INSTALL_PATTERNS = [$(QUESTION_INSTALL_PATTERNS)]" @$(ECHO) "ANSWER_INSTALL_PATTERNS = [$(ANSWER_INSTALL_PATTERNS)]" @$(ECHO) "WEB_CLEAN_FILES = [$(WEB_CLEAN_FILES)]" @$(ECHO) "PRINT_CLEAN_FILES = [$(PRINT_CLEAN_FILES)]" @$(ECHO) "ALL_CLEAN_FILES = [$(ALL_CLEAN_FILES)]" @$(ECHO) "SUBJECT_CODE = [$(SUBJECT_CODE)]" @$(ECHO) "PAPER_NUMBER = [$(PAPER_NUMBER)]" @$(ECHO) "PAPER_TITLE = [$(PAPER_TITLE)]" @$(ECHO) "PAPER_YEAR = [$(PAPER_YEAR)]" @$(ECHO) "PAPER_PERIOD = [$(PAPER_PERIOD)]" @$(ECHO) "HANDBOOK_AUTHORS = [$(HANDBOOK_AUTHORS)]" @$(ECHO) "PAPER_OPTIONS = [$(PAPER_OPTIONS)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS) ################################################################################ # # File: $Id$ # # Makefile for DBCOURSES handbooks. Revamped completely from old # monolithic version to a "many-makefiles" model. Each major sub-unit of # the handbook has its own makefile, and is called recursively from here. # This makes management of the whole process a bit more complex, but a lot # more flexible. It's now possible, for example, to build many of the # files for a single tutorial by going into that tutorial's directory and # running a make there. The old scheme was also wont to rebuild lots of # extraneous stuff when only one file changed (especially with graphics). # This does not appear to be (and should not) be a problem with the new # scheme. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Given that we print out our own messages, I see no point in splurging # "Entering...leaving directory" messages all over the screen. It's hard # enough to figure out what's going on already :) # MAKEFLAGS=--no-print-directory ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell pwd)/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include variables defining the current paper. # include $(LOCAL_HANDBOOK_INCLUDE)/paper_variables.make ################################################################################ # # Directories for the major sections. Add to as necessary. Sections should # be listed in the order that they will appear in the handbook. Remember to # exclude CVS directories (doh!). # SECTION_DIRS:=$(shell $(FIND) sections -mindepth 1 -maxdepth 1 -type d -not -name CVS) ################################################################################ # # Run one-time initialisation stuff. # # Ensure that the patterns files exist. If they don't, copy the originals # across from the shared directory and abort the run so that the user can # edit them appropriately. # CHECK_ANSWERS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/answers.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "answers")) CHECK_QUESTIONS_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/questions.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "questions")) CHECK_INSTALL_PATTERNS:=$(shell ($(TEST) -f $(LOCAL_HANDBOOK_INCLUDE)/install.patterns) || ($(CP) $(TEACHING_SHARED)/Authoring/Handbook/makefile-templates/install.patterns $(LOCAL_HANDBOOK_INCLUDE); $(ECHO) "install")) CHECK_ALL_PATTERNS:=$(CHECK_ANSWERS_PATTERNS) $(CHECK_QUESTIONS_PATTERNS) $(CHECK_INSTALL_PATTERNS) ifneq "$(strip $(CHECK_ALL_PATTERNS))" "" $(error Patterns files have been restored from defaults ($(CHECK_ALL_PATTERNS)), please check them before continuing) endif # # Delete the marker file that indicates that we've already initialised the # sub-sections by removing their "content checked" marker files. There's # only one of these, so it's much easier to deal with :) # # Note: NOINIT should _not_ be exported to this sub-make, to ensure that # the sub-makefile's one-time initialisation is executed. # CLEANUP_MARKER_FILES:=$(foreach d,$(SECTION_DIRS),$(shell $(MAKE) -C $d init-clean)) ################################################################################ # # Load in patterns for which items to install. In particular, we are looking # for the value "handbook_root" to appear in either QUESTION_INSTALL_PATTERNS # or ANSWER_INSTALL_PATTERNS. This tells us whether to install links for the # questions and answers versions of the handbook, respectively. Yes, this is # a hack! # # *_INSTALL_PATTERNS defines the patterns for installing on the web server. # QUESTION_INSTALL_PATTERNS:= ANSWER_INSTALL_PATTERNS:= # # Load in the install patterns from the local make-includes directory. # include $(LOCAL_HANDBOOK_INCLUDE)/install.patterns ################################################################################ # # Lists of LaTeX files to be \input into the master LaTeX document. Just # build a single list for everything; we can extract the sections we want # at the time using make's filter function, as the sections have distinct # names. These are statically defined rather than using a find command, # because the files may not exist at the time the find command is # executed. This Would Be Non-Useful. # QUESTION_TEX_INPUTS:=$(foreach d,$(SECTION_DIRS),$d/question-manifest.tex) ANSWER_TEX_INPUTS:=$(foreach d,$(SECTION_DIRS),$d/answer-manifest.tex) LATEX_INCLUDES:=$(shell $(FIND) latex-includes -name "*.tex") ################################################################################ # # Additional options for the coursehandbook document class to set up # the details of the paper. These get included in a call to the # \papersetup macro in the template file (including the options # directly into the \documentclass is problematic --- see # coursehandbook.cls for details). The values are set in # latex-includes/paper_variables.make. # PAPER_OPTIONS:=subjectcode=$(SUBJECT_CODE),papernumber=$(PAPER_NUMBER),papertitle=$(PAPER_TITLE),paperyear=$(PAPER_YEAR),paperperiod=$(PAPER_PERIOD),authors=$(HANDBOOK_AUTHORS) ################################################################################ # # Directory to install files into on web server. # INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/Handbook ################################################################################ # # Files to be installed on web server. # QUESTION_INSTALL_FILES:=handbook.pdf handbook-2up.pdf $(wildcard *.png) ANSWER_INSTALL_FILES:= handbook-answers.pdf handbook-answers-2up.pdf \ $(wildcard *.png) # Sorting gets rid of any duplicates (e.g., the PNG files). INSTALL_FILES:=$(sort $(QUESTION_INSTALL_FILES) $(ANSWER_INSTALL_FILES)) ################################################################################ # # Lists of files for cleaning up. # WEB_CLEAN_FILES:=*.png PRINT_CLEAN_FILES:=handbook.tex handbook-answers.tex \ *.pdf *.ps *.dvi *.aux *.log *.toc *.idx *.ind *.tex~ *.out ALL_CLEAN_FILES:=$(WEB_CLEAN_FILES) $(PRINT_CLEAN_FILES) ################################################################################ # # List of possible targets. # TARGETS:=all targets debug install \ web web-questions web-answers \ print print-questions print-answers \ questions answers \ section-questions section-answers \ question-pdfs answer-pdfs \ clean web-clean print-clean .PHONY: $(TARGETS) ################################################################################ # # Build everything. # all: web print ################################################################################ # # Build questions/answers only. # questions: web-questions print-questions answers: web-answers print-answers ################################################################################ # # Build web version only. NOINIT and SECTION should be exported to all # these sub-makes. # web: general-graphics web-questions web-answers web-questions: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d web-questions NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) web-answers: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d web-answers NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) ################################################################################ # # Build print version only. NOINIT and SECTION should be exported to all # these sub-makes. # print: general-graphics print-questions print-answers print-questions: section-questions handbook.pdf handbook-2up.pdf question-pdfs section-questions: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d print-questions NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) handbook.tex: handbook_template.tex $(QUESTION_TEX_INPUTS) $(LOCAL_HANDBOOK_INCLUDE)/questions.patterns $(LATEX_INCLUDES) @$(ANNOUNCE) "Generating $@" @$(ECHO) "% THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!" > $@ @$(ECHO) >> $@ @$(PERL) -p -e "s|\<\@SHOWANSWERS\@\>|hideanswers|;" \ -e "s|\<\@PAPEROPTIONS\@\>|$(PAPER_OPTIONS)|;" \ $(foreach sect,$(SECTION_DIRS),-e "s|\<\@SECTION\[$(notdir $(sect))\]\@\>|\\\\input{$(basename $(filter $(sect)/%,$(QUESTION_TEX_INPUTS)))}|;") $< >> $@ question-pdfs: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d question-pdfs NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) # # Answers # print-answers: section-answers handbook-answers.pdf handbook-answers-2up.pdf answer-pdfs section-answers: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d print-answers NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) handbook-answers.tex: handbook_template.tex $(ANSWER_TEX_INPUTS) $(LOCAL_HANDBOOK_INCLUDE)/answers.patterns $(LATEX_INCLUDES) @$(ANNOUNCE) "Generating $@" @$(ECHO) "% THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!" > $@ @$(ECHO) >> $@ @$(PERL) -p -e "s|\<\@SHOWANSWERS\@\>|showanswers|;" \ -e "s|\<\@PAPEROPTIONS\@\>|$(PAPER_OPTIONS)|;" \ $(foreach sect,$(SECTION_DIRS),-e "s|\<\@SECTION\[$(notdir $(sect))\]\@\>|\\\\input{$(basename $(filter $(sect)/%,$(ANSWER_TEX_INPUTS)))}|;") $< >> $@ answer-pdfs: @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d answer-pdfs NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) # # Generic rules for print version. # %.pdf: %.tex @$(ANNOUNCE) "pdflatex $< (pass 1)" $(PDFLATEX) $< @$(ANNOUNCE) "pdflatex $< (pass 2)" $(PDFLATEX) $< %-2up.pdf: %.pdf @$(ANNOUNCE) "Generating $@" $(PDFNUP) --nup 2x1 --outfile $@ $< ################################################################################ # # Build any general graphics that are used throughout the handbook. This uses # the standard makefile for a content directory, but the only files in this # directory are graphics files. # general-graphics: @if $(MAKE) -C graphics general-graphics BUILD_DIR=$(CURDIR); then $(TRUE); else exit 1; fi ################################################################################ # # Deploy the appropriate files into a shared folder, which is then synchronised # with Blackboard. This relies on the environment variable HANDBOOK_INSTALL_ROOT # being defined, and (assuming that this variable points to a directory on the # network) the appropriate share has been mounted. # # See build_document_rules.make for an explanation of why the install # uses a foreach. # install: questions answers @$(SITECOPY) --catchup Blackboard$(PAPER_NUMBER) @$(ANNOUNCE) "Deploying handbook files to Blackboard --- make sure that you have the share mounted!" @$(TEST) -d $(HANDBOOK_INSTALL_ROOT) @$(MKDIR_P) $(INSTALL_DIRECTORY) @$(foreach d,$(SECTION_DIRS),if $(MAKE) -C $d $@ NOINIT=x SECTION=$(notdir $(d)); then $(TRUE); else exit 1; fi;) @$(ANNOUNCE) "Deploying files into $(INSTALL_DIRECTORY)" @$(foreach f,$(QUESTION_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) @$(foreach f,$(ANSWER_INSTALL_FILES),if $(TEST) ! -f $(INSTALL_DIRECTORY)/$(f) -o $(f) -nt $(INSTALL_DIRECTORY)/$(f); then $(ECHO) "Deploying $(f)"; $(CP) $(f) $(INSTALL_DIRECTORY); fi;) @$(ANNOUNCE) "Synchronising with Blackboard" @$(SITECOPY) --update Blackboard$(PAPER_NUMBER) ################################################################################ # # Clean up all generated files. # "web-clean" and "print-clean" only clean up files for the web and print # versions, respectively. Note that "clean" isn't dependent on either # "web-clean" or "print-clean", to ensure that the correct target is # used when calling the sub-makefile. # clean: @$(foreach d,$(SECTION_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(ALL_CLEAN_FILES)),) -$(RM) -f $(ALL_CLEAN_FILES) @$(MAKE) -C graphics clean BUILD_DIR=$(CURDIR) endif web-clean: @$(foreach d,$(SECTION_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(WEB_CLEAN_FILES)),) -$(RM) -f $(WEB_CLEAN_FILES) endif print-clean: @$(foreach d,$(SECTION_DIRS),$(MAKE) -C $d $@;) ifneq ($(strip $(PRINT_CLEAN_FILES)),) -$(RM) -f $(PRINT_CLEAN_FILES) endif ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @$(ANNOUNCE) Externally defined variables @$(ECHO) "TEACHING_SHARED = [$(TEACHING_SHARED)]" @$(ECHO) "HANDBOOK_INSTALL_ROOT = [$(HANDBOOK_INSTALL_ROOT)]" @$(ANNOUNCE) Internally defined variables @$(ECHO) "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @$(ECHO) "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @$(ECHO) "SECTION_DIRS = [$(SECTION_DIRS)]" @$(ECHO) "QUESTION_TEX_INPUTS = [$(QUESTION_TEX_INPUTS)]" @$(ECHO) "ANSWER_TEX_INPUTS = [$(ANSWER_TEX_INPUTS)]" @$(ECHO) "LATEX_INCLUDES = [$(LATEX_INCLUDES)]" @$(ECHO) "INSTALL_DIRECTORY = [$(INSTALL_DIRECTORY)]" @$(ECHO) "INSTALL_FILES = [$(INSTALL_FILES)]" @$(ECHO) "QUESTION_INSTALL_FILES = [$(QUESTION_INSTALL_FILES)]" @$(ECHO) "ANSWER_INSTALL_FILES = [$(ANSWER_INSTALL_FILES)]" @$(ECHO) "QUESTION_INSTALL_PATTERNS = [$(QUESTION_INSTALL_PATTERNS)]" @$(ECHO) "ANSWER_INSTALL_PATTERNS = [$(ANSWER_INSTALL_PATTERNS)]" @$(ECHO) "WEB_CLEAN_FILES = [$(WEB_CLEAN_FILES)]" @$(ECHO) "PRINT_CLEAN_FILES = [$(PRINT_CLEAN_FILES)]" @$(ECHO) "ALL_CLEAN_FILES = [$(ALL_CLEAN_FILES)]" @$(ECHO) "SUBJECT_CODE = [$(SUBJECT_CODE)]" @$(ECHO) "PAPER_NUMBER = [$(PAPER_NUMBER)]" @$(ECHO) "PAPER_TITLE = [$(PAPER_TITLE)]" @$(ECHO) "PAPER_YEAR = [$(PAPER_YEAR)]" @$(ECHO) "PAPER_PERIOD = [$(PAPER_PERIOD)]" @$(ECHO) "HANDBOOK_AUTHORS = [$(HANDBOOK_AUTHORS)]" @$(ECHO) "PAPER_OPTIONS = [$(PAPER_OPTIONS)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @$(ECHO) $(TARGETS)

Ignore Space Show notes View makefile-templates/Makefile.lecture

################################################################################ # # Template makefile for building a set of lecture files. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Clear out the suffixes list. DO NOT ALTER THIS LINE! # .SUFFIXES: # # Add any custom suffixes here (uncomment the line below). # The "standard" suffixes list currently includes: # .svg .pdf .tex .dvi .png .tif .plo .jpg .pict .eps .ps .R .xml # # .SUFFIXES: ################################################################################ # # Define paths for various items here. The "standard" paths currently include: # # vpath %.pdf $(IMGDIR) # vpath %.png $(IMGDIR) # vpath %.tif $(IMGDIR) # vpath %.jpg $(IMGDIR) # vpath %.plo $(IMGDIR) # vpath %.ps $(IMGDIR) # vpath %.eps $(IMGDIR) # vpath %.svg $(IMGDIR) # vpath %.pict $(IMGDIR) # # There's nothing to stop you adding new paths for these file types. # # vpath foo bar ################################################################################ # # Specify the current lecture chapter number. THIS MUST BE DEFINED! # Set it to whatever you like if you don't use it (see below). # CHAPTER?=$(error The required variable CHAPTER has not been defined. Please set it to the correct chapter number for this set of lectures) ################################################################################ # # Specify the subject code and paper number. THESE MUST BE DEFINED! # SUBJECT_CODE?=$(error The required variable SUBJECT_CODE has not been defined. Please set it to the correct subject code for this set of lectures) PAPER_NUMBER?=$(error The required variable PAPER_NUMBER has not been defined. Please set it to the correct paper number for this set of lectures) ################################################################################ # # Directory to install files into on web server. This is .../Lectures/name of # build directory, to avoid similarly-named files overwriting each other. # BUILD_DIR:=$(lastword $(subst /, ,$(CURDIR))) INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/Lectures/$(BUILD_DIR) ################################################################################ # # Uncomment any of the following to prevent a particular document from # being built. This is necessary if, for example, the current set of # lectures has no figures and examples. # # Alternatively, you can use this to set the base name of the source and target # files if this is a one-off lecture that doesn't fall into the standard # chapter convention. (Set CHAPTER above to whatever you like if you don't # use it.) # # SLIDES= # FIGURES= # COMBINED= # NOTES= ################################################################################ # # Standard file list variables. # # List of images used in the presentation as actual content. # SLIDE_IMAGES= # # List of other files used in the presentation as actual content. # We assume that shared infrastructure files are in the parent directory; # modify as necessary. # SLIDE_FILES=../../paper_init.tex chapter_init.tex # # List of images used in the presentation as backgrounds or watermarks. # SLIDE_BACKGROUNDS= # # List of images used in the figures and examples document. # FIG_IMAGES= # # List of other files used in the figures and examples document. # FIG_FILES=../../paper_init.tex chapter_init.tex # # List of images used in the combined lecture material document. # COMBI_IMAGES= # # List of other files used in the combined lecture material document. # COMBI_FILES=../../paper_init.tex chapter_init.tex # # List of files other than the standard ones (slides, figures, combined) # to be installed on the web server. By default, install the following # files: ChapterXslides.pdf, ChapterXcombined.pdf, ChapterXfigures.pdf, # ChapterXfigures-reduced.pdf. This can include files in subdirectories # (e.g., foo/bar.pdf), but the subdirectories themselves will not be # created at the other end (i.e., the directory structure will be # flattened). # INSTALL_FILES= # # Files to be cleaned by the various "clean" targets. The "standard" values # are currently: # TIDY_FILES=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi \ # slides-combined.pdf slides-notes.pdf # CLEAN_FILES=*.aux *.pdf # # $(TIDY_FILES) is a list of generated intermediate files to clean up. # TIDY_FILES= # # $(CLEAN_FILES) is everything else that might need to be cleaned up. # CLEAN_FILES= ################################################################################ # # Specify LaTeX document options (comma-separated list). The "standard" # value is currently: pdftex,usepdftitle=false,$(DRAFT).If you want to # override the "standard" options, redefine this variable after the # include line just below. # LATEX_OPTS= # # List of "phony" build targets (remember to define rules for # them!). The "standard" list is currently: # all slides notes slides-combined slides-notes figures combined # debug test clean tidy targets # TARGETS= ################################################################################ # # Add custom variables below here as necessary. # ################################################################################ # # Include standard variables and rules for building lectures. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_lecture_rules.make ################################################################################ # # Add custom rules below here as necessary. # ################################################################################ # # File: $Id$ # # Template makefile for building a set of lecture files. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Clear out the suffixes list. DO NOT ALTER THIS LINE! # .SUFFIXES: # # Add any custom suffixes here (uncomment the line below). # The "standard" suffixes list currently includes: # .svg .pdf .tex .dvi .png .tif .plo .jpg .pict .eps .ps .R .xml # # .SUFFIXES: ################################################################################ # # Define paths for various items here. The "standard" paths currently include: # # vpath %.pdf $(IMGDIR) # vpath %.png $(IMGDIR) # vpath %.tif $(IMGDIR) # vpath %.jpg $(IMGDIR) # vpath %.plo $(IMGDIR) # vpath %.ps $(IMGDIR) # vpath %.eps $(IMGDIR) # vpath %.svg $(IMGDIR) # vpath %.pict $(IMGDIR) # # There's nothing to stop you adding new paths for these file types. # # vpath foo bar ################################################################################ # # Specify the current lecture chapter number. THIS MUST BE DEFINED! # Set it to whatever you like if you don't use it (see below). # CHAPTER?=$(error The required variable CHAPTER has not been defined. Please set it to the correct chapter number for this set of lectures) ################################################################################ # # Specify the subject code and paper number. THESE MUST BE DEFINED! # SUBJECT_CODE?=$(error The required variable SUBJECT_CODE has not been defined. Please set it to the correct subject code for this set of lectures) PAPER_NUMBER?=$(error The required variable PAPER_NUMBER has not been defined. Please set it to the correct paper number for this set of lectures) ################################################################################ # # Directory to install files into on web server. This is .../Lectures/name of # build directory, to avoid similarly-named files overwriting each other. # BUILD_DIR:=$(lastword $(subst /, ,$(CURDIR))) INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/Lectures/$(BUILD_DIR) ################################################################################ # # Uncomment any of the following to prevent a particular document from # being built. This is necessary if, for example, the current set of # lectures has no figures and examples. # # Alternatively, you can use this to set the base name of the source and target # files if this is a one-off lecture that doesn't fall into the standard # chapter convention. (Set CHAPTER above to whatever you like if you don't # use it.) # # SLIDES= # FIGURES= # COMBINED= # NOTES= ################################################################################ # # Standard file list variables. # # List of images used in the presentation as actual content. # SLIDE_IMAGES= # # List of other files used in the presentation as actual content. # We assume that shared infrastructure files are in the parent directory; # modify as necessary. # SLIDE_FILES=../../paper_init.tex chapter_init.tex # # List of images used in the presentation as backgrounds or watermarks. # SLIDE_BACKGROUNDS= # # List of images used in the figures and examples document. # FIG_IMAGES= # # List of other files used in the figures and examples document. # FIG_FILES=../../paper_init.tex chapter_init.tex # # List of images used in the combined lecture material document. # COMBI_IMAGES= # # List of other files used in the combined lecture material document. # COMBI_FILES=../../paper_init.tex chapter_init.tex # # List of files other than the standard ones (slides, figures, combined) # to be installed on the web server. By default, install the following # files: ChapterXslides.pdf, ChapterXcombined.pdf, ChapterXfigures.pdf, # ChapterXfigures-reduced.pdf. This can include files in subdirectories # (e.g., foo/bar.pdf), but the subdirectories themselves will not be # created at the other end (i.e., the directory structure will be # flattened). # INSTALL_FILES= # # Files to be cleaned by the various "clean" targets. The "standard" values # are currently: # TIDY_FILES=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi \ # slides-combined.pdf slides-notes.pdf # CLEAN_FILES=*.aux *.pdf # # $(TIDY_FILES) is a list of generated intermediate files to clean up. # TIDY_FILES= # # $(CLEAN_FILES) is everything else that might need to be cleaned up. # CLEAN_FILES= ################################################################################ # # Specify LaTeX document options (comma-separated list). The "standard" # value is currently: pdftex,usepdftitle=false,$(DRAFT).If you want to # override the "standard" options, redefine this variable after the # include line just below. # LATEX_OPTS= # # List of "phony" build targets (remember to define rules for # them!). The "standard" list is currently: # all slides notes slides-combined slides-notes figures combined # debug test clean tidy targets # TARGETS= ################################################################################ # # Add custom variables below here as necessary. # ################################################################################ # # Include standard variables and rules for building lectures. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_lecture_rules.make ################################################################################ # # Add custom rules below here as necessary. #

Ignore Space Show notes View makefile-templates/Makefile.misc

################################################################################ # # Template makefile for building a general document. # ################################################################################ SHELL = /bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Clear out the suffixes list. DO NOT ALTER THIS LINE! # .SUFFIXES: # # Add any custom suffixes here (uncomment the line below). # The "standard" suffixes list currently includes: # .svg .pdf .tex .dvi .png .tif .plo .jpg .pict .eps .ps .R .xml # # .SUFFIXES: ################################################################################ # # Define paths for various items here. The "standard" paths currently include: # # vpath %.pdf $(IMGDIR) # vpath %.png $(IMGDIR) # vpath %.tif $(IMGDIR) # vpath %.jpg $(IMGDIR) # vpath %.plo $(IMGDIR) # vpath %.ps $(IMGDIR) # vpath %.eps $(IMGDIR) # vpath %.svg $(IMGDIR) # vpath %.pict $(IMGDIR) # vpath %.R $(IMGDIR) # # There's nothing to stop you adding new paths for these file types. # # vpath foo bar ################################################################################ # # Specify the current subject code and paper number. # THESE MUST BE DEFINED! # SUBJECT_CODE?=$(error The required variable SUBJECT_CODE has not been defined. Please set it to the correct value for this paper) PAPER_NUMBER?=$(error The required variable PAPER_NUMBER has not been defined. Please set it to the correct value for this paper) ################################################################################ # # Specify the base name(s) for the document source file(s). It may be a list. # THIS MUST BE DEFINED! # BASE_NAMES?=$(error The required variable BASE_NAME has not been defined. Please set it to the base name(s) of the document source file(s)) ################################################################################ # # Directory to install files into on web server. This is (usually) .../Misc/name of # build directory, to avoid similarly-named files overwriting each other. # BUILD_DIR:=$(lastword $(subst /, ,$(CURDIR))) INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/Misc/$(BUILD_DIR) ################################################################################ # # Does this document have questions with associated answers that can be # shown or hidden? Define this variable (any value) to enable the targets # for this. Note that setting this will generate "questions" and "answers" # output for ALL targets, regardless of whether this is actually relevant. # This already happens with the handbooks anyway, so no real problem :) # You can always add the redundant files to the TIDY_FILES variable. # HAS_ANSWERS= ################################################################################ # # Standard file list variables. # Note that anything included in any of these variables (particularly the # FILES variables) will cause ALL of the relevant print or web targets to # be rebuilt, regardless of whether they are actually prerequisites. This # can be slightly annoying if some of the files are only relevant to one # target. To avoid this effect, define a custom rule at the bottom of # this file. # # List of images used in the print version as actual content. # PRINT_IMAGES= # # List of other files used in the print version as actual content. # PRINT_FILES= # # List of images used in the web version as actual content. # WEB_IMAGES= # # List of other files used in the web version as actual content. # WEB_FILES= # # Files to be cleaned by the various "clean" targets. The "standard" values # are currently: # TIDY_FILES=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi \ # *-derived.xml $(derived .tex files) # CLEAN_FILES=*.aux $(IMGDIR)/*-print.pdf $(IMGDIR)/*-print.png \ # $(IMGDIR)/*-web.png $(IMGDIR)/*-web-zoom.png \ # $(derived HTML files) $(derived PDF files) # # $(TIDY_FILES) is a list of generated intermediate files to clean up. # TIDY_FILES= # # $(CLEAN_FILES) is everything else that might need to be cleaned up. # CLEAN_FILES= ################################################################################ # # Specify LaTeX document options (comma-separated list). The "standard" # value is currently: pdftex,usepdftitle=false,$(DRAFT).If you want to # override the "standard" options, redefine this variable after the # include line just below. # LATEX_OPTS= # # List of "phony" build targets (remember to define rules for # them!). The "standard" list is currently: # all debug test clean tidy targets web print print2up # TARGETS= ################################################################################ # # Add custom variables below here as necessary. # ################################################################################ # # Include standard variables and rules for building miscellaneous documents. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_misc_rules.make ################################################################################ # # Add custom rules below here as necessary. # # If a custom rule has the same target and prerequisite as a default rule, # it overrides the default rule. If you want to replace it with a similar # but different target and prerequisite, cancel the existing rule first, # e.g.: # # %.foo : %.bar ################################################################################ # # File: $Id$ # # Template makefile for building a general document. # ################################################################################ SHELL = /bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Clear out the suffixes list. DO NOT ALTER THIS LINE! # .SUFFIXES: # # Add any custom suffixes here (uncomment the line below). # The "standard" suffixes list currently includes: # .svg .pdf .tex .dvi .png .tif .plo .jpg .pict .eps .ps .R .xml # # .SUFFIXES: ################################################################################ # # Define paths for various items here. The "standard" paths currently include: # # vpath %.pdf $(IMGDIR) # vpath %.png $(IMGDIR) # vpath %.tif $(IMGDIR) # vpath %.jpg $(IMGDIR) # vpath %.plo $(IMGDIR) # vpath %.ps $(IMGDIR) # vpath %.eps $(IMGDIR) # vpath %.svg $(IMGDIR) # vpath %.pict $(IMGDIR) # vpath %.R $(IMGDIR) # # There's nothing to stop you adding new paths for these file types. # # vpath foo bar ################################################################################ # # Specify the current subject code and paper number. # THESE MUST BE DEFINED! # SUBJECT_CODE?=$(error The required variable SUBJECT_CODE has not been defined. Please set it to the correct value for this paper) PAPER_NUMBER?=$(error The required variable PAPER_NUMBER has not been defined. Please set it to the correct value for this paper) ################################################################################ # # Specify the base name(s) for the document source file(s). It may be a list. # THIS MUST BE DEFINED! # BASE_NAMES?=$(error The required variable BASE_NAME has not been defined. Please set it to the base name(s) of the document source file(s)) ################################################################################ # # Directory to install files into on web server. This is (usually) .../Misc/name of # build directory, to avoid similarly-named files overwriting each other. # BUILD_DIR:=$(lastword $(subst /, ,$(CURDIR))) INSTALL_DIRECTORY:=$(HANDBOOK_INSTALL_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)/Misc/$(BUILD_DIR) ################################################################################ # # Does this document have questions with associated answers that can be # shown or hidden? Define this variable (any value) to enable the targets # for this. Note that setting this will generate "questions" and "answers" # output for ALL targets, regardless of whether this is actually relevant. # This already happens with the handbooks anyway, so no real problem :) # You can always add the redundant files to the TIDY_FILES variable. # HAS_ANSWERS= ################################################################################ # # Standard file list variables. # Note that anything included in any of these variables (particularly the # FILES variables) will cause ALL of the relevant print or web targets to # be rebuilt, regardless of whether they are actually prerequisites. This # can be slightly annoying if some of the files are only relevant to one # target. To avoid this effect, define a custom rule at the bottom of # this file. # # List of images used in the print version as actual content. # PRINT_IMAGES= # # List of other files used in the print version as actual content. # PRINT_FILES= # # List of images used in the web version as actual content. # WEB_IMAGES= # # List of other files used in the web version as actual content. # WEB_FILES= # # Files to be cleaned by the various "clean" targets. The "standard" values # are currently: # TIDY_FILES=*.tmp *.out *.log *.nav *.toc *.snm *.head *.dvi \ # *-derived.xml $(derived .tex files) # CLEAN_FILES=*.aux $(IMGDIR)/*-print.pdf $(IMGDIR)/*-print.png \ # $(IMGDIR)/*-web.png $(IMGDIR)/*-web-zoom.png \ # $(derived HTML files) $(derived PDF files) # # $(TIDY_FILES) is a list of generated intermediate files to clean up. # TIDY_FILES= # # $(CLEAN_FILES) is everything else that might need to be cleaned up. # CLEAN_FILES= ################################################################################ # # Specify LaTeX document options (comma-separated list). The "standard" # value is currently: pdftex,usepdftitle=false,$(DRAFT).If you want to # override the "standard" options, redefine this variable after the # include line just below. # LATEX_OPTS= # # List of "phony" build targets (remember to define rules for # them!). The "standard" list is currently: # all debug test clean tidy targets web print print2up # TARGETS= ################################################################################ # # Add custom variables below here as necessary. # ################################################################################ # # Include standard variables and rules for building miscellaneous documents. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_misc_rules.make ################################################################################ # # Add custom rules below here as necessary. # # If a custom rule has the same target and prerequisite as a default rule, # it overrides the default rule. If you want to replace it with a similar # but different target and prerequisite, cancel the existing rule first, # e.g.: # # %.foo : %.bar

Ignore Space Show notes View makefile-templates/Makefile.section

################################################################################ # # Template makefile for building a complete section of the handbook (e.g., # Tutorials). Place a copy of this file in the directory for each section, # and modify as appropriate. The default makefile rebuilds all the # documents within that section, using recursive make calls to each # document. Most of the work is done by the include files, and should # cater for almost all cases. However, if custom rules are needed for a # section, they can be appended to the end of the section's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include standard variables and rules for building a section. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_section_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+= ################################################################################ # # File: $Id$ # # Template makefile for building a complete section of the handbook (e.g., # Tutorials). Place a copy of this file in the directory for each section, # and modify as appropriate. The default makefile rebuilds all the # documents within that section, using recursive make calls to each # document. Most of the work is done by the include files, and should # cater for almost all cases. However, if custom rules are needed for a # section, they can be appended to the end of the section's makefile. # ################################################################################ SHELL=/bin/sh ################################################################################ # # Required Environment Variables # # TEACHING_SHARED # This variable specifies the path to the top level of the teaching # shared directory hierarchy (e.g., /path/to/Teaching/Shared). # TEACHING_SHARED?=$(error The required environment variable TEACHING_SHARED has not been defined. It should point to the root level of the shared teaching directory (e.g., /path/to/Teaching/Shared)) # # ALL_PAPERS_ROOT # This variable specifies the path to the top level directory for all # papers taught, i.e., the directory that contains the individual paper # directory hierarchies. For example, /path/to/Teaching/2005. # ALL_PAPERS_ROOT?=$(error The required environment variable ALL_PAPERS_ROOT has not been defined. It should point to the root level of the current teaching directory hierarchy (e.g., /path/to/Teaching/2005)) # # HANDBOOK_INSTALL_ROOT # This variable specifies the path to the top level directory on the web # server, under which the files for this paper will be installed (that is, # the directory that contains the individual paper directory hierarchies). # For example, \\INFO-NTS-12\DBCourses$ (this may require munging). # HANDBOOK_INSTALL_ROOT?=$(error The required environment variable HANDBOOK_INSTALL_ROOT has not been defined. It should point to the root level of the directory hierarchy on the web server (e.g., \\INFO-NTS-12\DBCourses$)) ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and is defined relative to the root of that hierarchy. # # LOCAL_HANDBOOK_INCLUDE is the local include directory for this # particular paper, and is defined relative to the current execution # directory. We are assuming a fixed directory structure here! We can't # really do this as an environment variable because the full path will be # different for each paper, and we can't use the variables from # paper_variables.make to set the path, because that file is in the # include directory! <head spins> We will, however, allow for the # possibility of someone wanting to define this as an environment variable # by making it a conditional assignment. # GLOBAL_HANDBOOK_INCLUDE?=$(TEACHING_SHARED)/Authoring/Handbook/make-includes export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes ################################################################################ # # Include local system-specific configuration. # include $(GLOBAL_HANDBOOK_INCLUDE)/local_configuration.make ################################################################################ # # Include standard variables and rules for building a section. # include $(GLOBAL_HANDBOOK_INCLUDE)/build_section_rules.make ################################################################################ # # Add custom rules below here, as necessary. Add files to be deleted to the # variables below, as appropriate. # # WEB_CLEAN_FILES+= # PRINT_CLEAN_FILES+= # ALL_CLEAN_FILES+=

Ignore Space Show notes View makefile-templates/answers.patterns

################################################################################ # # Defines patterns for lists of documents to be generated for the # handbook. For example, only generate Tutorials 1, 2, 4, 6-9 and 11. # Patterns for different categories are kept in different files so # that rules can depend on them independently if necessary. # ################################################################################ ################################################################################ # # Which documents to generate answers for (where applicable). # TUT_ANSWERS_PATTERN:='tut\(0[1-9]\|1[012]\)' LAB_ANSWERS_PATTERN:='lab\(0[1-9]\|1[012]\)' OTHER_ANSWERS_PATTERNS:='course_outline' 'intro' 'case_study' ANSWERS_PATTERNS+=$(TUT_ANSWERS_PATTERN) $(LAB_ANSWERS_PATTERN) \ $(OTHER_ANSWERS_PATTERNS) ################################################################################ # # File: $Id$ # # Defines patterns for lists of documents to be generated for the # handbook. For example, only generate Tutorials 1, 2, 4, 6-9 and 11. # Patterns for different categories are kept in different files so # that rules can depend on them independently if necessary. # ################################################################################ ################################################################################ # # Which documents to generate answers for (where applicable). # TUT_ANSWERS_PATTERN:='tut\(0[1-9]\|1[012]\)' LAB_ANSWERS_PATTERN:='lab\(0[1-9]\|1[012]\)' OTHER_ANSWERS_PATTERNS:='course_outline' 'intro' 'case_study' ANSWERS_PATTERNS+=$(TUT_ANSWERS_PATTERN) $(LAB_ANSWERS_PATTERN) \ $(OTHER_ANSWERS_PATTERNS)

Ignore Space Show notes View makefile-templates/install.patterns

################################################################################ # # Defines patterns for lists of documents to be installed on the # web server. For example, only install Tutorials 1, 2, 4, 6-9 and 11. # Patterns for different categories are kept in different files so # that rules can depend on them independently if necessary. # ################################################################################ ################################################################################ # # Which documents to install on the web server. # TUT_QUESTIONS_INSTALL_PATTERN:='tut\(0[1-9]\|1[01]\)' TUT_ANSWERS_INSTALL_PATTERN:='tut\(0[1-9]\|1[01]\)' LAB_QUESTIONS_INSTALL_PATTERN:='lab\(0[1-9]\|1[012]\)' LAB_ANSWERS_INSTALL_PATTERN:='lab\(0[1-9]\|1[012]\)' OTHER_QUESTIONS_INSTALL_PATTERNS:='handbook_root' 'course_outline' 'intro' 'case_study' OTHER_ANSWERS_INSTALL_PATTERNS:='handbook_root' 'course_outline' 'intro' 'case_study' QUESTION_INSTALL_PATTERNS+=$(TUT_QUESTIONS_INSTALL_PATTERN) \ $(LAB_QUESTIONS_INSTALL_PATTERN) $(OTHER_QUESTIONS_INSTALL_PATTERNS) ANSWER_INSTALL_PATTERNS+=$(TUT_ANSWERS_INSTALL_PATTERN) \ $(LAB_ANSWERS_INSTALL_PATTERN) $(OTHER_ANSWERS_INSTALL_PATTERNS) ################################################################################ # # File: $Id$ # # Defines patterns for lists of documents to be installed on the # web server. For example, only install Tutorials 1, 2, 4, 6-9 and 11. # Patterns for different categories are kept in different files so # that rules can depend on them independently if necessary. # ################################################################################ ################################################################################ # # Which documents to install on the web server. # TUT_QUESTIONS_INSTALL_PATTERN:='tut\(0[1-9]\|1[01]\)' TUT_ANSWERS_INSTALL_PATTERN:='tut\(0[1-9]\|1[01]\)' LAB_QUESTIONS_INSTALL_PATTERN:='lab\(0[1-9]\|1[012]\)' LAB_ANSWERS_INSTALL_PATTERN:='lab\(0[1-9]\|1[012]\)' OTHER_QUESTIONS_INSTALL_PATTERNS:='handbook_root' 'course_outline' 'intro' 'case_study' OTHER_ANSWERS_INSTALL_PATTERNS:='handbook_root' 'course_outline' 'intro' 'case_study' QUESTION_INSTALL_PATTERNS+=$(TUT_QUESTIONS_INSTALL_PATTERN) \ $(LAB_QUESTIONS_INSTALL_PATTERN) $(OTHER_QUESTIONS_INSTALL_PATTERNS) ANSWER_INSTALL_PATTERNS+=$(TUT_ANSWERS_INSTALL_PATTERN) \ $(LAB_ANSWERS_INSTALL_PATTERN) $(OTHER_ANSWERS_INSTALL_PATTERNS)

Ignore Space Show notes View makefile-templates/paper_variables.make

################################################################################ # # Set up variables that specify the current paper. These are mostly used # as parameters to the XSLT processor when generating documents. # ################################################################################ ################################################################################ # # Set up variables for the current paper. # SUBJECT_CODE:=INFO PAPER_NUMBER:=212 PAPER_TITLE:=Database Design and Management PAPER_YEAR:=2011 PAPER_PERIOD:=Semester 1 HANDBOOK_AUTHORS:=Chris Edwards and Nigel Stanger ################################################################################ # # Define the root directory for this paper. ALL_PAPERS_ROOT is an # environment variable that contains the path to the top level directory # for all papers (e.g., /path/to/Teaching/2005). # PAPER_ROOT:=$(ALL_PAPERS_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER) ################################################################################ # # File: $Id$ # # Set up variables that specify the current paper. These are mostly used # as parameters to the XSLT processor when generating documents. # ################################################################################ ################################################################################ # # Set up variables for the current paper. # SUBJECT_CODE:=INFO PAPER_NUMBER:=212 PAPER_TITLE:=Database Design and Management PAPER_YEAR:=2011 PAPER_PERIOD:=Semester 1 HANDBOOK_AUTHORS:=Chris Edwards and Nigel Stanger ################################################################################ # # Define the root directory for this paper. ALL_PAPERS_ROOT is an # environment variable that contains the path to the top level directory # for all papers (e.g., /path/to/Teaching/2005). # PAPER_ROOT:=$(ALL_PAPERS_ROOT)/$(SUBJECT_CODE)$(PAPER_NUMBER)

Ignore Space Show notes View makefile-templates/questions.patterns

################################################################################ # # Defines patterns for lists of documents to be generated for the # "questions" version of the handbook. For example, only generate # Tutorials 1, 2, 4, 6-9 and 11. Patterns for different categories are # kept in different files so that rules can depend on them independently # if necessary. # ################################################################################ ################################################################################ # # You can be selective about which documents to include here by changing # the find patterns. The \input{}s in the master handbook.tex file will be # regenerated automatically. # TUT_QUESTIONS_PATTERN:='tut\(0[1-9]\|1[01]\)' LAB_QUESTIONS_PATTERN:='lab\(0[1-9]\|1[012]\)' OTHER_QUESTIONS_PATTERNS:='course_outline' 'intro' 'case_study' QUESTIONS_PATTERNS+=$(TUT_QUESTIONS_PATTERN) $(LAB_QUESTIONS_PATTERN) \ $(OTHER_QUESTIONS_PATTERNS) ################################################################################ # # File: $Id$ # # Defines patterns for lists of documents to be generated for the # "questions" version of the handbook. For example, only generate # Tutorials 1, 2, 4, 6-9 and 11. Patterns for different categories are # kept in different files so that rules can depend on them independently # if necessary. # ################################################################################ ################################################################################ # # You can be selective about which documents to include here by changing # the find patterns. The \input{}s in the master handbook.tex file will be # regenerated automatically. # TUT_QUESTIONS_PATTERN:='tut\(0[1-9]\|1[01]\)' LAB_QUESTIONS_PATTERN:='lab\(0[1-9]\|1[012]\)' OTHER_QUESTIONS_PATTERNS:='course_outline' 'intro' 'case_study' QUESTIONS_PATTERNS+=$(TUT_QUESTIONS_PATTERN) $(LAB_QUESTIONS_PATTERN) \ $(OTHER_QUESTIONS_PATTERNS)

Show line notes below