- Added include and template files for new handbook infrastructure.

nigel.stanger / Handbook

Browse code - Added include and template files for new handbook infrastructure. master
0 parent commit c382c986213986208fda984298d7e57523569f55 nstanger authored on 19 Jan 2005

Patch

Showing 8 changed files

Ignore Space Show notes View make-includes/build_content_rules.make 0 → 100755
################################################################################ # # 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 :) # ################################################################################ ################################################################################ # # 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/source, # and derived versions should normally be placed in ./graphics. 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 %.eps graphics ################################################################################ # # 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 correctly cropped EPS (for printing) from original source EPS. # %-print.pdf: %.eps @announce "Generating $@ (print)" @ps2pdf -dEPSCrop -dNOCACHE $< $@ @mv $@ $(BUILD_DIR) ################################################################################ # # Build correctly cropped PNGs for web display from the original source # EPS. # # It might seem to make more sense to generate the PNGs from the print # EPS, which has already been appropriately cropped. 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)" @gs -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -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)" @gs -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -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 -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r600 \ # -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $< # @mv $@ $(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: @echo "GLOBAL_HANDBOOK_INCLUDE = [$(GLOBAL_HANDBOOK_INCLUDE)]" @echo "LOCAL_HANDBOOK_INCLUDE = [$(LOCAL_HANDBOOK_INCLUDE)]" @echo "BUILD_DIR = [$(BUILD_DIR)]" ################################################################################ # # Print out the list of targets. Handy for when you forget! # targets: @echo $(TARGETS)

Ignore Space Show notes View

make-includes/build_content_rules.make 0 → 100755

################################################################################
#
# 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 :)
#
################################################################################

################################################################################
#
# 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/source,
# and derived versions should normally be placed in ./graphics. 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 %.eps graphics

.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 correctly cropped EPS (for printing) from original source EPS.
#
%-print.pdf: %.eps
	@announce "Generating $@ (print)"
	@ps2pdf -dEPSCrop -dNOCACHE $< $@
	@mv $@ $(BUILD_DIR)

################################################################################
#
# Build correctly cropped PNGs for web display from the original source
# EPS.
#
# It might seem to make more sense to generate the PNGs from the print
# EPS, which has already been appropriately cropped. 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)"
	@gs -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -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)"
	@gs -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -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 -dNOPAUSE -dBATCH -dSAFER -sDEVICE=png16m -dEPSCrop -r600 \
# 		-dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sOutputFile=$@ $<
# 	@mv $@ $(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

################################################################################
#
# 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 0 → 100755
################################################################################ # # 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 ################################################################################ # # 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. # 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) ################################################################################ # # Lists of files for cleaning up. Add to these (using +=) as necessary in # derived makefiles. # WEB_CLEAN_FILES:=$(DERIVED_WEB_FILES) .png PRINT_CLEAN_FILES:=$(DERIVED_PRINT_FILES) .pdf ALL_CLEAN_FILES:=$(DERIVED_XML) $(WEB_CLEAN_FILES) $(PRINT_CLEAN_FILES) ################################################################################ # # Extract the list of included filenames from the source template. Hooray # for the shell function and Perl! Include file paths are delimited by # <@INC[ ]@>. All paths are relative to $(PAPER_ROOT). We don't use # $(PAPER_ROOT)/$(SECTION), because some the include directories may be in # relatively arbitrary locations. # CONTENT_SRC:=$(shell perl -ne 'print "$(PAPER_ROOT)/$(notdir $(SECTION))/$$1\n" if /<\@INC\[([^]]+)\]@>/;' $(SOURCE_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 \ 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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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. The Big # Ugly Regexp matches any file include directive (<@INC[ ]@>) and the # script then simply inserts the content of that file into the output # stream. This saves us having to fool around with XML document includes, # which basically just don't work for us because they expect the included # document to be a valid XML document. We really just want to include XML # fragments. XInclude 1.0 supports this, but it's only just been finalised # at the time of writing (January 2005). # $(DERIVED_XML): $(SOURCE_XML) @announce "Generating $@" @perl -ne 'if (/^(.)<\@INC\[([^]]+)\]@>(.)$$/) { print "$$1\n" . `cat $(PAPER_ROOT)/$(SECTION)/$$2` . "\n$$3\n"; } else { print; }' $< > $@ ################################################################################ # # 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 "cat</dev/null" 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)) cat</dev/null;) \ fi # Remake each individual content file. @if test ! -f content-checked; then \ $(foreach f,$(CONTENT_SRC),$(MAKE) -C $(dir $f) $(notdir $f) BUILD_DIR=$(CURDIR);) \ 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 ################################################################################ # # Clean up. # clean: web-clean print-clean -rm -f $(ALL_CLEAN_FILES) web-clean: -rm -f $(WEB_CLEAN_FILES) print-clean: -rm -f $(PRINT_CLEAN_FILES) ################################################################################ # # Debugging information, mostly lists of the generated variables. # debug: @echo "NOINIT = [$(NOINIT)]" @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_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 "CONTENT_SRC = [$(CONTENT_SRC)]" @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_document_rules.make 0 → 100755

