doc/tools/Makefile.base-vars

   1 # This file -  Makefile.base-vars - together with the file Makefile.base-rules,
   2 # make up a reusable buildsystem for DocBook XML books.
   3 # The split into two files is required because of the nature of Make variables:
   4 # In the case of variables used in commands, expansion occurs when the commands
   5 # are executed, so values can be overridden by defining a new value after the
   6 # rule definition - BUT in the case of variables used to specify targets and
   7 # sources, expansion occurs when Make parses the rule.  Therefore, any override
   8 # must take place BEFORE the rule definition.  Since this Makefile fragment
   9 # wishes to both provide defaults and allow overriding of target and source
  10 # file names, it is necessary to place the default variable definitions in
  11 # one file, and the rules in another, so that overrides may be specified
  12 # after the defaults, but before the rules - like this:
  13 #
  14 #   include ../tools/Makefile.base-vars
  15 #   NAME = my-book
  16 #   DIR = my-book-dir
  17 #   include ../tools/Makefile.base-rules
  18 #
  19 # Note that this is a Makefile fragment intended for inclusion.  As a result,
  20 # all relative paths contained within are relative to including Makefile's
  21 # directory, not to this fragment's directory.  The TOOLS_DIR and DIR variables
  22 # should be overridden if necessary to ensure proper paths are used.
  23
  24 # Paths which you may wish to customize:
  25 XSLTPROC = xsltproc
  26 XMLLINT = xmllint
  27 INSTALL_DIR = $(DESTDIR)/usr/share/doc/OVERRIDE_ME_WITH_SOMETHING_SUITABLE
  28 INSTALL_DATA = cp -r
  29 MKDIR = mkdir -p
  30 SVNVERSION = svnversion
  31
  32 # You should not normally need to edit anything below here.
  33 SHELL = /bin/sh
  34
  35 NAME = OVERRIDE_ME_WITH_THE_SHORT_FILESYSTEM_NAME_OF_YOUR_BOOK
  36 DIR = .
  37 IMAGES =
  38 TOOLS_DIR = ../tools
  39 OUTNAME = $(NAME)
  40
  41 HTML_CHUNK_DIR = $(DIR)/html-chunk
  42 HTML_TARGET = $(DIR)/$(OUTNAME).html
  43 # In the HTML chunk build, index.html is created last, so serves as an
  44 # acceptable timestamp file for the entire multi-file output.
  45 HTML_CHUNK_TARGET = $(HTML_CHUNK_DIR)/index.html
  46 ARCH_CMD = tar -jcvf
  47 ARCH_EXT = .tar.bz2
  48 HTML_ARCH_BASENAME = $(OUTNAME)-html
  49 HTML_CHUNK_ARCH_BASENAME = $(OUTNAME)-html-chunk
  50 HTML_ARCH_TARGET = $(DIR)/$(HTML_ARCH_BASENAME)$(ARCH_EXT)
  51 HTML_CHUNK_ARCH_TARGET = $(DIR)/$(HTML_CHUNK_ARCH_BASENAME)$(ARCH_EXT)
  52 PDF_TARGET = $(DIR)/$(OUTNAME).pdf
  53 PS_TARGET = $(DIR)/$(OUTNAME).ps
  54 FO_TARGET = $(DIR)/$(OUTNAME).fo
  55 XML_SOURCE = $(DIR)/$(NAME).xml
  56 VERSION_SOURCE = $(DIR)/version.xml
  57 ALL_SOURCE = $(DIR)/*.xml
  58 STYLESHEET = $(DIR)/styles.css
  59 INSTALL_SUBDIR = $(INSTALL_DIR)/$(NAME)
  60
  61 ENSURE_XSL = if ! test -e "$(TOOLS_DIR)/xsl"; \
  62              then $(TOOLS_DIR)/bin/find-xsl.py; fi
  63 IFIMAGES = if test -n "$(IMAGES)"; then
  64 ENDIF = ; fi
  65
  66 # Customization hooks for xsltproc options
  67 HTML_XSLTPROC_OPTS =
  68 FO_XSLTPROC_OPTS =
  69 # FO example: --stringparam page.height 9in --stringparam page.width 6.4in
  70
  71 # Uncomment the following line if you'd like to print on A4 paper
  72 # FO_XSLTPROC_OPTS = --stringparam paper.type A4
  73
  74 # Override in locale-specific Makefile to localize the word in the
  75 # auto-generated version file.
  76 L10N_REVISION = Revision