new target mkws-complete-syntax-check
[mkws-moved-to-github.git] / tools / htdocs / Makefile
1 ######################################################################
2 # Copyright (c) 2013-2014 IndexData ApS. http://indexdata.com
3 #
4
5 ##############################
6 # select a jquery version
7 #
8 #JQUERY_URL=    http://code.jquery.com/jquery-2.0.3.min.js
9 JQUERY_URL=     http://code.jquery.com/jquery-1.10.0.min.js
10 #JQUERY_URL=    http://code.jquery.com/jquery-1.9.1.min.js
11 #JQUERY_URL=    http://code.jquery.com/jquery-1.8.3.min.js
12 #JQUERY_URL=    http://code.jquery.com/jquery-1.7.2.min.js
13 #JQUERY_URL=    http://code.jquery.com/jquery-1.6.4.min.js
14 #JQUERY_URL=    http://code.jquery.com/jquery-1.4.4.min.js
15
16 JQUERY_UI_URL=  http://code.jquery.com/ui/1.10.3/jquery-ui.js
17 #JQUERY_UI_URL= http://code.jquery.com/ui/1.8.0/jquery-ui.min.js
18 JQUERY_JSON_URL= https://jquery-json.googlecode.com/files/jquery.json-2.4.js
19 HANDLEBARS_URL= http://builds.handlebarsjs.com.s3.amazonaws.com/handlebars-v1.1.2.js -o $@
20 VERSION = $(shell tr -d '\012' < VERSION)
21
22 MKWS_JS=        mkws-complete.js
23 PZ2API_JS=      ../../../pazpar2/js/pz2.js
24 PZ2API_GIT=     ssh://git.indexdata.com:222/home/git/pub/pazpar2
25
26 JQUERY_FILE := $(shell basename ${JQUERY_URL})
27 JQUERY_JSON_FILE := $(shell basename ${JQUERY_JSON_URL})
28 HANDLEBARS_FILE := $(shell basename ${HANDLEBARS_URL})
29 ##############################
30
31 DOCS = README.html README.odt README.pdf \
32        whitepaper.html whitepaper.odt whitepaper.pdf
33
34 # Default rule when "make" is invoked without a target
35 **default**: ${MKWS_JS} mkws-js-min README.html whitepaper.html
36
37 all: ${MKWS_JS} mkws-js-min $(DOCS)
38
39 docs: $(DOCS)
40
41 pz2api-git-checkout:
42         @if ! test -e ${PZ2API_JS}; then \
43             ( cd ../../.. && git clone ${PZ2API_GIT} ); \
44         fi
45
46 mkws-js ${MKWS_JS}: Makefile mkws.js ${JQUERY_FILE} ${JQUERY_JSON_FILE} ${HANDLEBARS_FILE}
47         @if ! test -e ${PZ2API_JS}; then \
48             echo "The pazpar2 JS file ${PZ2API_JS} does not exists."; \
49             echo "Did you checked out the source from the git repo?"; \
50             echo ""; \
51             echo "Please run:"; \
52             echo "$$ make pz2api-git-checkout"; \
53             echo ""; \
54             exit 1; \
55         fi
56         ( echo "/*! Copyright (c) 2013-2014 IndexData ApS. http://indexdata.com"; \
57           echo "   created at: $$(date)"; \
58           echo "   mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,')"; \
59           echo "   $$(basename ${PZ2API_JS}) GIT id: $$(cd $$(dirname ${PZ2API_JS}) && git log $$(basename ${PZ2API_JS}) | head -n 1 | perl -npe 's,\S+\s+,,')"; \
60           echo "*/"; \
61           cat ${JQUERY_FILE}; \
62           cat ${JQUERY_JSON_FILE}; \
63           cat ${HANDLEBARS_FILE}; \
64           cat ${PZ2API_JS}; \
65           cat  mkws.js; \
66         ) > ${MKWS_JS}.new
67         mv -f ${MKWS_JS}.new ${MKWS_JS}
68
69 mkws-js-min: mkws.min.js mkws-complete.min.js
70
71 %.min.js: %.js
72         yui-compressor $? > $@.new
73         mv -f $@.new $@
74
75 mkws-syntax-check:
76         yui-compressor mkws.js >/dev/null
77
78 mkws-complete-syntax-check: mkws-js-min
79
80 ${JQUERY_FILE}:
81         curl -sSf ${JQUERY_URL} -o $@.new
82         perl -npe 's,sourceMappingURL=jquery.*map,,' $@.new > $@
83         rm -f $@.new
84
85 ${JQUERY_JSON_FILE}:
86         curl -sSf ${JQUERY_JSON_URL} -o $@
87
88 ${HANDLEBARS_FILE}:
89         curl -sSf ${HANDLEBARS_URL} -o $@
90
91 release: mkws.js mkws-complete.js mkws.min.js mkws-complete.min.js
92         @if [ -f releases/mkws-$(VERSION).js ]; then \
93                 echo "*** There is already a release $(VERSION)"; \
94         else \
95                 cp -p mkws.js releases/mkws-$(VERSION).js; \
96                 cp -p mkws.min.js releases/mkws-$(VERSION).min.js; \
97                 cp -p mkws-complete.js releases/mkws-complete-$(VERSION).js; \
98                 cp -p mkws-complete.min.js releases/mkws-complete-$(VERSION).min.js; \
99                 echo "Made release $(VERSION)"; \
100         fi
101
102 # For a description of pandoc's markdown format, see:
103 # http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html -->
104
105 # for older pandoc (<1.9) run first:
106 # perl -i.bak -npe 's/"(Authors|Subjects)": "(.*?)"/"$1": "test"/' tools/htdocs/whitepaper.markdown
107 #
108 %.html: %.markdown
109         rm -f $@
110         pandoc --standalone --toc -c mkws-doc.css $< | sed '/^<col width="[0-9]*%" \/>$//d' > $@
111         chmod ugo-w $@
112
113 %.odt: %.markdown
114         rm -f $@
115         pandoc --standalone $< -o $@
116         chmod ugo-w $@
117
118 # ### In order to compile the whitepaper, which has tables, to PDF,
119 # you will need to install the Debian package
120 #       texlive-latex-recommended
121 %.pdf: %.markdown
122         rm -f $@
123         pandoc --standalone $< -o $@
124         chmod ugo-w $@
125
126 ##############################
127 # helper targets
128 #
129 distclean: clean
130         rm -f *.orig *.bak *.rej
131
132 clean:
133         rm -f ${JQUERY_FILE} ${JQUERY_JSON_FILE} ${HANDLEBARS_FILE}
134         rm -f mkws.min.js ${MKWS_JS} mkws-complete.min.js
135         rm -f $(DOCS)
136
137 help:
138         @echo "make [ help | docs | clean ]"
139         @echo "     [ mkws-js | mkws-js-min ]"
140         @echo "     [ mkws-syntax-check | mkws-complete-syntax-check ]"
141         @echo ""
142         @echo "make JQUERY_URL=http://code.jquery.com/jquery-2.0.3.min.js clean mkws-js"
143         @echo ""
144         @echo "Please check ./README file too!"