source: trunk/SRC/Documentation/xmldoc/makefile @ 468

Last change on this file since 468 was 431, checked in by pinsard, 14 years ago

add design target for documents productions
  • Property svn:keywords set to Id
File size: 11.9 KB
Line 
1#
2# module
3# ======
4#
5# generation of documentations from XML files (and some IDL files) in HTML and
6# wiki forms
7#
8# FILES
9# =====
10#
11# /Users/fplod/SAXO_DIR_ws/SRC/Documentation/xmldoc/makefile sur aedon.locean-ipsl.upmc.fr
12#
13# EVOLUTIONS
14# ==========
15#
16# $Id$
17#
18#
19# - fplod 20100420T122154Z aedon.locean-ipsl.upmc.fr (Darwin)
20#
21#   * add design target
22#
23# - fplod 20091118T111913Z aedon.locean-ipsl.upmc.fr (Darwin)
24#
25#   * because of ugly wiki pages, remove all wiki pages except WikiStart
26#     Links are on HTML documents
27#
28# - fplod 20091106T151022Z aedon.locean-ipsl.upmc.fr (Darwin)
29#
30#   * no more titlepage.saxo.xml usage
31#
32# - fplod 20091106T143104Z aedon.locean-ipsl.upmc.fr (Darwin)
33#
34#   * better usage of $<
35#
36# - fplod 2008-04-16T10:06:39Z aedon.locean-ipsl.upmc.fr (Darwin)
37# working on wiki production using
38# http://xmlstar.sourceforge.net/doc/UG/xmlstarlet-ug.html
39# fplod 2008-04-15T15:37:59Z aedon.locean-ipsl.upmc.fr (Darwin)
40# java is not ok now :
41# http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl; Ligne #53; Colonne #35; XSLT Error (javax.xml.transform.TransformerConfigurationException): javax.xml.transform.TransformerException: javax.xml.transform.TransformerException: Had IO Exception with stylesheet file: keywords.xsl
42# replaced by xsltproc which is now ok for callouts
43# fplod 2008-04-15T08:10:09Z aedon.locean-ipsl.upmc.fr (Darwin)
44# add xml validation using xmlstarlet
45# fplod 2007-06-27T10:07:59Z aedon.locean-ipsl.upmc.fr (Darwin)
46# creation in order to replace makehtml.sh
47#
48PRODUCT = \
49saxo
50
51DIRBASE = \
52./
53
54DIRSRC = \
55$(DIRBASE)
56
57DIRTMP = \
58./
59
60DIRDESIGN = \
61./design/
62
63DIRWWW = \
64./
65
66DIRWIKI = \
67./wiki/
68
69.PHONY : \
70all \
71clean \
72design \
73dbkcheck \
74help \
75html \
76tracwiki
77
78help :
79        @echo "\$$ make clean"
80        @echo "\$$ make all"
81        @echo "\$$ make dbkcheck"
82        @echo "++ check link"
83        @echo "++ depot html et wiki"
84
85clean :
86        -@rm -f $(DIRTMP)/*_full.xml
87        -@rm -f $(DIRTMP)/err_xmlstarlet_xsd
88        -@rm -f $(DIRTMP)/rowscm.xml
89        -@rm -f $(DIRTMP)/rowskwd.xml
90        -@rm -f $(DIRTMP)/all_plots.xml
91        -@rm -f $(DIRTMP)/getsaxo_sed.xml
92        -@rm -f $(DIRTMP)/firststeps_sed.xml
93
94design : \
95$(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.png \
96$(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.svg
97
98dbkcheck :
99        @-rm $(DIRTMP)/err_xmlstarlet_xsd 2> /dev/null
100        @for file in $(DIRTMP)/*_full.xml $(DIRTMP)/all_plots.xml; do \
101        xml val --err \
102        --xsd http://www.docbook.org/xml/5.0/xsd/docbook.xsd \
103        $${file} 1>> $(DIRTMP)/err_xmlstarlet_xsd 2>&1; done
104        @echo "check for valid diag for each file in $(DIRTMP)/err_xmlstarlet_xsd"
105
106all : \
107html \
108tracwiki
109
110html : \
111$(DIRWWW)/svnbasiccommands.html \
112$(DIRWWW)/getsaxo.html \
113$(DIRWWW)/websaxo.html \
114$(DIRWWW)/whatsnew.html \
115$(DIRWWW)/updatesaxo.html \
116$(DIRWWW)/whatissaxo.html \
117$(DIRWWW)/faqsaxo.html \
118$(DIRWWW)/infoupdatekwd.html \
119$(DIRWWW)/infoupdatecm.html \
120$(DIRWWW)/mailing.html \
121$(DIRWWW)/tiplink.html \
122$(DIRWWW)/mini_notice.html \
123$(DIRWWW)/firststeps.html \
124$(DIRWWW)/all_plots.html
125
126tracwiki : \
127$(DIRWIKI)/WikiStart
128        @echo "Do not forget to import wiki pages"
129        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr mkdir -p /tmp/$(PRODUCT)/"
130        @echo "\$$ rsync -av --exclude=".DS_Store" --exclude=".svn" $(DIRWIKI) $(PRODUCT)@forge.ipsl.jussieu.fr:/tmp/$(PRODUCT)/"
131        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr trac-admin /ipsl/forge/projets/$(PRODUCT)/trac wiki load /tmp/$(PRODUCT)/"
132
133        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr rmdir -f /tmp/$(PRODUCT)/"
134
135$(DIRWIKI)/WikiStart : \
136$(DIRTMP)/websaxo_full.xml \
137$(DIRSRC)/saxo_tracwiki.xsl \
138$(DIRSRC)/linkwiki.sed
139        @xsltproc \
140        $(DIRSRC)/saxo_tracwiki.xsl \
141        $< | \
142        sed -f $(DIRSRC)/linkwiki.sed | \
143        awk 'sub(/ @star@ $$/,""){printf(" * %s", $$0);next};1' | \
144        sed -e "s+@star@+ *+" \
145        > $@
146
147$(DIRWWW)/websaxo.html : \
148$(DIRTMP)/websaxo_full.xml \
149$(DIRSRC)/saxo_html.xsl \
150$(DIRSRC)/style.css \
151$(DIRSRC)/$(PRODUCT).css
152        @xsltproc \
153        --param html.stylesheet "'style.css $(PRODUCT).css'" \
154        --param css.decoration 1 \
155        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
156        --param section.autolabel 1 \
157        --output $@ \
158        $(DIRSRC)/saxo_html.xsl \
159        $<
160
161$(DIRTMP)/websaxo_full.xml : \
162$(DIRSRC)/websaxo.xml
163        @xmllint \
164        --xinclude \
165        --encode utf-8 \
166        --noent \
167        --output $@ \
168        $<
169
170$(DIRWWW)/svnbasiccommands.html : \
171$(DIRTMP)/svnbasiccommands_full.xml \
172$(DIRSRC)/saxo_html.xsl \
173$(DIRSRC)/style.css \
174$(DIRSRC)/$(PRODUCT).css
175        @xsltproc \
176        --param html.stylesheet "'style.css $(PRODUCT).css'" \
177        --param css.decoration 1 \
178        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
179        --param section.autolabel 1 \
180        --output $@ \
181        $(DIRSRC)/saxo_html.xsl \
182        $<
183
184$(DIRTMP)/svnbasiccommands_full.xml : \
185$(DIRSRC)/svnbasiccommands.xml
186        @xmllint \
187        --xinclude \
188        --encode utf-8 \
189        --noent \
190        --output $@ \
191        $<
192
193$(DIRWWW)/faqsaxo.html : \
194$(DIRTMP)/faqsaxo_full.xml \
195$(DIRSRC)/saxo_html.xsl \
196$(DIRSRC)/style.css \
197$(DIRSRC)/$(PRODUCT).css
198        @xsltproc \
199        --param html.stylesheet "'style.css $(PRODUCT).css'" \
200        --param css.decoration 1 \
201        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
202        --param section.autolabel 1 \
203        --output $@ \
204        $(DIRSRC)/saxo_html.xsl \
205        $<
206
207$(DIRTMP)/faqsaxo_full.xml : \
208$(DIRSRC)/faqsaxo.xml
209        @xmllint \
210        --xinclude \
211        --encode utf-8 \
212        --noent \
213        --output $@ \
214        $<
215
216$(DIRWWW)/getsaxo.html : \
217$(DIRTMP)/getsaxo_full.xml \
218$(DIRSRC)/saxo_html.xsl \
219$(DIRSRC)/style.css \
220$(DIRSRC)/$(PRODUCT).css
221        @xsltproc \
222        --param html.stylesheet "'style.css $(PRODUCT).css'" \
223        --param css.decoration 1 \
224        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
225        --param section.autolabel 1 \
226        --output $@ \
227        $(DIRSRC)/saxo_html.xsl \
228        $<
229
230$(DIRTMP)/getsaxo_sed.xml : \
231$(DIRSRC)/getsaxo.xml \
232$(DIRSRC)/getsaxo_pre.sh
233        @$(DIRSRC)/getsaxo_pre.sh
234
235$(DIRTMP)/getsaxo_full.xml : \
236$(DIRTMP)/getsaxo_sed.xml
237        @xmllint \
238        --xinclude \
239        --encode utf-8 \
240        --noent \
241        --output $@ \
242        $<
243
244$(DIRWWW)/firststeps.html : \
245$(DIRTMP)/firststeps_full.xml \
246$(DIRSRC)/saxo_html.xsl \
247$(DIRSRC)/style.css \
248$(DIRSRC)/$(PRODUCT).css
249        @xsltproc \
250        --param html.stylesheet "'style.css $(PRODUCT).css'" \
251        --param css.decoration 1 \
252        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
253        --param section.autolabel 1 \
254        --output $@ \
255        $(DIRSRC)/saxo_html.xsl \
256        $<
257
258$(DIRWWW)/all_plots.html : \
259$(DIRTMP)/all_plots.xml \
260$(DIRSRC)/saxo_html.xsl \
261$(DIRSRC)/style.css \
262$(DIRSRC)/$(PRODUCT).css
263        @xsltproc \
264        --param html.stylesheet "'style.css $(PRODUCT).css'" \
265        --param css.decoration 1 \
266        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
267        --param section.autolabel 1 \
268        --output $@ \
269        $(DIRSRC)/saxo_html.xsl \
270        $<
271
272
273$(DIRTMP)/all_plots.xml : \
274$(DIRTMP)/firststeps_full.xml \
275$(DIRSRC)/all_plots_docbook.xsl
276        @xsltproc \
277        --output $@ \
278        $(DIRSRC)/all_plots_docbook.xsl \
279        $<
280
281$(DIRTMP)/firststeps_sed.xml : \
282$(DIRSRC)/firststeps_pre.sh \
283$(DIRSRC)/firststeps.xml
284        @$(DIRSRC)/firststeps_pre.sh
285
286$(DIRTMP)/firststeps_full.xml : \
287$(DIRTMP)/firststeps_sed.xml
288        @xmllint \
289        --xinclude \
290        --encode utf-8 \
291        --noent \
292        --output $@ \
293        $<
294
295$(DIRWWW)/mailing.html : \
296$(DIRTMP)/mailing_full.xml \
297$(DIRSRC)/saxo_html.xsl \
298$(DIRSRC)/style.css \
299$(DIRSRC)/$(PRODUCT).css
300        @xsltproc \
301        --param html.stylesheet "'style.css $(PRODUCT).css'" \
302        --param css.decoration 1 \
303        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
304        --param section.autolabel 1 \
305        --output $@ \
306        $(DIRSRC)/saxo_html.xsl \
307        $<
308
309$(DIRTMP)/mailing_full.xml : \
310$(DIRSRC)/mailing.xml
311        @xmllint \
312        --xinclude \
313        --encode utf-8 \
314        --noent \
315        --output $@ \
316        $<
317
318$(DIRWWW)/mini_notice.html : \
319$(DIRTMP)/mini_notice_full.xml \
320$(DIRSRC)/saxo_html.xsl \
321$(DIRSRC)/style.css \
322$(DIRSRC)/$(PRODUCT).css
323        @xsltproc \
324        --param html.stylesheet "'style.css $(PRODUCT).css'" \
325        --param css.decoration 1 \
326        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
327        --param section.autolabel 1 \
328        --output $@ \
329        $(DIRSRC)/saxo_html.xsl \
330        $<
331
332$(DIRTMP)/mini_notice_full.xml : \
333$(DIRSRC)/mini_notice.xml
334        @xmllint \
335        --xinclude \
336        --encode utf-8 \
337        --noent \
338        --output $@ \
339        $<
340
341$(DIRWWW)/tiplink.html : \
342$(DIRTMP)/tiplink_full.xml \
343$(DIRSRC)/saxo_html.xsl \
344$(DIRSRC)/style.css \
345$(DIRSRC)/$(PRODUCT).css
346        @xsltproc \
347        --param html.stylesheet "'style.css $(PRODUCT).css'" \
348        --param css.decoration 1 \
349        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
350        --param section.autolabel 1 \
351        --output $@ \
352        $(DIRSRC)/saxo_html.xsl \
353        $<
354
355$(DIRTMP)/tiplink_full.xml : \
356$(DIRSRC)/tiplink.xml
357        @xmllint \
358        --xinclude \
359        --encode utf-8 \
360        --noent \
361        --output $@ \
362        $<
363
364$(DIRWWW)/infoupdatecm.html : \
365$(DIRTMP)/infoupdatecm_full.xml \
366$(DIRSRC)/saxo_html.xsl \
367$(DIRSRC)/style.css \
368$(DIRSRC)/$(PRODUCT).css
369        @xsltproc \
370        --param html.stylesheet "'style.css $(PRODUCT).css'" \
371        --param css.decoration 1 \
372        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
373        --param section.autolabel 1 \
374        --output $@ \
375        $(DIRSRC)/saxo_html.xsl \
376        $<
377
378$(DIRTMP)/infoupdatecm_full.xml : \
379$(DIRSRC)/infoupdatecm.xml \
380$(DIRTMP)/rowscm.xml
381        @xmllint \
382        --xinclude \
383        --encode utf-8 \
384        --noent \
385        --output $@ \
386        $<
387
388$(DIRWWW)/infoupdatekwd.html : \
389$(DIRTMP)/infoupdatekwd_full.xml \
390$(DIRSRC)/saxo_html.xsl \
391$(DIRSRC)/style.css \
392$(DIRSRC)/$(PRODUCT).css
393        @xsltproc \
394        --param html.stylesheet "'style.css $(PRODUCT).css'" \
395        --param css.decoration 1 \
396        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
397        --param section.autolabel 1 \
398        --output $@ \
399        $(DIRSRC)/saxo_html.xsl \
400        $<
401
402$(DIRTMP)/infoupdatekwd_full.xml : \
403$(DIRTMP)/infoupdatekwd.xml \
404$(DIRTMP)/rowskwd.xml
405        @xmllint \
406        --xinclude \
407        --encode utf-8 \
408        --noent \
409        --output $@ \
410        $<
411
412$(DIRTMP)/rowscm.xml : \
413../../ForOldVersion/updateold.pro
414        @echo "<tbody>" > $@
415        @grep "IF NOT key_forgetold AND n_elements(\(.* = .*\)" $< | \
416        sort | \
417        sed -e "s/\(^.* THEN \)\(.*\)\( = \)\(.*\)/<row><entry colname='old'><varname>\2<\/varname><\/entry> <entry colname='new'><varname>\4<\/varname><\/entry><\/row>/" >> $@
418        @echo "</tbody>" >> $@
419
420$(DIRTMP)/rowskwd.xml : \
421../../ForOldVersion/updatekwd.pro
422        @echo "<tbody>" > $@
423        @grep "^  old = \[old, .* new = \[new" $< | \
424        sort | \
425        sed -e "s/\( old = \[old, '\)\(.*\)\('\] *& new = \[new, '\)\(.*\)\('\]\)/<row><entry colname='old'><varname>\2<\/varname><\/entry> <entry colname='new'><varname>\4<\/varname><\/entry><\/row>/" >> $@
426
427        @echo "</tbody>" >> $@
428
429$(DIRWWW)/whatissaxo.html : \
430$(DIRTMP)/whatissaxo_full.xml \
431$(DIRSRC)/saxo_html.xsl \
432$(DIRSRC)/style.css \
433$(DIRSRC)/$(PRODUCT).css
434        @xsltproc \
435        --param html.stylesheet "'style.css $(PRODUCT).css'" \
436        --param css.decoration 1 \
437        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
438        --param section.autolabel 1 \
439        --output $@ \
440        $(DIRSRC)/saxo_html.xsl \
441        $<
442
443$(DIRTMP)/whatissaxo_full.xml : \
444$(DIRSRC)/whatissaxo.xml
445        @xmllint \
446        --xinclude \
447        --encode utf-8 \
448        --noent \
449        --output $@ \
450        $<
451
452$(DIRWWW)/whatsnew.html : \
453$(DIRTMP)/whatsnew_full.xml \
454$(DIRSRC)/saxo_html.xsl \
455$(DIRSRC)/style.css \
456$(DIRSRC)/$(PRODUCT).css
457        @xsltproc \
458        --param html.stylesheet "'style.css $(PRODUCT).css'" \
459        --param css.decoration 1 \
460        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
461        --param section.autolabel 1 \
462        --output $@ \
463        $(DIRSRC)/saxo_html.xsl \
464        $<
465       
466$(DIRTMP)/whatsnew_full.xml : \
467$(DIRSRC)/whatsnew.xml
468        @xmllint \
469        --xinclude \
470        --encode utf-8 \
471        --noent \
472        --output $@ \
473        $<
474
475$(DIRWWW)/updatesaxo.html : \
476$(DIRTMP)/updatesaxo_full.xml \
477$(DIRSRC)/saxo_html.xsl \
478$(DIRSRC)/style.css \
479$(DIRSRC)/$(PRODUCT).css
480        @xsltproc \
481        --param html.stylesheet "'style.css $(PRODUCT).css'" \
482        --param css.decoration 1 \
483        --param link.mailto.url "'mailto:saxo-dev_at_forge.ipsl.jussieu.fr'" \
484        --param section.autolabel 1 \
485        --output $@ \
486        $(DIRSRC)/saxo_html.xsl \
487        $<
488       
489$(DIRTMP)/updatesaxo_full.xml : \
490$(DIRSRC)/updatesaxo.xml
491        @xmllint \
492        --xinclude \
493        --encode utf-8 \
494        --noent \
495        --output $@ \
496        $<
497$(DIRDESIGN)/images/%.png : $(DIRDESIGN)/images/%.svg
498        @convert $< $@
499
500$(DIRDESIGN)/images/%.svg : $(DIRDESIGN)/%.dot
501        @dot -Tsvg -o $@ $<
502
503$(DIRDESIGN)/$(PRODUCT)_fulldependencies.dot : \
504./makefile
505        @makeppgraph --graphviz --output=$@
506
Note: See TracBrowser for help on using the repository browser.