################################################################################
#
# 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

################################################################################
#
# 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.
#
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)

################################################################################
#
# Lists of files for cleaning up. Add to these (using +=) as necessary in
# derived makefiles.
#
WEB_CLEAN_FILES:=$(DERIVED_WEB_FILES) *.png
PRINT_CLEAN_FILES:=$(DERIVED_PRINT_FILES) *.pdf
ALL_CLEAN_FILES:=$(DERIVED_XML) $(WEB_CLEAN_FILES) $(PRINT_CLEAN_FILES)

################################################################################
#
# Extract the list of included filenames from the source template. Hooray
# for the shell function and Perl! Include file paths are delimited by
# <@INC[ ]@>. All paths are relative to $(PAPER_ROOT). We don't use
# $(PAPER_ROOT)/$(SECTION), because some the include directories may be in
# relatively arbitrary locations.
#
CONTENT_SRC:=$(shell perl -ne 'print "$(PAPER_ROOT)/$(notdir $(SECTION))/$$1\n" if /<\@INC\[([^]]+)\]@>/;' $(SOURCE_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 \
	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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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,department,'$(SUBJECT_CODE)'),$(call xslt_parameter,paper,'$(PAPER_NUMBER)'),$(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. The Big
# Ugly Regexp matches any file include directive (<@INC[ ]@>) and the
# script then simply inserts the content of that file into the output
# stream. This saves us having to fool around with XML document includes,
# which basically just don't work for us because they expect the included
# document to be a valid XML document. We really just want to include XML
# fragments. XInclude 1.0 supports this, but it's only just been finalised
# at the time of writing (January 2005).
#
$(DERIVED_XML): $(SOURCE_XML)
	@announce "Generating $@"
	@perl -ne 'if (/^(.*)<\@INC\[([^]]+)\]@>(.*)$$/) { print "$$1\n" . `cat $(PAPER_ROOT)/$(SECTION)/$$2` . "\n$$3\n"; } else { print; }'  $< > $@

################################################################################
#
# 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 "cat</dev/null" 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)) cat</dev/null;) \
	fi
# Remake each individual content file.
	@if test ! -f content-checked; then \
		$(foreach f,$(CONTENT_SRC),$(MAKE) -C $(dir $f) $(notdir $f) BUILD_DIR=$(CURDIR);) \
	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

################################################################################
#
# Clean up.
#
clean: web-clean print-clean
	-rm -f $(ALL_CLEAN_FILES)

web-clean:
	-rm -f $(WEB_CLEAN_FILES)

print-clean:
	-rm -f $(PRINT_CLEAN_FILES)

################################################################################
#
# Debugging information, mostly lists of the generated variables.
#
debug:
	@echo "NOINIT = [$(NOINIT)]"
	@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_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 "CONTENT_SRC = [$(CONTENT_SRC)]"
	@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_section_rules.make 0 → 100755
################################################################################ # # 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 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 ################################################################################ # # 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. # 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)))) ANSWER_SRC_DIRS:=$(foreach p,$(ANSWERS_PATTERNS),$(notdir $(shell find . -regex './'$(p)))) # # 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)}) ################################################################################ # # 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 \ 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. # web: web-questions web-answers web-questions: @$(foreach d,$(QUESTION_SRC_DIRS),$(MAKE) -C $d web-questions;) web-answers: @$(foreach d,$(ANSWER_SRC_DIRS),$(MAKE) -C $d web-answers;) ################################################################################ # # 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),$(MAKE) -C $d print-questions;) 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),$(MAKE) -C $d $d-questions.pdf $d-questions-2up.pdf;) print-answers: print-answer-docs answer-manifest.tex print-answer-docs: @$(foreach d,$(ANSWER_SRC_DIRS),$(MAKE) -C $d print-answers;) 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,$(QUESTION_SRC_DIRS),$(MAKE) -C $d $d-answers.pdf $d-answers-2up.pdf;) ################################################################################ # # 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 $@;) -rm -f $(ALL_CLEAN_FILES) web-clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) -rm -f $(WEB_CLEAN_FILES) print-clean: @$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;) -rm -f $(PRINT_CLEAN_FILES) # # "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: @echo "NOINIT = [$(NOINIT)]" @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 "SECTION = [$(SECTION)]" @echo "QUESTION_SRC_DIRS = [$(QUESTION_SRC_DIRS)]" @echo "ANSWER_SRC_DIRS = [$(ANSWER_SRC_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 "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_section_rules.make 0 → 100755

################################################################################
#
# 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!
#
################################################################################

# 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

################################################################################
#
# 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.
#
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))))

ANSWER_SRC_DIRS:=$(foreach p,$(ANSWERS_PATTERNS),$(notdir $(shell find . -regex '.*/'$(p))))

#
# 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)})

