documentation/manual/en/Makefile.in

   1 #
   2 # Zend Framework
   3 #
   4 # LICENSE
   5 #
   6 # This source file is subject to the new BSD license that is bundled
   7 # with this package in the file LICENSE.txt.
   8 # It is also available through the world-wide-web at this URL:
   9 # http://framework.zend.com/license/new-bsd
  10 # If you did not receive a copy of the license and are unable to
  11 # obtain it through the world-wide-web, please send an email
  12 # to license@zend.com so we can send you a copy immediately.
  13 #
  14 # @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  15 # @license    http://framework.zend.com/license/new-bsd     New BSD License
  16 #
  17
  18 #
  19 # Makefile - build Zend Framework product and documentation
  20 #
  21 # Main targets:
  22 #  all - render DocBook manual in HTML.
  23 #  clean - remove staged files.
  24 #  check - validate DocBook manual using xmllint.
  25 #  check1 - validate one DocBook XML file using xmllint.
  26 #    Requires that you set the XMLFILE variable.
  27 #  pdf-print - PDF version of manual, in two volumes; requires Apache FOP
  28 #
  29
  30 # -- parameters you are likely to want to change --
  31
  32 # XMLFILE is the name of one DocBook XML file that you want to
  33 #   test with xmllint, using the 'check1' target.
  34
  35 XSLTPROC=@XSLTPROC@
  36 XMLLINT=@XMLLINT@
  37 FOP=@FOP@
  38 ECSRC=@ECSRC@
  39 HERE=@HERE@
  40
  41 DOCBOOK_DTD?=http://framework.zend.com/docbook/xml/4.5/docbookx.dtd
  42 DOCBOOK_XSL?=http://framework.zend.com/docbook-xsl/htmlhelp/htmlhelp.xsl
  43 DOCBOOK_FO_XSL?=http://framework.zend.com/docbook-xsl/fo/docbook.xsl
  44 HTML_XSL=html.xsl
  45 MANUAL_XML=manual.xml
  46 MANUAL_PRINT1_XML=manual-print1.xml
  47 MANUAL_PRINT2_XML=manual-print2.xml
  48 MANUAL_LINT_XML=../en/manual-lint.xml.in
  49 MODULE=module_specs
  50 PDF_XSL=pdf-manual.xsl
  51 XMLFILE=
  52
  53 all:    $(MANUAL_XML) html
  54
  55 # Build the docs in HTML format
  56
  57 html: html/index.html
  58
  59 html/index.html: $(MANUAL_XML) $(HTML_XSL)
  60         @echo "Rendering the whole manual with $(XSLTPROC)..."
  61         $(XMLLINT) --xinclude --output _temp_manual.xml $(MANUAL_XML)
  62         $(XSLTPROC) --xinclude --output html/index.html $(HTML_XSL) _temp_manual.xml
  63         @echo "Copying manual figures (recursively)..."
  64         -[ -d figures ] && cp -r figures html/
  65
  66 $(MANUAL_XML): ../en/$(MANUAL_XML).in
  67         sed -e 's!@DOCBOOK_DTD@!$(DOCBOOK_DTD)!' $< > $@
  68
  69 $(HTML_XSL): ../en/$(HTML_XSL).in
  70         sed -e 's!@DOCBOOK_XSL@!$(DOCBOOK_XSL)!' $< > $@
  71
  72 # Build the docs in PDF format
  73
  74 pdf-print: pdf-print-volume1 pdf-print-volume2
  75
  76 pdf-dir:
  77         @if [ ! -e pdf ]; then \
  78                 mkdir pdf; \
  79         fi
  80
  81 pdf: pdf-dir $(MANUAL_XML) $(PDF_XSL)
  82         @echo "Rendering of the PDF manual with $(FOP)..."
  83         $(XMLLINT) --xinclude --output _temp_manual.xml $(MANUAL_XML)
  84         $(XSLTPROC) --xinclude --output ZendFramework.fo $(PDF_XSL) _temp_manual.xml
  85         "$(FOP)" -fo ZendFramework.fo -pdf pdf/ZendFramework.pdf
  86
  87 pdf-print-volume1: pdf-dir $(PDF_XSL) $(MANUAL_PRINT1_XML)
  88         @echo "Rendering volume 1 of the PDF manual with $(FOP)..."
  89         $(XMLLINT) --xinclude --output _temp_manual_1.xml $(MANUAL_PRINT1_XML)
  90         $(XSLTPROC) --xinclude --output ZendFramework.fo $(PDF_XSL) _temp_manual_1.xml
  91         "$(FOP)" -fo ZendFramework.fo -pdf pdf/ZendFrameworkVolume1.pdf
  92
  93 pdf-print-volume2: pdf-dir $(PDF_XSL) $(MANUAL_PRINT2_XML)
  94         @echo "Rendering volume 2 of the PDF manual with $(FOP)..."
  95         $(XMLLINT) --xinclude --output _temp_manual_2.xml $(MANUAL_PRINT1_XML)
  96         $(XSLTPROC) --xinclude --output ZendFramework.fo $(PDF_XSL) _temp_manual_2.xml
  97         "$(FOP)" -fo ZendFramework.fo -pdf pdf/ZendFrameworkVolume2.pdf
  98
  99 $(MANUAL_PRINT1_XML): ../en/$(MANUAL_PRINT1_XML).in
 100         sed -e 's!@DOCBOOK_DTD@!$(DOCBOOK_DTD)!' $< > $@
 101
 102 $(MANUAL_PRINT2_XML): ../en/$(MANUAL_PRINT2_XML).in
 103         sed -e 's!@DOCBOOK_DTD@!$(DOCBOOK_DTD)!' $< > $@
 104
 105 $(PDF_XSL): ../en/$(PDF_XSL).in
 106         sed -e 's!@DOCBOOK_FO_XSL@!$(DOCBOOK_FO_XSL)!' $< > $@
 107
 108 # Cleanup
 109
 110 check: $(MANUAL_XML)
 111         @echo "Checking the whole manual with $(XMLLINT)..."
 112         @$(XMLLINT) --xinclude --output _temp_manual.xml $(MANUAL_XML)
 113         @$(XMLLINT) --valid --noout --postvalid _temp_manual.xml \
 114             && echo "OK"
 115
 116 check1: $(MANUAL_LINT_XML)
 117         @if [ -n "$(XMLFILE)" ] ; then \
 118             if [ -f "$(MODULE)/$(XMLFILE)" ] ; then \
 119                 echo "Checking $(XMLFILE) with $(XMLLINT)..." ; \
 120                 sed -e 's!@XMLFILE@!$(MODULE)/$(XMLFILE)!' -e 's!@DOCBOOK_DTD@!$(DOCBOOK_DTD)!' $(MANUAL_LINT_XML) \
 121                 | $(XMLLINT) --xinclude --output _temp_$(XMLFILE) - ; \
 122                 $(XMLLINT) --valid --noout --postvalid _temp_$(XMLFILE) \
 123                   && echo "OK" ; \
 124             else  \
 125                 echo "File $(MODULE)/$(XMLFILE) not found." ; \
 126             fi ; \
 127         else \
 128             echo "Please specify a filename, e.g. 'make XMLFILE=filename.xml lint'" ; \
 129         fi
 130
 131 clean:
 132         -rm -f html/*.html html/HTML.manifest
 133         @if [ -f html/figures ] ; then \
 134                 rm -Rf html/figures ; \
 135         fi
 136         -rm -f _temp_*.xml
 137         -rm -f /*.pdf
 138         -rm -f ZendFramework.fo
 139
 140 cleanall: clean
 141         -rm -f config.* configure
 142         -rm -rf autom4te.cache
 143         -rm -f Makefile
 144         -rm -f $(HTML_XSL) $(MANUAL_XML) $(MANUAL_PRINT1_XML) $(MANUAL_PRINT2_XML)