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