diff options
-rw-r--r-- | Repository.mk | 8 | ||||
-rw-r--r-- | RepositoryModule_build.mk | 6 | ||||
-rw-r--r-- | RepositoryModule_host.mk | 4 | ||||
-rw-r--r-- | config_host/config_features.h.in | 7 | ||||
-rw-r--r-- | configure.ac | 164 | ||||
-rw-r--r-- | desktop/Library_deployment.mk | 2 | ||||
-rw-r--r-- | desktop/source/deployment/registry/help/dp_help.cxx | 6 | ||||
-rw-r--r-- | postprocess/Rdb_services.mk | 2 | ||||
-rw-r--r-- | scp2/source/base/file_base.scp | 2 | ||||
-rw-r--r-- | scp2/source/calc/file_calc.scp | 2 | ||||
-rw-r--r-- | scp2/source/draw/file_draw.scp | 2 | ||||
-rw-r--r-- | scp2/source/impress/file_impress.scp | 2 | ||||
-rw-r--r-- | scp2/source/math/file_math.scp | 2 | ||||
-rw-r--r-- | scp2/source/ooo/file_ooo.scp | 2 | ||||
-rw-r--r-- | scp2/source/writer/file_writer.scp | 2 | ||||
-rw-r--r-- | sfx2/source/appl/app.cxx | 8 | ||||
-rw-r--r-- | solenv/gbuild/Helper.mk | 15 | ||||
-rw-r--r-- | solenv/gbuild/extensions/pre_BuildTools.mk | 10 | ||||
-rw-r--r-- | sw/qa/uitest/writer_tests3/hyperlinkdialog.py | 4 | ||||
-rw-r--r-- | xmlhelp/README.md | 3 |
20 files changed, 148 insertions, 105 deletions
diff --git a/Repository.mk b/Repository.mk index e95ea304ffda..fed21096eb2b 100644 --- a/Repository.mk +++ b/Repository.mk @@ -18,8 +18,8 @@ # $(eval $(call gb_Helper_register_executables,NONE, \ - HelpIndexer \ - HelpLinker \ + $(call gb_Helper_optional,HELPTOOLS,HelpIndexer) \ + $(call gb_Helper_optional,HELPTOOLS,HelpLinker) \ bestreversemap \ canvasdemo \ cfgex \ @@ -621,7 +621,7 @@ $(eval $(call gb_Helper_register_libraries_for_install,PLAINLIBS_OOO,ooo, \ $(if $(WITH_WEBDAV),ucpdav1) \ ucpfile1 \ ucpftp1 \ - ucpchelp1 \ + $(call gb_Helper_optional,XMLHELP,ucpchelp1) \ ucphier1 \ ucppkg1 \ unopkgapp \ @@ -913,7 +913,7 @@ $(eval $(call gb_Helper_register_packages_for_install,ooo,\ $(if $(filter $(OS),MACOSX),vcl_osxres) \ xmloff_dtd \ xmlscript_dtd \ - xmlhelp_helpxsl \ + $(call gb_Helper_optional,XMLHELP,xmlhelp_helpxsl) \ $(if $(ENABLE_JAVA),\ scripting_java \ scripting_java_jars \ diff --git a/RepositoryModule_build.mk b/RepositoryModule_build.mk index 3ea89f432c41..b15f9547c7be 100644 --- a/RepositoryModule_build.mk +++ b/RepositoryModule_build.mk @@ -87,10 +87,8 @@ $(eval $(call gb_Module_add_moduledirs,cross_toolset,\ xmloff \ xmlscript \ ) \ - $(call gb_Helper_optional_for_host,DESKTOP, \ - helpcompiler \ - xmlhelp \ - ) \ + $(call gb_Helper_optionals_or,HELPTOOLS XMLHELP,helpcompiler) \ + $(call gb_Helper_optional,HELPVIEWER,xmlhelp) \ $(call gb_Helper_optional,QADEVOOO,qadevOOo) \ )) diff --git a/RepositoryModule_host.mk b/RepositoryModule_host.mk index 94a986ea2db7..a13278563270 100644 --- a/RepositoryModule_host.mk +++ b/RepositoryModule_host.mk @@ -60,7 +60,7 @@ $(eval $(call gb_Module_add_moduledirs,libreoffice,\ formula \ $(call gb_Helper_optional,DESKTOP,fpicker) \ framework \ - $(call gb_Helper_optional,DESKTOP,helpcompiler) \ + $(call gb_Helper_optionals_or,HELPTOOLS XMLHELP,helpcompiler) \ $(call gb_Helper_optional,HELP,helpcontent2) \ hwpfilter \ i18nlangtag \ @@ -153,7 +153,7 @@ $(eval $(call gb_Module_add_moduledirs,libreoffice,\ writerfilter \ writerperfect \ xmerge \ - $(call gb_Helper_optional,DESKTOP,xmlhelp) \ + $(call gb_Helper_optional,XMLHELP,xmlhelp) \ xmloff \ xmlreader \ xmlscript \ diff --git a/config_host/config_features.h.in b/config_host/config_features.h.in index a4ecdd76af8b..f59fd4971e70 100644 --- a/config_host/config_features.h.in +++ b/config_host/config_features.h.in @@ -157,4 +157,11 @@ */ #define HAVE_FEATURE_COMMUNITY_FLAVOR 0 +/* XMLHELP - whether we include the XML help mechanisms + * + * Can be turned off with --without-xmlhelp + */ + +#define HAVE_FEATURE_XMLHELP 0 + #endif diff --git a/configure.ac b/configure.ac index 32cc3e1b1dd0..b39e7c933ad5 100644 --- a/configure.ac +++ b/configure.ac @@ -980,6 +980,7 @@ ios*) # iOS enable_postgresql_sdbc=no enable_extension_integration=no enable_report_builder=no + enable_xmlhelp=no with_ppds=no if test "$enable_ios_simulator" = "yes"; then host=x86_64-apple-darwin @@ -1076,6 +1077,7 @@ linux-android*) enable_odk=no enable_postgresql_sdbc=no enable_python=no + enable_xmlhelp=no test_cups=no test_dbus=no test_fontconfig=no @@ -1111,6 +1113,7 @@ emscripten) build_gstreamer_1_0=no enable_lpsolve=no enable_report_builder=no + enable_xmlhelp=no with_theme="breeze" test_cmis=no test_cups=no @@ -1899,6 +1902,11 @@ AC_ARG_ENABLE(wasm-strip, ,enable_wasm_strip=yes) +AC_ARG_ENABLE(xmlhelp, + AS_HELP_STRING([--disable-xmlhelp], + [Disable XML help support]), +,enable_xmlhelp=yes) + dnl =================================================================== dnl Optional Packages (--with/without-) dnl =================================================================== @@ -5235,6 +5243,92 @@ fi AC_SUBST(PKGFORMAT) dnl =================================================================== +dnl handle help related options +dnl =================================================================== + +ENABLE_HTMLHELP= +HELP_OMINDEX_PAGE= +HELP_ONLINE= +WITH_HELPPACKS= + +AC_MSG_CHECKING([which help to build]) +if test -n "$with_help" -a "$with_help" != "no"; then + GIT_NEEDED_SUBMODULES="helpcontent2 $GIT_NEEDED_SUBMODULES" + BUILD_TYPE="$BUILD_TYPE HELP" + case "$with_help" in + "html") + ENABLE_HTMLHELP=TRUE + WITH_HELPPACKS=TRUE + SCPDEFS="$SCPDEFS -DWITH_HELPPACKS" + AC_MSG_RESULT([HTML (local)]) + ;; + "online") + ENABLE_HTMLHELP=TRUE + HELP_ONLINE=TRUE + AC_MSG_RESULT([HTML (online)]) + ;; + yes) + WITH_HELPPACKS=TRUE + SCPDEFS="$SCPDEFS -DWITH_HELPPACKS" + BUILD_TYPE="$BUILD_TYPE HELPTOOLS" + AC_MSG_RESULT([XML (local)]) + ;; + *) + AC_MSG_ERROR([Unknown --with-help=$with_help]) + ;; + esac +else + AC_MSG_RESULT([no]) +fi + +AC_MSG_CHECKING([whether to enable xapian-omega support for online help]) +if test -n "$with_omindex" -a "$with_omindex" != "no"; then + if test "$HELP_ONLINE" != TRUE; then + AC_MSG_ERROR([Can't build xapian-omega index without --help=online]) + fi + case "$with_omindex" in + "server") + HELP_OMINDEX_PAGE=TRUE + AC_MSG_RESULT([SERVER]) + ;; + "noxap") + AC_MSG_RESULT([NOXAP]) + ;; + *) + AC_MSG_ERROR([Unknown --with-omindex=$with_omindex]) + ;; + esac +else + AC_MSG_RESULT([no]) +fi + +AC_MSG_CHECKING([whether to include the XML-help support]) +if test "$enable_xmlhelp" = yes; then + BUILD_TYPE="$BUILD_TYPE XMLHELP" + AC_DEFINE(HAVE_FEATURE_XMLHELP) + AC_MSG_RESULT([yes]) +else + if test "$with_help" = yes; then + add_warning "Building the XML help, but LO with disabled xmlhelp support. Generated help can't be accesssed from this LO build!" + fi + AC_MSG_RESULT([no]) +fi + +dnl Test whether to integrate helppacks into the product's installer +AC_MSG_CHECKING([for helppack integration]) +if test -z "$WITH_HELPPACKS" -o "$with_helppack_integration" = no; then + AC_MSG_RESULT([no integration]) +else + SCPDEFS="$SCPDEFS -DWITH_HELPPACK_INTEGRATION" + AC_MSG_RESULT([integration]) +fi + +AC_SUBST([ENABLE_HTMLHELP]) +AC_SUBST([HELP_OMINDEX_PAGE]) +AC_SUBST([HELP_ONLINE]) +# WITH_HELPPACKS is used only in configure + +dnl =================================================================== dnl Set up a different compiler to produce tools to run on the build dnl machine when doing cross-compilation dnl =================================================================== @@ -5666,65 +5760,6 @@ else fi AC_SUBST(DO_FETCH_TARBALLS) -AC_MSG_CHECKING([whether to build help]) -if test -n "$with_help" -a "$with_help" != "no" -a $_os != iOS -a $_os != Android; then - BUILD_TYPE="$BUILD_TYPE HELP" - GIT_NEEDED_SUBMODULES="helpcontent2 $GIT_NEEDED_SUBMODULES" - case "$with_help" in - "html") - ENABLE_HTMLHELP=TRUE - SCPDEFS="$SCPDEFS -DWITH_HELP" - AC_MSG_RESULT([HTML]) - ;; - "online") - ENABLE_HTMLHELP=TRUE - HELP_ONLINE=TRUE - AC_MSG_RESULT([HTML]) - ;; - yes) - SCPDEFS="$SCPDEFS -DWITH_HELP" - AC_MSG_RESULT([yes]) - ;; - *) - AC_MSG_ERROR([Unknown --with-help=$with_help]) - ;; - esac -else - AC_MSG_RESULT([no]) -fi -AC_SUBST([ENABLE_HTMLHELP]) -AC_SUBST([HELP_ONLINE]) - -AC_MSG_CHECKING([whether to enable xapian-omega support for help]) -if test -n "$with_omindex" -a "$with_omindex" != "no" -a $_os != iOS -a $_os != Android; then - BUILD_TYPE="$BUILD_TYPE HELP" - GIT_NEEDED_SUBMODULES="helpcontent2 $GIT_NEEDED_SUBMODULES" - case "$with_omindex" in - "server") - ENABLE_HTMLHELP=TRUE - HELP_ONLINE=TRUE - HELP_OMINDEX_PAGE=TRUE - AC_MSG_RESULT([SERVER]) - ;; - "noxap") - ENABLE_HTMLHELP=TRUE - HELP_ONLINE=TRUE - HELP_OMINDEX_PAGE=FALSE - AC_MSG_RESULT([NOXAP]) - ;; - *) - AC_MSG_ERROR([Unknown --with-omindex=$with_omindex]) - ;; - esac -else - HELP_OMINDEX_PAGE=FALSE - AC_MSG_RESULT([no]) -fi -AC_SUBST([ENABLE_HTMLHELP]) -AC_SUBST([HELP_OMINDEX_PAGE]) -AC_SUBST([HELP_ONLINE]) - - dnl Test whether to include MySpell dictionaries dnl =================================================================== AC_MSG_CHECKING([whether to include MySpell dictionaries]) @@ -12836,17 +12871,6 @@ for theme in $with_theme; do esac done -dnl =================================================================== -dnl Test whether to integrate helppacks into the product's installer -dnl =================================================================== -AC_MSG_CHECKING([for helppack integration]) -if test "$with_helppack_integration" = "no"; then - AC_MSG_RESULT([no integration]) -else - SCPDEFS="$SCPDEFS -DWITH_HELPPACK_INTEGRATION" - AC_MSG_RESULT([integration]) -fi - ############################################################################### # Extensions checking ############################################################################### diff --git a/desktop/Library_deployment.mk b/desktop/Library_deployment.mk index fcf29882879c..57fe1c55a0b6 100644 --- a/desktop/Library_deployment.mk +++ b/desktop/Library_deployment.mk @@ -70,7 +70,7 @@ $(eval $(call gb_Library_add_exception_objects,deployment,\ desktop/source/deployment/registry/sfwk/dp_sfwk \ )) -ifneq (,$(filter DESKTOP,$(BUILD_TYPE))) +ifneq (,$(filter XMLHELP,$(BUILD_TYPE))) $(eval $(call gb_Library_use_libraries,deployment,\ helplinker \ diff --git a/desktop/source/deployment/registry/help/dp_help.cxx b/desktop/source/deployment/registry/help/dp_help.cxx index b1367a335fa2..542efff7269d 100644 --- a/desktop/source/deployment/registry/help/dp_help.cxx +++ b/desktop/source/deployment/registry/help/dp_help.cxx @@ -18,7 +18,7 @@ */ #include <memory> -#include <config_feature_desktop.h> +#include <config_features.h> #include <strings.hrc> #include <dp_backend.h> @@ -31,7 +31,7 @@ #include <unotools/pathoptions.hxx> #include <cppuhelper/supportsservice.hxx> -#if HAVE_FEATURE_DESKTOP +#if HAVE_FEATURE_XMLHELP #include <helpcompiler/compilehelp.hxx> #include <helpcompiler/HelpIndexer.hxx> #endif @@ -378,7 +378,7 @@ void BackendImpl::implProcessHelp( data.dataUrl = xPackage->getURL(); if (!package->extensionContainsCompiledHelp()) { -#if HAVE_FEATURE_DESKTOP +#if HAVE_FEATURE_XMLHELP const OUString sHelpFolder = createFolder(xCmdEnv); data.dataUrl = sHelpFolder; diff --git a/postprocess/Rdb_services.mk b/postprocess/Rdb_services.mk index 0154db097caf..1faf14a374a0 100644 --- a/postprocess/Rdb_services.mk +++ b/postprocess/Rdb_services.mk @@ -224,6 +224,7 @@ $(eval $(call gb_Rdb_add_components,services,\ wizards/com/sun/star/wizards/report/report \ wizards/com/sun/star/wizards/table/table \ ) \ + $(call gb_Helper_optional,XMLHELP,xmlhelp/util/ucpchelp1) \ )) $(eval $(call gb_Rdb_add_components,services,\ @@ -298,7 +299,6 @@ $(eval $(call gb_Rdb_add_components,services,\ extensions/source/logging/log \ extensions/source/scanner/scn \ extensions/source/update/feed/updatefeed \ - xmlhelp/util/ucpchelp1 \ $(if $(filter-out WNT,$(OS)),\ shell/source/cmdmail/cmdmail \ ) \ diff --git a/scp2/source/base/file_base.scp b/scp2/source/base/file_base.scp index 5c50dd3b7af7..e2a8d364bb57 100644 --- a/scp2/source/base/file_base.scp +++ b/scp2/source/base/file_base.scp @@ -18,7 +18,7 @@ #include "macros.inc" -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Sdatabase_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/scp2/source/calc/file_calc.scp b/scp2/source/calc/file_calc.scp index 75cbbbc119b9..84ffb5bfe32a 100644 --- a/scp2/source/calc/file_calc.scp +++ b/scp2/source/calc/file_calc.scp @@ -25,7 +25,7 @@ File gid_File_Share_Registry_Calc_Xcd Name = "calc.xcd"; End -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Scalc_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/scp2/source/draw/file_draw.scp b/scp2/source/draw/file_draw.scp index 49d6d5dd40dc..93ca07b07af5 100644 --- a/scp2/source/draw/file_draw.scp +++ b/scp2/source/draw/file_draw.scp @@ -25,7 +25,7 @@ File gid_File_Share_Registry_Draw_Xcd Name = "draw.xcd"; End -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Sdraw_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/scp2/source/impress/file_impress.scp b/scp2/source/impress/file_impress.scp index f689c62f7b5f..bed62eede8ad 100644 --- a/scp2/source/impress/file_impress.scp +++ b/scp2/source/impress/file_impress.scp @@ -25,7 +25,7 @@ File gid_File_Share_Registry_Impress_Xcd Name = "impress.xcd"; End -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Simpress_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/scp2/source/math/file_math.scp b/scp2/source/math/file_math.scp index 12877b8f1eda..790873958261 100644 --- a/scp2/source/math/file_math.scp +++ b/scp2/source/math/file_math.scp @@ -25,7 +25,7 @@ File gid_File_Share_Registry_Math_Xcd Name = "math.xcd"; End -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Smath_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/scp2/source/ooo/file_ooo.scp b/scp2/source/ooo/file_ooo.scp index 9bdeab03e702..9a49f163adaa 100644 --- a/scp2/source/ooo/file_ooo.scp +++ b/scp2/source/ooo/file_ooo.scp @@ -27,7 +27,7 @@ #include "macros.inc" -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Common_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/scp2/source/writer/file_writer.scp b/scp2/source/writer/file_writer.scp index 28966fc7b696..d29e1594a48c 100644 --- a/scp2/source/writer/file_writer.scp +++ b/scp2/source/writer/file_writer.scp @@ -18,7 +18,7 @@ #include "macros.inc" -#if defined WITH_HELP +#if defined WITH_HELPPACKS File gid_File_Help_Swriter_Zip Dir = FILELIST_DIR; FILELIST_TXT_FILE_BODY_HELPPACK; diff --git a/sfx2/source/appl/app.cxx b/sfx2/source/appl/app.cxx index 89bc3fdc50ea..e410902ccdb7 100644 --- a/sfx2/source/appl/app.cxx +++ b/sfx2/source/appl/app.cxx @@ -67,7 +67,7 @@ using namespace ::com::sun::star; static SfxApplication* g_pSfxApplication = nullptr; -#if HAVE_FEATURE_DESKTOP +#if HAVE_FEATURE_XMLHELP static SfxHelp* pSfxHelp = nullptr; #endif @@ -127,7 +127,7 @@ SfxApplication* SfxApplication::GetOrCreate() ::framework::SetStatusBarControllerCreator( SfxStatusBarControllerFactory ); ::framework::SetDockingWindowCreator( SfxDockingWindowFactory ); ::framework::SetIsDockingWindowVisible( IsDockingWindowVisible ); -#if HAVE_FEATURE_DESKTOP +#if HAVE_FEATURE_XMLHELP Application::SetHelp( pSfxHelp ); if (!utl::ConfigManager::IsFuzzing() && SvtHelpOptions().IsHelpTips()) Help::EnableQuickHelp(); @@ -167,7 +167,7 @@ SfxApplication::SfxApplication() (void)bOk; #endif -#if HAVE_FEATURE_DESKTOP +#if HAVE_FEATURE_XMLHELP pSfxHelp = new SfxHelp; #endif @@ -187,7 +187,7 @@ SfxApplication::~SfxApplication() for (auto &module : pImpl->aModules) // Clear modules module.reset(); -#if HAVE_FEATURE_DESKTOP +#if HAVE_FEATURE_XMLHELP delete pSfxHelp; Application::SetHelp(); #endif diff --git a/solenv/gbuild/Helper.mk b/solenv/gbuild/Helper.mk index 2aa0fc8d65b2..c7f2404efabd 100644 --- a/solenv/gbuild/Helper.mk +++ b/solenv/gbuild/Helper.mk @@ -301,8 +301,21 @@ $(1) : $(2) | $(dir $(1)).dir $(call gb_Deliver_add_deliverable,$(1),$(2),$(1)) endef +# call gb_Helper_optional,build_type,if-true,if-false define gb_Helper_optional -$(if $(filter $(1),$(BUILD_TYPE)),$(2)) +$(if $(filter $(1),$(BUILD_TYPE)),$(2),$(3)) +endef + +# call gb_Helper_optionals_or,build_types,if-true,if-false +define gb_Helper_optionals_or +$(call gb_Helper_optional,$(1),$(2),$(3)) +endef + +gb_Helper_optionals_and_token = $(subst $(gb_SPACE),_,gb $(sort $(1))) + +# call gb_Helper_optionals_and,build_types,if-true,if-false +define gb_Helper_optionals_and +$(if $(filter $(call gb_Helper_optionals_and_token,$(1)),$(call gb_Helper_optionals_and_token,$(filter $(1),$(BUILD_TYPE)))),$(2),$(3)) endef ifeq ($(WITH_LOCALES),) diff --git a/solenv/gbuild/extensions/pre_BuildTools.mk b/solenv/gbuild/extensions/pre_BuildTools.mk index 45b61f7cedd6..f8437bf5919f 100644 --- a/solenv/gbuild/extensions/pre_BuildTools.mk +++ b/solenv/gbuild/extensions/pre_BuildTools.mk @@ -33,11 +33,11 @@ gb_BUILD_TOOLS_executables = \ unoidl-check \ unoidl-write \ xrmex \ - $(call gb_Helper_optional_for_host,DESKTOP, \ - HelpIndexer \ - HelpLinker \ - lngconvex \ - ) \ + $(call gb_Helper_optional_for_host,HELPTOOLS, \ + HelpIndexer \ + HelpLinker \ + ) \ + $(if $(filter WNT,$(OS)),$(call gb_Helper_optional_for_host,DESKTOP,lngconvex)) \ gb_BUILD_TOOLS_executables_extern = \ xsltproc \ diff --git a/sw/qa/uitest/writer_tests3/hyperlinkdialog.py b/sw/qa/uitest/writer_tests3/hyperlinkdialog.py index ff1a30931b5a..dc1a4c0f12b8 100644 --- a/sw/qa/uitest/writer_tests3/hyperlinkdialog.py +++ b/sw/qa/uitest/writer_tests3/hyperlinkdialog.py @@ -87,12 +87,12 @@ class HyperlinkDialog(UITestCase): # opened in the user's default browser): if os.getenv('ENABLE_HTMLHELP') == 'TRUE': return - # Skip this test for --with-help, as that would fail with a + # Skip this test for --with-xmlhelp, as that would fail with a # "uno.com.sun.star.uno.RuntimeException: Could not find child with id: cancel" thrown from # the below execute_blocking_action call, as it would open the "LibreOffice Help" window # instead of the apparently expected "LibreOffice Help Not Installed" dialog that has a # "Cancel" button: - if re.compile(r'-DWITH_HELP\b').search(os.getenv('SCPDEFS')): + if re.compile(r'XMLHELP\b').search(os.getenv('BUILD_TYPE')): return self.ui_test.create_doc_in_start_center("writer") diff --git a/xmlhelp/README.md b/xmlhelp/README.md index 60a59fc808ca..d717a58958de 100644 --- a/xmlhelp/README.md +++ b/xmlhelp/README.md @@ -1,3 +1,4 @@ # XML Help -Help reader and viewer for online help. +Help viewer component for the XML / non-HTML help. +HTML help is always opened in a browser. |