################################################################################
#
# 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 \
	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.
#
web: web-questions web-answers

web-questions:
	@$(foreach d,$(QUESTION_SRC_DIRS),$(MAKE) -C $d web-questions;)

web-answers:
	@$(foreach d,$(ANSWER_SRC_DIRS),$(MAKE) -C $d web-answers;)

################################################################################
#
# 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),$(MAKE) -C $d print-questions;)

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),$(MAKE) -C $d $d-questions.pdf $d-questions-2up.pdf;)

print-answers: print-answer-docs answer-manifest.tex

print-answer-docs:
	@$(foreach d,$(ANSWER_SRC_DIRS),$(MAKE) -C $d print-answers;)

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,$(QUESTION_SRC_DIRS),$(MAKE) -C $d $d-answers.pdf $d-answers-2up.pdf;)

################################################################################
#
# 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 $@;)
	-rm -f $(ALL_CLEAN_FILES)

web-clean:
	@$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;)
	-rm -f $(WEB_CLEAN_FILES)

print-clean:
	@$(foreach d,$(CLEAN_DIRS),$(MAKE) -C $d $@;)
	-rm -f $(PRINT_CLEAN_FILES)

#
# "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:

################################################################################
#
# Print out the list of targets. Handy for when you forget!
#
targets:
	@echo $(TARGETS)

Ignore Space Show notes View make-includes/remove_content_marker_files.make 0 → 100755
################################################################################ # # 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/remove_content_marker_files.make 0 → 100755

################################################################################
#
# 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/xslt_functions.make 0 → 100755
################################################################################ # # File: $Id$ # # Make functions for handling XSLT tasks. # ################################################################################ ################################################################################ # # 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)))) ################################################################################ # # 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!! # # 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) $(1) $(2) # # Xalan-J # xalanj = xalan -in $(1) -xsl $(2) $(3) $(4) $(5) $(6) $(7) $(8) # # 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) ################################################################################ # # 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 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. # xslt = $(if $(findstring $(XSLT),'xalan-c'),$(call xalanc,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8)),$(if $(findstring $(XSLT),'xalan-j'),$(call xalanj,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8)),$(if $(findstring $(XSLT),'saxon'),$(call saxon,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8))))) # 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

make-includes/xslt_functions.make 0 → 100755

################################################################################
#
# File: $Id$
#
# Make functions for handling XSLT tasks.
#
################################################################################

################################################################################
#
# 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))))

################################################################################
#
# 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!!
# 
# 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) $(1) $(2)

#
# Xalan-J
#
xalanj = xalan -in $(1) -xsl $(2) $(3) $(4) $(5) $(6) $(7) $(8)

#
# 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)

################################################################################
#
# 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 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.
#
xslt = $(if $(findstring $(XSLT),'xalan-c'),$(call xalanc,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8)),$(if $(findstring $(XSLT),'xalan-j'),$(call xalanj,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8)),$(if $(findstring $(XSLT),'saxon'),$(call saxon,$(1),$(2),$(3),$(4),$(5),$(6),$(7),$(8)))))

# 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 0 → 100755
################################################################################ # # 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 ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and should ideally be defined as an environment variable. # It's an error not to define this variable. # # 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?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined) LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined) ################################################################################ # # 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.content 0 → 100755

################################################################################
#
# 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

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and should ideally be defined as an environment variable.
# It's an error not to define this variable.
#
# 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?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined)

LOCAL_HANDBOOK_INCLUDE?=$(error The environment variable LOCAL_HANDBOOK_INCLUDE has not been defined)

################################################################################
#
# 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 0 → 100755
################################################################################ # # 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 ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and should ideally be defined as an environment variable. # It's an error not to define this variable. # # 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?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined) export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes ################################################################################ # # 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.document 0 → 100755

################################################################################
#
# 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

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and should ideally be defined as an environment variable.
# It's an error not to define this variable.
#
# 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?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined)

export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../../..; pwd)/make-includes

################################################################################
#
# 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.section 0 → 100755
################################################################################ # # 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 ################################################################################ # # Set up paths to makefile include directories. # # GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared" # hierarchy, and should ideally be defined as an environment variable. # It's an error not to define this variable. # # 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?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined) export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes ################################################################################ # # 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/Makefile.section 0 → 100755

################################################################################
#
# 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

################################################################################
#
# Set up paths to makefile include directories.
#
# GLOBAL_HANDBOOK_INCLUDE is the global include directory in the "Shared"
# hierarchy, and should ideally be defined as an environment variable.
# It's an error not to define this variable.
#
# 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?=$(error The environment variable GLOBAL_HANDBOOK_INCLUDE has not been defined)

export LOCAL_HANDBOOK_INCLUDE?=$(shell cd ../..; pwd)/make-includes

################################################################################
#
# Include standard variables and rules for building a section.
#
include $(GLOBAL_HANDBOOK_INCLUDE)/build_section_rules.make

Show line notes below