VirtualBox

Changeset 99617 in vbox for trunk/doc/manual


Ignore:
Timestamp:
May 5, 2023 8:53:50 AM (21 months ago)
Author:
vboxsync
Message:

manual: Kicked out the dita 1.8.5 related stuff to reduce the makefile messyness. bugref:10302

Location:
trunk/doc/manual
Files:
1 deleted
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/Config.kmk

    r99501 r99617  
    4040
    4141 # DITA stuff.
    42  VBOX_DITA_CONVERTER_PATH ?= $(PATH_ROOT)/src/libs/dbdita-1.0
    43  VBOX_DITA_ORIGINAL_PATH  ?= $(PATH_ROOT)/src/libs/dita-ot-1.8.5
     42 VBOX_DITA_OT_PATH  ?= $(PATH_ROOT)/src/libs/dita-ot-1.8.5
     43 ifneq ($(VBOX_DITA_OT_PATH),)
     44  VBOX_DITA_OT_PATH := $(firstfile \
     45        $(rversortfiles $(qwildcard ,$(KBUILD_DEVTOOLS)/common/dita-ot/v[4-9].*)) \
     46        $(KBUILD_DEVTOOLS)/common/dita-ot/v4.0.2-r1)
     47 endif
    4448
    4549
     
    384388        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
    385389                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
    386                 --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/bookmap/dtd" \
    387                 --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd" \
     390                --path "$(VBOX_DITA_OT_PATH)/dtd/bookmap/dtd" \
     391                --path "$(VBOX_DITA_OT_PATH)/dtd/technicalContent/dtd" \
    388392                --output "[email protected]" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" "[email protected]"
    389393  endif
    390394        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
    391395                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
    392                 --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/bookmap/dtd" \
    393                 --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd" \
     396                --path "$(VBOX_DITA_OT_PATH)/dtd/bookmap/dtd" \
     397                --path "$(VBOX_DITA_OT_PATH)/dtd/technicalContent/dtd" \
    394398                --stringparam 'g_sMode' 'first' \
    395399                --output "$$@" \
  • trunk/doc/manual/Makefile.kmk

    r99613 r99617  
    107107 endif
    108108
     109 #
     110 # Java v17 or later (JAVA_HOME), used by DITA-OT.
     111 #
     112 ifeq ($(VBOX_JAVA17PLUS_HOME),)
     113  if defined(VBOX_JAVA_VERSION) && $(VBOX_JAVA_VERSION) >= 170000 && "$(VBOX_JAVA_BIN_PATH)" != ""
     114   VBOX_JAVA17PLUS_HOME   := $(qabspath ,$(VBOX_JAVA_BIN_PATH)/..)
     115  else
     116   VBOX_JAVA17PLUS_HOME   := $(firstfile \
     117                $(rversortfiles $(qwildcard ,    $(KBUILD_DEVTOOLS_HST)/jdk/v1[789].*     $(KBUILD_DEVTOOLS_HST)/jdk/v[2-9][0-9].* )) \
     118                $(rversortfiles $(qwildcard ,$(KBUILD_DEVTOOLS_HST_ALT)/jdk/v1[789].* $(KBUILD_DEVTOOLS_HST_ALT)/jdk/v[2-9][0-9].* )) \
     119                )
     120   if "$(KBUILD_HOST)" == "darwin" && "$(VBOX_JAVA17PLUS_HOME)" != ""
     121    VBOX_JAVA17PLUS_HOME := $(VBOX_JAVA17PLUS_HOME)/Contents/Home
     122   endif
     123  endif
     124 endif
    109125
    110126 #
    111127 # DITA-OT related globals.
    112128 #
    113  VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH = $(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd
     129 VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH = $(VBOX_DITA_OT_PATH)/plugins/org.oasis-open.dita.v1_2/dtd/technicalContent/dtd
    114130
    115131 ##
     
    118134 # Additional options for dost.jar can be specified following the call to VBOX_DITA_RUN_DOST
    119135 #
    120  # @param 1    Temporary+unique DITA-OT path.
    121  # @param 2    Additional kmk_redirect options.
    122  # @param 3    Parameters for the invoker.
    123  # @param 4    Parameters only for 1.8.5.
    124  # @param 5    Parameters only for 4.0.2.
    125  #
    126  VBOX_DITA_RUN_DOST ?= $(REDIRECT) \
    127         -E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
    128         -E 'ANT_HOME=$1/tools/ant' \
    129         -E 'DITA_DIR=$1' \
    130         -E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
    131         -A 'PATH=$(HOST_PATH_SEP)$1/tools/ant/bin' \
    132         -E 'CLASSPATH=$1/lib/dost.jar' \
    133         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib' \
    134         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/commons-codec-1.4.jar' \
    135         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/resolver.jar' \
    136         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/icu4j.jar' \
    137         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xercesImpl.jar' \
    138         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xml-apis.jar' \
    139         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9.jar' \
    140         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9-dom.jar' \
    141         $2 \
    142         -- $(ASH) $(VBOX_PATH_MANUAL_SRC)/dita-ot-copy-exec.sh "$(VBOX_DITA_ORIGINAL_PATH)" "$1" \
    143         -- $(VBOX_JAVA) -jar "$1/lib/dost.jar" "/ditadir:$1" \
    144         $(if-expr defined(VBOX_DITA_DEBUG),"/cleantemp:no" "/debug:yes",) \
    145         $3 $4 # "/outercontrol:fail" ?
    146 
    147  if1of ($(KBUILD_HOST), darwin linux win)
    148   VBOX_DITA_USING_LATEST := 1
    149  endif
    150  ifdef VBOX_DITA_USING_LATEST
    151   VBOX_DITA_USING_LATEST  := 1
    152   ifeq ($(VBOX_JAVA17PLUS_HOME),)
    153    if defined(VBOX_JAVA_VERSION) && $(VBOX_JAVA_VERSION) >= 170000 && "$(VBOX_JAVA_BIN_PATH)" != ""
    154     VBOX_JAVA17PLUS_HOME   := $(qabspath ,$(VBOX_JAVA_BIN_PATH)/..)
    155    else
    156     VBOX_JAVA17PLUS_HOME   := $(firstfile \
    157                 $(rversortfiles $(qwildcard ,    $(KBUILD_DEVTOOLS_HST)/jdk/v1[789].*     $(KBUILD_DEVTOOLS_HST)/jdk/v[2-9][0-9].* )) \
    158                 $(rversortfiles $(qwildcard ,$(KBUILD_DEVTOOLS_HST_ALT)/jdk/v1[789].* $(KBUILD_DEVTOOLS_HST_ALT)/jdk/v[2-9][0-9].* )) \
    159                 )
    160     if "$(KBUILD_HOST)" == "darwin" && "$(VBOX_JAVA17PLUS_HOME)" != ""
    161      VBOX_JAVA17PLUS_HOME := $(VBOX_JAVA17PLUS_HOME)/Contents/Home
    162     endif
    163    endif
    164   endif
    165   VBOX_DITA_ORIGINAL_PATH := $(firstfile $(rversortfiles $(qwildcard ,$(KBUILD_DEVTOOLS)/common/dita-ot/v[4-9].*)) \
    166                 $(KBUILD_DEVTOOLS)/common/dita-ot/v4.0.2-r1)
    167 
    168   VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH = $(VBOX_DITA_ORIGINAL_PATH)/plugins/org.oasis-open.dita.v1_2/dtd/technicalContent/dtd
    169   VBOX_DITA_CLASSPATH = \
    170         $(subst $(SP),$(HOST_PATH_SEP),$(strip \
    171                         $(VBOX_DITA_ORIGINAL_PATH)/lib/ant-launcher.jar \
    172                         $(VBOX_DITA_ORIGINAL_PATH)/config \
    173                         $(VBOX_DITA_ORIGINAL_PATH)/lib \
    174                         $(wildcard \
    175                                 $(VBOX_DITA_ORIGINAL_PATH)/lib/*.jar \
    176                                 $(VBOX_DITA_ORIGINAL_PATH)/plugins/*/lib/*.jar)))
    177   VBOX_DITA_RUN_DOST = $(REDIRECT_EXT) \
    178         -E 'ANT_HOME=$(VBOX_DITA_ORIGINAL_PATH)' \
    179         -E 'DITA_DIR=$(VBOX_DITA_ORIGINAL_PATH)' \
    180         -E 'JAVA_HOME=$(VBOX_JAVA17PLUS_HOME)' \
    181         -E 'CLASSPATH=$(VBOX_DITA_CLASSPATH)' \
    182         $2 \
    183         -- \
    184         $(VBOX_JAVA17PLUS_HOME)/bin/java \
    185         "-Djava.awt.headless=true" \
    186         "-Dsun.io.useCanonCaches=true" \
    187         "-Dant.home=$(VBOX_DITA_ORIGINAL_PATH)" \
    188         "-Ddita.dir=$(VBOX_DITA_ORIGINAL_PATH)" \
    189         org.apache.tools.ant.launch.Launcher \
    190         -cp "$(VBOX_DITA_CLASSPATH)" \
    191         -buildfile "$(VBOX_DITA_ORIGINAL_PATH)/build.xml" \
    192         -main "org.dita.dost.invoker.Main" \
    193         --args.grammar.cache=yes \
    194         $(patsubst "/i:%,"--input=%, \
    195                 $(patsubst "/transtype:%,"--format=%, \
    196                         $(patsubst "/outdir:%,"--output=%, \
    197                                 $(patsubst "/tempdir:%,"--temp=%, \
    198                                         $(patsubst "/filter:%,"--filter=%, \
    199                                                 $(patsubst "/debug","--debug",$3)))))) \
    200         $(if-expr defined(VBOX_DITA_DEBUG),"--clean.temp=no" "--debug",) \
    201         $5 --verbose
    202  endif
     136 # @param 1    Additional kmk_redirect options.
     137 # @param 2    Parameters for the invoker.
     138 #
     139 VBOX_DITA_RUN_DOST = $(REDIRECT_EXT) \
     140        -E 'ANT_HOME=$(VBOX_DITA_OT_PATH)' \
     141        -E 'DITA_DIR=$(VBOX_DITA_OT_PATH)' \
     142        -E 'JAVA_HOME=$(VBOX_JAVA17PLUS_HOME)' \
     143        -E 'CLASSPATH=$(VBOX_DITA_CLASSPATH)' \
     144        $1 \
     145        -- \
     146        "$(VBOX_JAVA17PLUS_HOME)/bin/java" \
     147        "-Djava.awt.headless=true" \
     148        "-Dsun.io.useCanonCaches=true" \
     149        "-Dant.home=$(VBOX_DITA_OT_PATH)" \
     150        "-Ddita.dir=$(VBOX_DITA_OT_PATH)" \
     151        org.apache.tools.ant.launch.Launcher \
     152        -cp "$(VBOX_DITA_CLASSPATH)" \
     153        -buildfile "$(VBOX_DITA_OT_PATH)/build.xml" \
     154        -main "org.dita.dost.invoker.Main" \
     155        --args.grammar.cache=yes \
     156        --verbose \
     157        $(if-expr defined(VBOX_DITA_DEBUG),"--clean.temp=no" "--debug",) \
     158        $2
     159
     160 VBOX_DITA_CLASSPATH = \
     161        $(subst $(SP),$(HOST_PATH_SEP),$(strip \
     162                        $(VBOX_DITA_OT_PATH)/lib/ant-launcher.jar \
     163                        $(VBOX_DITA_OT_PATH)/config \
     164                        $(VBOX_DITA_OT_PATH)/lib \
     165                        $(wildcard \
     166                                $(VBOX_DITA_OT_PATH)/lib/*.jar \
     167                                $(VBOX_DITA_OT_PATH)/plugins/*/lib/*.jar)))
    203168
    204169
     
    811776 # 4a. UserManual.pdf - Run dost.jar from DITA-OT to produce the PDF version.
    812777 #
    813  # Note! The /tempdir is deleted, recreated, used and deleted again for each
     778 # Note! The --temp (dir) is deleted, recreated, used and deleted again for each
    814779 #       run. So, be careful where you point it.
    815780 # Note! This crappy utility may fail to find files (or fail to parse the
     
    832797                $$(if-expr defined(VBOX_DITA_USING_LATEST),,"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log")
    833798        $$(QUIET)$$(RM) -Rf -- "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-pdf/"
    834         $$(QUIET)$$(call VBOX_DITA_RUN_DOST,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-pdf,, \
    835                 "/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
    836                 "/transtype:pdf" \
    837                 "/filter:$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/ohc.ditaval" \
    838                 "/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
    839                 "/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf" \
    840                 , \
    841                "/grammarcache:yes" \
    842                 , \
     799        $$(QUIET)$$(call VBOX_DITA_RUN_DOST,, \
     800                "--input=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
     801                "--format=pdf" \
     802                "--filter=$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/ohc.ditaval" \
     803                "--output=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
     804                "--temp=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf" \
    843805                "--theme=$$(VBOX_PATH_MANUAL_SRC)/pdf-theme-UserManual.yaml" \
    844806                "--logfile=$$(@D)/UserManual_pdf.log" \
     
    871833        $(call MSG_L1,Building html chunks $@ ($(@D)/UserManual_xhtml.log))
    872834        $(QUIET)$(MKDIR) -- "$(@D)"
    873         $(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks,, \
    874                 "/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
    875                 "/transtype:xhtml" \
    876                 "/filter:$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
    877                 "/outdir:$(@D)" \
    878                 "/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks" \
    879                 , \
    880                "/grammarcache:yes" \
    881                , \
     835        $(QUIET)$(call VBOX_DITA_RUN_DOST,, \
     836                "--input=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
     837                "--format=xhtml" \
     838                "--filter=$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
     839                "--output=$(@D)" \
     840                "--temp=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks" \
    882841               "--logfile=$(@D)/UserManual_xhtml.log" \
    883842        "--store-type=memory" \
     
    927886        $(QUIET)$(RM) -Rf -- "$(@D)" "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-single/"
    928887        $(QUIET)$(MKDIR) -- "$(@D)"
    929         $(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-single,, \
    930                 "/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
    931                 "/transtype:xhtml" \
    932                 "/outdir:$(@D)" \
    933                 "/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_single" \
    934                 , \
    935                "/grammarcache:yes" \
    936                , \
     888        $(QUIET)$(call VBOX_DITA_RUN_DOST,, \
     889                "--input=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
     890                "--format=xhtml" \
     891                "--output=$(@D)" \
     892                "--temp=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_single" \
    937893               "--logfile=$(@D)/UserManual-Single_xhtml.log" \
    938894        "--store-type=memory" \
     
    1037993        $$(call MSG_L1,dita-ot-qhelp, => $$@ ($(2)/UserManual_htmlhelp.log))
    1038994        $$(QUIET)$$(MKDIR) -- "$$(@D)"
    1039         $$(call VBOX_DITA_RUN_DOST,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-qhelp, -EHHCDIR="$$(@D)", \
    1040                 "/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
    1041                 "/transtype:htmlhelp" \
    1042                 "/filter:$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/htmlhelp.ditaval" \
    1043                 "/outdir:$(2)" \
    1044                 "/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp" \
    1045                 , \
    1046                 "/grammarcache:yes" \
    1047                 , \
     995        $$(call VBOX_DITA_RUN_DOST, -EHHCDIR="$$(@D)", \
     996                "--input=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
     997                "--format=htmlhelp" \
     998                "--filter=$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/htmlhelp.ditaval" \
     999                "--output=$(2)" \
     1000                "--temp=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp" \
    10481001                "--logfile=$(2)/UserManual_htmlhelp.log" \
    10491002                "-Ddita.output.dir=$(2)" \
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette