move to asciidoctor-pdf for pdf manual
authorgggeek <giunta.gaetano@gmail.com>
Fri, 6 Jan 2023 21:56:24 +0000 (21:56 +0000)
committergggeek <giunta.gaetano@gmail.com>
Fri, 6 Jan 2023 21:56:24 +0000 (21:56 +0000)
doc/build/generate.sh
doc/build/setup_tools.sh
doc/manual/images/debugger.gif [deleted file]
doc/manual/images/debugger.jpg [new file with mode: 0644]
doc/manual/phpxmlrpc_manual.adoc

index 337e304..bb8372b 100755 (executable)
@@ -20,13 +20,16 @@ $PHPDOC run --cache-folder './build/.phpdoc' -d "$(realpath ../src/)" -t './api'
 # solution is preferred
 #asciidoctor -d book -o './manual/phpxmlrpc_manual.html' './manual/phpxmlrpc_manual.adoc'
 
-# PDF file from asciidoc
-# 1. get docbook
-asciidoctor -d book -b docbook -o './build/phpxmlrpc_manual.xml' './manual/phpxmlrpc_manual.adoc'
-# 2a. then PDF via apache fop
-#php ./build/convert.php './build/phpxmlrpc_manual.xml' './build/custom.fo.xsl' './manual/phpxmlrpc_manual.fo.xml' "$DOCBOOKXSLTDIR"
-#fop ./manual/phpxmlrpc_manual.fo.xml ./manual/phpxmlrpc_manual.pdf
-#rm ./manual/phpxmlrpc_manual.fo.xml
-# 2b. then PDF via pandoc+xelatex, using a nice template
-cd build; pandoc -s --from=docbook --pdf-engine=xelatex --data-dir=. --template=eisvogel -o ../manual/phpxmlrpc_manual.pdf phpxmlrpc_manual.xml; cd ..
-rm ./build/phpxmlrpc_manual.xml
+# PDF file from asciidoc direct conversion
+asciidoctor-pdf manual/phpxmlrpc_manual.adoc
+
+# PDF file from asciidoc via docbook
+## 1. get docbook
+#asciidoctor -d book -b docbook -o './build/phpxmlrpc_manual.xml' './manual/phpxmlrpc_manual.adoc'
+## 2a. then PDF via apache fop
+##php ./build/convert.php './build/phpxmlrpc_manual.xml' './build/custom.fo.xsl' './manual/phpxmlrpc_manual.fo.xml' "$DOCBOOKXSLTDIR"
+##fop ./manual/phpxmlrpc_manual.fo.xml ./manual/phpxmlrpc_manual.pdf
+##rm ./manual/phpxmlrpc_manual.fo.xml
+## 2b. then PDF via pandoc+xelatex, using a nice template
+#cd build; pandoc -s --from=docbook --pdf-engine=xelatex --data-dir=. --template=eisvogel -o ../manual/phpxmlrpc_manual.pdf phpxmlrpc_manual.xml; cd ..
+#rm ./build/phpxmlrpc_manual.xml
index ee08bcb..a76707d 100755 (executable)
@@ -9,13 +9,20 @@ PHPPKG=$(dpkg --list | grep php | grep cli | grep -v -F '(default)' | awk '{prin
 # git, curl, gpg are needed by phive, used to install phpdocumentor
 # @todo besides php-cli, there are other php extensions used by phpdocumentor that we should make sure are onboard
 sudo DEBIAN_FRONTEND=noninteractive apt-get install -y \
-    asciidoctor curl git gpg unzip zip "${PHPPKG}" \
-    pandoc texlive-xetex texlive-fonts-extra texlive-latex-extra
+    asciidoctor curl git gpg unzip zip "${PHPPKG}"
 
+# pandoc toolchain
+#sudo DEBIAN_FRONTEND=noninteractive apt-get install -y \
+#    pandoc texlive-xetex texlive-fonts-extra texlive-latex-extra
+
+# FOP toolchain
 #sudo DEBIAN_FRONTEND=noninteractive apt-get install -y \
 #    fop \
 #    "${PHPPKG/cli/xsl}" \
 
+# ascidoctor-pdf toolchain
+sudo gem install asciidoctor-pdf rouge
+
 cd "$(dirname -- "${BASH_SOURCE[0]}")"
 
 # Install phpdocumentor and the docbook xslt using Composer
@@ -38,16 +45,16 @@ if [ ! -d docbook-xsl ]; then
 fi
 
 # Get the eisvogel template for pandoc
-if [ ! -f eisvogel.latex ]; then
-    curl -fsSL -o ev.zip "https://github.com/Wandmalfarbe/pandoc-latex-template/releases/download/v2.1.0/Eisvogel-2.1.0.zip"
-    unzip ev.zip
-    rm -rf examples
-    rm ev.zip LICENSE CHANGELOG.md icon.png
-fi
+#if [ ! -f eisvogel.latex ]; then
+#    curl -fsSL -o ev.zip "https://github.com/Wandmalfarbe/pandoc-latex-template/releases/download/v2.1.0/Eisvogel-2.1.0.zip"
+#    unzip ev.zip
+#    rm -rf examples
+#    rm ev.zip LICENSE CHANGELOG.md icon.png
+#fi
 
-if [ ! -L images ]; then
-    ln -s "$(realpath ../manual/images)" images
-fi
+#if [ ! -L images ]; then
+#    ln -s "$(realpath ../manual/images)" images
+#fi
 
 # Install phpdocumentor via Phive
 # @todo wouldn't it be quicker to just scan the github page for the last release and just get the phar?
diff --git a/doc/manual/images/debugger.gif b/doc/manual/images/debugger.gif
deleted file mode 100644 (file)
index 492c2ca..0000000
Binary files a/doc/manual/images/debugger.gif and /dev/null differ
diff --git a/doc/manual/images/debugger.jpg b/doc/manual/images/debugger.jpg
new file mode 100644 (file)
index 0000000..8fa1d79
Binary files /dev/null and b/doc/manual/images/debugger.jpg differ
index 68d3d10..500495c 100644 (file)
@@ -1,9 +1,12 @@
 = XML-RPC for PHP User Manual
-:revision: 4.9.3
+Gaetano Giunta; Edd Dumbill
+4.9.3
 :keywords: xmlrpc, xml, rpc, webservices, http
-:toc: left
+:title-page:
+:toc:
+:toclevels: 3
 :imagesdir: images
-:source-highlighter: highlightjs
+:source-highlighter: rouge
 
 
 == Files in the distribution [[manifest]]
@@ -1431,7 +1434,7 @@ then access the debugger by pointing your browser at __http://127.0.0.1:8081__
 
 The interface should be self-explicative enough to need little documentation.
 
-image::debugger.gif[,,,,align="center"]
+image::debugger.jpg[debugger,458,385,,align="center"]
 
 To make sure that the debugger is working properly, you can use it make f.e. a "list available methods" call against the
 public demo server available at: Address: __gggeek.altervista.org__, Path: __/sw/xmlrpc/demo/server/server.php__
@@ -1707,23 +1710,3 @@ using more resources and a longer processing time, using the PHPXMLRPC library a
 The module was originally part of the EXTRAS package, available as a separate download from the sourceforge.net website;
 it has since become available as Packagist package `phpxmlrpc/polyfill-xmlrpc` and can be found on GitHub at
 https://github.com/gggeek/polyfill-xmlrpc
-
-++++++++++++++++++++++++++++++++++++++
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:2
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-sgml-namecase-general:t
-sgml-general-insert-case:lower
-End:
--->
-++++++++++++++++++++++++++++++++++++++