1############################################################################# 2# Software Testing Automation Framework (STAF) # 3# (C) Copyright IBM Corp. 2001 # 4# # 5# This software is licensed under the Eclipse Public License (EPL) V1.0. # 6############################################################################# 7 8docs_targets += $(REL)/docs/staf/STAFUG.htm\ 9 $(REL)/docs/staf/STAFGS.pdf\ 10 $(REL)/docs/staf/STAFInstall.pdf\ 11 $(REL)/docs/staf/STAFHome.htm\ 12 $(REL)/docs/staf/STAFCMDS.htm\ 13 $(REL)/docs/staf/STAFRC.htm\ 14 $(REL)/docs/staf/STAFFAQ.htm\ 15 $(REL)/docs/staf/STAFDiag.htm\ 16 $(O)/docs/staf/gettingstarted/STAFGS.htm\ 17 $(O)/docs/staf/installguide/STAFInstall.htm\ 18 $(REL)/docs/staf/History 19Targets += $(docs_targets) 20CleanupTargets += cleanup_docs 21 22$(docs_targets): SUBSYS_REL := doc 23SUBSYS_REL := doc 24 25UserGuideSrc :=\ 26 $(SRC)/docs/userguide/APIRef.script\ 27 $(SRC)/docs/userguide/Commands.script\ 28 $(SRC)/docs/userguide/CmdRef.script\ 29 $(SRC)/docs/userguide/Concepts.script\ 30 $(SRC)/docs/userguide/ErrRef.script\ 31 $(SRC)/docs/userguide/HandSrv.script\ 32 $(SRC)/docs/userguide/Install.script\ 33 $(SRC)/docs/userguide/Config.script\ 34 $(SRC)/docs/userguide/Issues.script\ 35 $(SRC)/docs/userguide/ConfigSrv.script\ 36 $(SRC)/docs/userguide/DelaySrv.script\ 37 $(SRC)/docs/userguide/EchoSrv.script\ 38 $(SRC)/docs/userguide/PingSrv.script\ 39 $(SRC)/docs/userguide/LifeCycleSrv.script\ 40 $(SRC)/docs/userguide/LogSrv.script\ 41 $(SRC)/docs/userguide/RLogSrv.script\ 42 $(SRC)/docs/userguide/FLogUtil.script\ 43 $(SRC)/docs/userguide/MonSrv.script\ 44 $(SRC)/docs/userguide/HelpSrv.script\ 45 $(SRC)/docs/userguide/Overview.script\ 46 $(SRC)/docs/userguide/ProcSrv.script\ 47 $(SRC)/docs/userguide/SampRef.script\ 48 $(SRC)/docs/userguide/CodeRef.script\ 49 $(SRC)/docs/userguide/RSPRef.script\ 50 $(SRC)/docs/userguide/Services.script\ 51 $(SRC)/docs/userguide/Utils.script\ 52 $(SRC)/docs/userguide/Migrate.script\ 53 $(SRC)/docs/userguide/STAFUG.script\ 54 $(SRC)/docs/userguide/VarSrv.script\ 55 $(SRC)/docs/userguide/FSSrv.script\ 56 $(SRC)/docs/userguide/SrvSrv.script\ 57 $(SRC)/docs/userguide/TrustSrv.script\ 58 $(SRC)/docs/userguide/ShutSrv.script\ 59 $(SRC)/docs/userguide/PingSrv.script\ 60 $(SRC)/docs/userguide/EchoSrv.script\ 61 $(SRC)/docs/userguide/DelaySrv.script\ 62 $(SRC)/docs/userguide/MiscSrv.script\ 63 $(SRC)/docs/userguide/QueueSrv.script\ 64 $(SRC)/docs/userguide/TraceSrv.script\ 65 $(SRC)/docs/userguide/SemSrv.script\ 66 $(SRC)/docs/userguide/PoolSrv.script\ 67 $(SRC)/docs/userguide/DiagSrv.script\ 68 $(SRC)/docs/userguide/ZipSrv.script\ 69 $(SRC)/samples/rexx/Sample1.cmd\ 70 $(SRC)/samples/rexx/Sample2.cmd\ 71 $(SRC)/samples/rexx/Sample3.cmd\ 72 $(SRC)/samples/rexx/Sample4.cmd\ 73 $(SRC)/samples/cpp/LogIt.cpp\ 74 $(SRC)/samples/c/LogIt.c\ 75 $(SRC)/test/PingTest.cmd\ 76 $(SRC)/test/JPing.java 77 78# Doc targets 79 80# Note: We don't really want to ignore the warning on b2h'ing the User's Guide, 81# but, I don't know how to make b2h ignore the C++ scope operator '::'. 82 83$(REL)/docs/staf/STAFUG.htm: $(UserGuideSrc) $(MAKEFILE_NAME) 84 @echo "*** Building STAF User's Guide ***" 85 @$(CREATE_PATH) 86 -@$(MAKE_PATH) $(O)/docs/staf/userguide 87 @cp $(SRC)/docs/userguide/*.script $(O)/docs/staf/userguide 88 @cp $(SRC)/samples/rexx/Sample1.cmd $(O)/docs/staf/userguide/RexSam1.script 89 @cp $(SRC)/samples/rexx/Sample2.cmd $(O)/docs/staf/userguide/RexSam2.script 90 @cp $(SRC)/samples/rexx/Sample3.cmd $(O)/docs/staf/userguide/RexSam3.script 91 @cp $(SRC)/samples/rexx/Sample4.cmd $(O)/docs/staf/userguide/RexSam4.script 92 @cp $(SRC)/test/PingTest.cmd $(O)/docs/staf/userguide/RexSam5.script 93 @cp $(SRC)/test/JPing.java $(O)/docs/staf/userguide/JavSam1.script 94 @cp $(SRC)/samples/cpp/LogIt.cpp $(O)/docs/staf/userguide/CPPSam1.script 95 @cp $(SRC)/samples/c/LogIt.c $(O)/docs/staf/userguide/CSam1.script 96 @chmod 777 $(O)/docs/staf/userguide/* 97 -@cd $(O)/docs/staf/userguide; $(B2H) STAFUG.script '('HTMLEXT=htm TOC=*2 INDEX "BODYTAG='<BODY" "BGCOLOR=WHITE>'" 'OUTPUTP=$(OS_@)' IMBFT=script 98 99$(REL)/docs/staf/History: $(SRC)/History $(MAKEFILE_NAME) 100 $(COPY_FILE) 101 102$(REL)/docs/staf/STAFHome.htm: $(SRC)/docs/STAFHome.htm $(MAKEFILE_NAME) 103 $(COPY_FILE) 104 105$(REL)/docs/staf/STAFGS.pdf: $(SRC)/docs/gettingstarted/STAFGS.pdf $(MAKEFILE_NAME) 106 $(COPY_FILE) 107 108$(REL)/docs/staf/STAFInstall.pdf: $(SRC)/docs/installguide/STAFInstall.pdf $(MAKEFILE_NAME) 109 $(COPY_FILE) 110 111$(REL)/docs/staf/STAFCMDS.htm: $(SRC)/docs/userguide/CmdRef.script $(MAKEFILE_NAME) 112 @echo "*** Building STAF Command Reference ***" 113 @$(CREATE_PATH) 114 -@$(MAKE_PATH) $(O)/docs/staf/userguide 115 @$(B2H) $(OS_SRC)/docs/userguide/CmdRef.script '('HTMLEXT=htm TOC=NO TITLE="'STAF" Command "Reference'" TOPHEAD=NO "BODYTAG='<BODY" "BGCOLOR=WHITE>'" 'OUTPUTP=$(OS_@)' IMBFT=script 116 117$(REL)/docs/staf/STAFRC.htm: $(SRC)/docs/userguide/ErrRef.script $(MAKEFILE_NAME) 118 @echo "*** Building STAF API Return Code Reference ***" 119 @$(CREATE_PATH) 120 -@$(MAKE_PATH) $(O)/docs/staf/userguide 121 @$(B2H) $(OS_SRC)/docs/userguide/ErrRef.script '('HTMLEXT=htm TOC=NO TITLE="'STAF" API Return Code "Reference'" TOPHEAD=NO "BODYTAG='<BODY" "BGCOLOR=WHITE>'" 'OUTPUTP=$(OS_@)' IMBFT=script 122 123ifndef SAXON_ROOT 124 $(error You must set SAXON_ROOT to the full pathname where you installed Saxon) 125endif 126 127ifndef DOCBOOK_ROOT 128 $(error You must set DOCBOOK_ROOT to the full pathname where you installed DocBook XSL) 129endif 130 131 132$(REL)/docs/staf/STAFFAQ.htm: $(SRC)/docs/faq/STAFFAQ.xml $(MAKEFILE_NAME) 133 @echo "*** Building STAF FAQ ***" 134 @$(CREATE_PATH) 135 -@$(MAKE_PATH) $(O)/docs/staf/faq 136 @cp $(SRC)/docs/faq/*.xml $(O)/docs/staf/faq 137 @chmod 777 $(O)/docs/staf/faq/* 138 @cd $(O)/docs/staf/faq; $(JAVA) -cp $(SAXON_ROOT)/saxon.jar com.icl.saxon.StyleSheet -o STAFFAQ.htm STAFFAQ.xml $(DOCBOOK_ROOT)/html/docbook.xsl 139 @cp $(O)/docs/staf/faq/STAFFAQ.htm $(REL)/docs/staf/STAFFAQ.htm 140 141$(REL)/docs/staf/STAFDiag.htm: $(SRC)/docs/diagnosticsguide/STAFDiag.xml $(MAKEFILE_NAME) 142 @echo "*** Building STAF Diagnostics Guide ***" 143 @$(CREATE_PATH) 144 -@$(MAKE_PATH) $(O)/docs/staf/diagnosticsguide 145 @cp $(SRC)/docs/diagnosticsguide/*.xml $(O)/docs/staf/diagnosticsguide 146 @chmod 777 $(O)/docs/staf/diagnosticsguide/* 147 @cd $(O)/docs/staf/diagnosticsguide; $(JAVA) -cp $(SAXON_ROOT)/saxon.jar com.icl.saxon.StyleSheet -o STAFDiag.htm STAFDiag.xml $(DOCBOOK_ROOT)/html/docbook.xsl 148 @cp $(O)/docs/staf/diagnosticsguide/STAFDiag.htm $(REL)/docs/staf/STAFDiag.htm 149 150# Create STAFGS html document from the .xml file to verify that no syntax errors exist 151# XXX: When able to generate pdf file automatically, change to create it and copy it to $(REL)/docs/staf/STAFGS.pdf 152 153$(O)/docs/staf/gettingstarted/STAFGS.htm: $(SRC)/docs/gettingstarted/STAFGS.xml $(MAKEFILE_NAME) 154 @echo "*** Building Getting Started with STAF ***" 155 @$(CREATE_PATH) 156 -@$(MAKE_PATH) $(O)/docs/staf/gettingstarted 157 @cp $(SRC)/docs/gettingstarted/*.xml $(O)/docs/staf/gettingstarted 158 @cp $(SRC)/docs/gettingstarted/*.gif $(O)/docs/staf/gettingstarted 159 @chmod 777 $(O)/docs/staf/gettingstarted/* 160 @cd $(O)/docs/staf/gettingstarted; $(JAVA) -cp $(SAXON_ROOT)/saxon.jar com.icl.saxon.StyleSheet -o STAFGS.htm STAFGS.xml $(DOCBOOK_ROOT)/html/docbook.xsl 161 162# Create STAFInstall html document from the .xml file to verify that no syntax errors exist 163# XXX: When able to generate pdf file automatically, change to create it and copy it to $(REL)/docs/staf/STAFInstall.pdf 164 165$(O)/docs/staf/installguide/STAFInstall.htm: $(SRC)/docs/installguide/STAFInstall.xml $(MAKEFILE_NAME) 166 @echo "*** Building STAF Installation Guide ***" 167 @$(CREATE_PATH) 168 -@$(MAKE_PATH) $(O)/docs/staf/installguide 169 @cp $(SRC)/docs/installguide/*.xml $(O)/docs/staf/installguide 170 @cp $(SRC)/docs/installguide/*.gif $(O)/docs/staf/installguide 171 @chmod 777 $(O)/docs/staf/installguide/* 172 @cd $(O)/docs/staf/installguide; $(JAVA) -cp $(SAXON_ROOT)/saxon.jar com.icl.saxon.StyleSheet -o STAFInstall.htm STAFInstall.xml $(DOCBOOK_ROOT)/html/docbook.xsl 173 174cleanup_docs: 175 -@$(DEL) $(O)/docs/staf/userguide/* $(OUT_ERR_TO_DEV_NULL) 176 -@$(DEL) $(O)/docs/staf/gettingstarted/* $(OUT_ERR_TO_DEV_NULL) 177 -@$(DEL) $(REL)/docs/staf/STAFUG.htm $(OUT_ERR_TO_DEV_NULL) 178 -@$(DEL) $(REL)/docs/staf/STAFHome.htm $(OUT_ERR_TO_DEV_NULL) 179 -@$(DEL) $(REL)/docs/staf/STAFFAQ.htm $(OUT_ERR_TO_DEV_NULL) 180 -@$(DEL) $(REL)/docs/staf/STAFGS.pdf $(OUT_ERR_TO_DEV_NULL) 181 -@$(DEL) $(REL)/docs/staf/STAFInstall.pdf $(OUT_ERR_TO_DEV_NULL) 182 -@$(DEL) $(REL)/docs/staf/STAFCMDS.htm $(OUT_ERR_TO_DEV_NULL) 183 -@$(DEL) $(REL)/docs/staf/STAFRC.htm $(OUT_ERR_TO_DEV_NULL) 184 -@$(DEL) $(REL)/docs/staf/History $(OUT_ERR_TO_DEV_NULL) 185