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