doc/Makefile

   1 # $Id: Makefile,v 1.13 2008/03/07 13:01:55 ggiunta Exp $\r
   2 \r
   3 ### USER EDITABLE VARS ###\r
   4 \r
   5 WEB=/var/www/xmlrpc/doc\r
   6 \r
   7 MKDIR=mkdir\r
   8 \r
   9 \r
  10 #### DO NOT TOUCH FROM HERE ONWARDS ###\r
  11 \r
  12 install:\r
  13         ${MKDIR} -p ${WEB}\r
  14         cp *.html ${WEB}\r
  15         cp *.css ${WEB}\r
  16         cp *.gif ${WEB}\r
  17         @echo HTML version of the manual has been installed to ${WEB}\r
  18 \r
  19 \r
  20 ### the following targets are to be used for library development ###\r
  21 \r
  22 doc: out/index.html xmlrpc_php.pdf javadoc-out/index.html\r
  23 \r
  24 # tools currently used in building docs: php 5 with xsl extension, apache fop, phpdocumentor\r
  25 # alternatives include doxygen, jade, saxon, xsltproc etc...\r
  26 \r
  27 out/index.html xmlrpc_php.pdf: xmlrpc_php.xml\r
  28         -${MKDIR} out\r
  29 # Jade cmd yet to be rebuilt, starting from xml file and putting output in ./out dir, e.g.\r
  30 #       jade -t xml -d custom.dsl xmlrpc_php.xml\r
  31 #\r
  32 # convertdoc command for xmlmind xxe editor\r
  33 #       convertdoc docb.toHTML xmlrpc_php.xml -u out\r
  34 #\r
  35 # saxon + xerces xml parser + saxon extensions + xslthl: adds a little syntax highligting\r
  36 # (bold and italics only, no color) for php source examples...\r
  37 #       java \\r
  38 #       -classpath c:\programmi\saxon\saxon.jar\;c:\programmi\saxon\xslthl.jar\;c:\programmi\xerces\xercesImpl.jar\;C:\htdocs\xmlrpc_cvs\docbook-xsl\extensions\saxon65.jar \\r
  39 #       -Djavax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl \\r
  40 #       -Djavax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl \\r
  41 #       -Dxslthl.config=file:///c:/htdocs/xmlrpc_cvs/docbook-xsl/highlighting/xslthl-config.xml \\r
  42 #       com.icl.saxon.StyleSheet -o xmlrpc_php.fo.xml xmlrpc_php.xml custom.fo.xsl use.extensions=1\r
  43 #\r
  44         # custom php script that does the xslt magic\r
  45         php convert.php xmlrpc_php.xml custom.xsl out/\r
  46         # post process html files to highlight php code samples\r
  47         php highlight.php out\r
  48         # convert to fo and then to pdf using apache fop\r
  49         php convert.php xmlrpc_php.xml custom.fo.xsl xmlrpc_php.fo.xml\r
  50         fop xmlrpc_php.fo.xml xmlrpc_php.pdf\r
  51         #-rm xmlrpc_php.fo.xml\r
  52 \r
  53 javadoc-out/index.html: ../xmlrpc.inc ../xmlrpcs.inc ../xmlrpc_wrappers.inc\r
  54 # generate docs out of javadoc via doxygen\r
  55 #       doxygen phpxmlrpc.dox\r
  56 #\r
  57         # generate docs out of javadoc via phpdocumentor\r
  58         phpdoc -f ../xmlrpc.inc,../xmlrpcs.inc,../xmlrpc_wrappers.inc -t javadoc-out -ti PHP-XMLRPC -o HTML:frames:default -s\r
  59 \r
  60 dist: doc\r
  61         ${MKDIR} -p ../xmlrpc-${VERSION}/doc\r
  62         -cp out/*.html ../xmlrpc-${VERSION}/doc\r
  63         -cp out/*.css ../xmlrpc-${VERSION}/doc\r
  64         -cp out/*.gif ../xmlrpc-${VERSION}/doc\r
  65         -cp out/*.pdf ../xmlrpc-${VERSION}/doc\r
  66         cp xmlrpc_php.xml ../xmlrpc-${VERSION}/doc\r
  67         cp xmlrpc_php.pdf ../xmlrpc-${VERSION}/doc\r
  68         cp Makefile ../xmlrpc-${VERSION}/doc\r
  69 \r
  70 clean:\r
  71         -rm -f out/*.html\r
  72         -rm -rf javadoc-out\r
  73         -rm xmlrpc_php.fo.xml\r
  74         -rm xmlrpc_php.pdf\r