VirtualBox

Changeset 105564 in vbox


Ignore:
Timestamp:
Aug 1, 2024 12:18:48 PM (4 months ago)
Author:
vboxsync
Message:

doc/manual/Config.kmk, doc/manual/Makefile: Add catalog for DITA DTD essentials (won't do any harm for pure DocBook format documentation, the dita.v1_3 stuff didn't work due to xsltproc tripping over SVG entity definitions) and remove the related XML search path hack. Adjust XML search path so that the licensing content is found. bugref:10348

doc/manual/en_US/dita/UserManual.ditamap: Enable LIUM chapter, the XML search path fix resolved the errors when building the VirtualBox help. bugref:10705

doc/manual/pdf-theme-UserManual.yaml: lower the monospace font size for various tags to get more into a line, avoiding ugly line breaks

Location:
trunk/doc/manual
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Config.kmk

    r105298 r105564  
    117117  VBOX_PATH_DOCBOOK       ?= $(KBUILD_DEVTOOLS)/common/DocBook/v1.69.1
    118118  VBOX_PATH_DOCBOOK_DTD   ?= $(KBUILD_DEVTOOLS)/common/docbook-xml/v4.5
     119  VBOX_PATH_DITA_DTD      ?= $(VBOX_DITA_OT_PATH)/plugins/org.oasis-open.dita.v1_2/dtd
    119120 else
    120121  # use docbook of the build host
    121122  VBOX_PATH_DOCBOOK       ?= /usr/share/xml/docbook/stylesheet/docbook-xsl
    122123  VBOX_PATH_DOCBOOK_DTD   ?= /usr/share/xml/docbook/schema/dtd/4.5
     124  VBOX_PATH_DITA_DTD      ?= $(VBOX_DITA_OT_PATH)/plugins/org.oasis-open.dita.v1_2/dtd
    123125 endif
    124126 VBOX_XML_CATALOG         ?= $(VBOX_PATH_MANUAL_OUTBASE)/vbox-doc.cat
    125127 VBOX_XML_CATALOG_DOCBOOK ?= $(VBOX_PATH_MANUAL_OUTBASE)/docbook.cat
     128 VBOX_XML_CATALOG_DITA    ?= $(VBOX_PATH_MANUAL_OUTBASE)/dita.cat
    126129 VBOX_XML_CATALOG_MANUAL  ?= $(VBOX_PATH_MANUAL_OUTBASE)/manual.cat
     130 VBOX_XML_ALL_CATALOGS_DEP ?= $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_DITA) $(VBOX_XML_CATALOG_MANUAL)
    127131 VBOX_XML_ENTITIES        ?= $(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent
    128132
    … …  
    168172                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
    169173                $(if $(4), $$(VBOX_PATH_MANUAL_OUTBASE)/$(5)/$$(VBOX_XML_XREF_TO_TEXT),) \
    170                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
     174                $$(VBOX_XML_ALL_CATALOGS_DEP) \
    171175                $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
    172176        $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
    … …  
    195199                $$(VBOX_DOCBOOK_REFENTRY_TO_H_HELP) \
    196200                $(2) \
    197                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) $(MAKEFILE) | $$$$(dir $$$$@)
     201                $$(VBOX_XML_ALL_CATALOGS_DEP) $(MAKEFILE) | $$$$(dir $$$$@)
    198202        $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(filter %.xml,$$^),$$(patsubst %.ts,%,$$@))
    199203        $$(QUIET)$$(APPEND) -tn "$$@" \
    … …  
    254258                '  <delegateURI uriStartString="http://www.oasis-open.org/docbook/"         catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
    255259                '  <delegateURI uriStartString="http://docbook.org/"                        catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DOCBOOK)"/>' \
     260                '  <delegatePublic publicIdStartString="-//OASIS/DTD DITA"                                      catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DITA)"/>' \
     261                '  <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_SRC)/en_US/dita/bookmap.dtd"         catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DITA)"/>' \
     262                '  <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/topic.dtd"    catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_DITA)"/>' \
    256263                '  <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_SRC)"            catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
    257264                '  <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_OUTBASE)"        catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \
    … …  
    302309                '</catalog>'
    303310
     311  # Create a dita catalog file for xsltproc that points to the local dita files.
     312  $(VBOX_XML_CATALOG_DITA): $(VBOX_PATH_MANUAL_SRC)/Config.kmk | $$(dir $$@)
     313        $(call MSG_L1,Creating catalog $@)
     314        $(QUIET)$(APPEND) -tn "$@" \
     315                '<?xml version="1.0"?>' \
     316                '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \
     317                '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \
     318                '  <public publicId="-//OASIS//DTD DITA BookMap//EN"        uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DITA_DTD)/bookmap/dtd/bookmap.dtd"/>' \
     319                '  <public publicId="-//OASIS//DTD DITA Topic//EN"          uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DITA_DTD)/technicalContent/dtd/topic.dtd"/>' \
     320                '  <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/dita/bookmap.dtd"    uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DITA_DTD)/bookmap/dtd/bookmap.dtd"/>' \
     321                '  <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/topic.dtd"      uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DITA_DTD)/technicalContent/dtd/topic.dtd"/>' \
     322                '</catalog>'
     323
    304324  # Create a docbook catalog file for xsltproc that points to the local manual files in non-default locations
    305325  $(VBOX_XML_CATALOG_MANUAL): $(VBOX_PATH_MANUAL_SRC)/Config.kmk | $$(dir $$@)
    … …  
    379399                $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/*.xml) \
    380400                $$(VBOX_MANUAL_XML_FILES_COMMON) \
    381                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) $$(VBOX_XML_ENTITIES) \
     401                $$(VBOX_XML_ALL_CATALOGS_DEP) $$(VBOX_XML_ENTITIES) \
    382402                | $$$$(dir $$$$@)
    383403        $$(call MSG_L1,Creating stylesheet $$@)
    … …  
    394414  if 0 # Enable to see the full combined document.
    395415        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
     416                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/licensing/vbox-base" \
     417                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/licensing/vbox-ext" \
     418                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/licensing" \
    396419                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
    397                 --path "$(VBOX_DITA_OT_PATH)/dtd/bookmap/dtd" \
    398                 --path "$(VBOX_DITA_OT_PATH)/dtd/technicalContent/dtd" \
    399420                --output "[email protected]" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" "[email protected]"
    400421  endif
    401422        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
     423                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/licensing/vbox-base" \
     424                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/licensing/vbox-ext" \
     425                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics/licensing" \
    402426                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
    403                 --path "$(VBOX_DITA_OT_PATH)/dtd/bookmap/dtd" \
    404                 --path "$(VBOX_DITA_OT_PATH)/dtd/technicalContent/dtd" \
    405427                --stringparam 'g_sMode' 'first' \
    406428                --output "$$@" \

  • trunk/doc/manual/Makefile.kmk

    r105515 r105564  
    201201        $(VBOX_XML_CATALOG) \
    202202        $(VBOX_XML_CATALOG_DOCBOOK) \
     203        $(VBOX_XML_CATALOG_DITA) \
    203204        $(VBOX_XML_CATALOG_MANUAL) \
    204205        $(VBOX_XML_ENTITIES) \
    … …  
    443444                $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
    444445                $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
    445                 $(VBOX_XML_CATALOG) \
    446                 $(VBOX_XML_CATALOG_DOCBOOK) \
    447                 $(VBOX_XML_CATALOG_MANUAL) \
     446                $(VBOX_XML_ALL_CATALOGS_DEP) \
    448447                $(VBOX_XML_ENTITIES) \
    449448                $(MAKEFILE_CURRENT) \
    … …  
    485484                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
    486485                $(VBOX_MANUAL_APIREF_TMP) \
    487                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
     486                $(VBOX_XML_ALL_CATALOGS_DEP) \
    488487                $(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) | $$(dir $$@)
    489488        $(call MSG_L1,Validating $<)
    … …  
    506505                $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
    507506                $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
    508                 $(VBOX_XML_CATALOG) \
    509                 $(VBOX_XML_CATALOG_DOCBOOK) \
    510                 $(VBOX_XML_CATALOG_MANUAL) \
     507                $(VBOX_XML_ALL_CATALOGS_DEP) \
    511508                $(VBOX_XML_ENTITIES) \
    512509                $(MAKEFILE_CURRENT) \
    … …  
    544541                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
    545542                $(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
    546                 $(VBOX_XML_CATALOG) \
    547                 $(VBOX_XML_CATALOG_DOCBOOK) \
    548                 $(VBOX_XML_CATALOG_MANUAL) \
     543                $(VBOX_XML_ALL_CATALOGS_DEP) \
    549544                $(VBOX_XML_ENTITIES) | $$(dir $$@)
    550545        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
    … …  
    559554                $(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
    560555                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
    561                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
     556                $(VBOX_XML_ALL_CATALOGS_DEP) \
    562557                $(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) | $$(dir $$@)
    563558        $(call MSG_L1,Validating $<)
    … …  
    692687                $$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1) \
    693688                $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
    694                 $$(VBOX_XML_CATALOG) \
    695                 $$(VBOX_XML_CATALOG_DOCBOOK) \
    696                 $$(VBOX_XML_CATALOG_MANUAL) \
     689                $$(VBOX_XML_ALL_CATALOGS_DEP) \
    697690                $$(VBOX_XML_ENTITIES) \
    698691                $$(VBOX_VERSION_STAMP) \
    … …  
    838831                $$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.sh \
    839832                $$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
    840                 $$(VBOX_XML_CATALOG) \
    841                 $$(VBOX_XML_CATALOG_DOCBOOK) \
    842                 $$(VBOX_XML_CATALOG_MANUAL) \
     833                $$(VBOX_XML_ALL_CATALOGS_DEP) \
    843834                | $$$$(dir $$$$@)
    844835        $$(call MSG_TOOL,xsltproc docbook-changelog-to-manual-dita.xsl,,,$$@)
    … …  
    11541145                $(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
    11551146                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
    1156                 $(VBOX_XML_CATALOG) \
    1157                 $(VBOX_XML_CATALOG_DOCBOOK) \
    1158                 $(VBOX_XML_CATALOG_MANUAL) \
     1147                $(VBOX_XML_ALL_CATALOGS_DEP) \
    11591148                $(VBOX_XML_ENTITIES) | $$(dir $$@)
    11601149        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
    … …  
    11801169                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
    11811170                $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
    1182                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
     1171                $$(VBOX_XML_ALL_CATALOGS_DEP) \
    11831172                $$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
    11841173        $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
    … …  
    11951184                $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
    11961185                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
    1197                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
     1186                $$(VBOX_XML_ALL_CATALOGS_DEP) \
    11981187                $$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
    11991188        $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)

  • trunk/doc/manual/en_US/dita/UserManual.ditamap

    r105515 r105564  
    645645   </chapter>
    646646
    647 <!--    <chapter href="topics/licensing/licensing_chapter.dita" chunk="to-content">
     647   <!-- Third Party Licenses-->
     648   <chapter href="topics/licensing/licensing_chapter.dita" chunk="to-content">
    648649      <topicref format="ditamap" href="topics/licensing/licensing.ditamap"/>
    649    </chapter> -->
    650 
    651    <!-- Third Party Licenses-->
     650   </chapter>
    652651
    653652   <chapter href="topics/privacy.dita" chunk="to-content"/>

  • trunk/doc/manual/pdf-theme-UserManual.yaml

    r105417 r105564  
    261261    syntaxdiagram:
    262262        font-family:        $pdf2-font-monospaced
     263        font-size:          10pt                # Needed for long unbreakable synopsis bits
    263264        start-indent:       '1cm + from-parent(start-indent)'
    264265        text-indent:        -1cm
    … …  
    268269    pre:
    269270        font-family:        $pdf2-font-monospaced
     271        font-size:          9pt                 # Needed for 80 column
    270272    userinput:
    271273        font-family:        $pdf2-font-monospaced
     274        font-size:          10pt                # More line length without annoying line breaks
    272275    screen:
    273276        font-family:        $pdf2-font-monospaced
     277        font-size:          10pt                # More line length without annoying line breaks
    274278    systemoutput:
    275279        font-family:        $pdf2-font-monospaced
     280        font-size:          10pt                # More line length without annoying line breaks
    276281
    277282
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