Add comment on required Debian package.

[mkws-moved-to-github.git] / tools / htdocs / Makefile

diff --git a/tools/htdocs/Makefile b/tools/htdocs/Makefile
index 8940a2d..2abcb97 100644 (file)
--- a/tools/htdocs/Makefile
+++ b/tools/htdocs/Makefile
@@ -2,6 +2,9 @@
 # Copyright (c) 2013 IndexData ApS. http://indexdata.com
 #
 
+##############################
+# select a jquery version
+#
 #JQUERY_URL=   http://code.jquery.com/jquery-2.0.3.min.js
 JQUERY_URL=    http://code.jquery.com/jquery-1.10.0.min.js
 #JQUERY_URL=   http://code.jquery.com/jquery-1.9.1.min.js
@@ -14,14 +17,33 @@ JQUERY_UI_URL=      http://code.jquery.com/ui/1.10.3/jquery-ui.js
 #JQUERY_UI_URL=        http://code.jquery.com/ui/1.8.0/jquery-ui.min.js
 
 MKWS_JS=       mkws-complete.js
-DOCS = README.html README.odt README.pdf
-**default**: ${MKWS_JS} README.html
+PZ2API_JS=     ../../../libjs-pz2/pz2api.1.js
+PZ2API_GIT=    ssh://git.indexdata.com:222/home/git/pub/libjs-pz2
+
+DOCS = README.html README.odt README.pdf \
+       whitepaper.html whitepaper.odt whitepaper.pdf
+
+**default**: ${MKWS_JS} README.html whitepaper.html
+
 all: ${MKWS_JS} $(DOCS)
 
-mkws-js ${MKWS_JS}: ../../../libjs-pz2/pz2api.1.js mkws.js
+docs: $(DOCS)
+
+pz2api-git-checkout: 
+       @if ! test -e ${PZ2API_JS}; then \
+           ( cd $$(dirname $$(dirname ${PZ2API_JS})); git clone ${PZ2API_GIT} ); \
+       fi
+
+mkws-js ${MKWS_JS}: ${PZ2API_JS} mkws.js
+       @if ! test -e ${PZ2API_JS}; then \
+           echo "The pazpar2 JS file ${PZ2API_JS} does not exists."; \
+           echo "Did you checked out the source from the git repo?"; \
+           echo "Please run: make pz2api-git-checkout"; \
+           exit 1; \
+       fi
        ( echo "/* created at: $$(date)"; \
          echo "   mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,') */"; \
-         curl -sSf ${JQUERY_URL}; \
+         curl -sSf ${JQUERY_URL} | perl -npe 's,sourceMappingURL=jquery.*map,,'; \
          cat ../../../libjs-pz2/pz2api.1.js mkws.js ) > ${MKWS_JS}.new 
        mv -f ${MKWS_JS}.new ${MKWS_JS}
 
@@ -30,7 +52,7 @@ clean:
        rm -f ${MKWS_JS} $(DOCS)
 
 help:
-       @echo "make [ help | mkws-js | clean ]"
+       @echo "make [ help | mkws-js | docs | clean ]"
        @echo ""
        @echo "make JQUERY_URL=http://code.jquery.com/jquery-2.0.3.min.js clean mkws-js"
        @echo ""
@@ -40,9 +62,12 @@ help:
 # For a description of pandoc's markdown format, see:
 # http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html -->
 
+# for older pandoc (<1.9) run first:
+# perl -i.bak -npe 's/"(Authors|Subjects)": "(.*?)"/"$1": "test"/' tools/htdocs/whitepaper.markdown
+#
 %.html: %.markdown
        rm -f $@
-       pandoc --standalone -c mkws-doc.css $< -o $@
+       pandoc --standalone --toc -c mkws-doc.css $< | sed '/^<col width="[0-9]*%" \/>$//d' > $@
        chmod ugo-w $@
 
 %.odt: %.markdown
@@ -50,6 +75,9 @@ help:
        pandoc --standalone $< -o $@
        chmod ugo-w $@
 
+# ### In order to compile the whitepaper, which has tables, to PDF,
+# you will need to install the Debian package
+#      texlive-latex-recommended
 %.pdf: %.markdown
        rm -f $@
        pandoc --standalone $< -o $@