Windows: Switch from HTML Help to plain HTML.

Switch from HTML Help to plain HTML files. In the NSIS and WiX installers,
place the help assets in a directory with a friendly name.

7 files changed, 25 insertions, 16 deletions

diff --git a/packaging/nsis/CMakeLists.txt b/packaging/nsis/CMakeLists.txt
index 3f403f2df4..8e295f4366 100644
--- a/packaging/nsis/CMakeLists.txt
+++ b/packaging/nsis/CMakeLists.txt
@@ -229,7 +229,7 @@ macro( ADD_NSIS_PACKAGE_TARGET )
 			DEPENDS
 				${NSIS_FILES}
 				copy_data_files
-				user_guide_chm
+				user_guide_html
 				faq_html
 				${DATAFILE_DIR}/uninstall.exe
 		)
diff --git a/packaging/nsis/uninstall.nsi b/packaging/nsis/uninstall.nsi
index 3d115aa53f..9d4f6cc36e 100644
--- a/packaging/nsis/uninstall.nsi
+++ b/packaging/nsis/uninstall.nsi
@@ -232,6 +232,7 @@ Delete "$INSTDIR\wka"
 Delete "$INSTDIR\services"
 Delete "$INSTDIR\pdml2html.xsl"
 Delete "$INSTDIR\pcrepattern.3.txt"
+Delete "$INSTDIR\Wireshark User's Guide\*.*"
 Delete "$INSTDIR\user-guide.chm"
 Delete "$INSTDIR\example_snmp_users_file"
 Delete "$INSTDIR\ipmap.html"
@@ -291,6 +292,7 @@ RMDir "$INSTDIR\styles\translations"
 RMDir "$INSTDIR\styles"
 RMDir "$SMPROGRAMS\${PROGRAM_NAME}"
 RMDir "$INSTDIR\help"
+RMDir "$INSTDIR\Wireshark User's Guide"
 RMDir "$INSTDIR\diameter"
 RMDir "$INSTDIR\snmp\mibs"
 RMDir "$INSTDIR\snmp"
diff --git a/packaging/nsis/wireshark.nsi b/packaging/nsis/wireshark.nsi
index 4835b02e0d..e629a610d3 100644
--- a/packaging/nsis/wireshark.nsi
+++ b/packaging/nsis/wireshark.nsi
@@ -1200,8 +1200,10 @@ SectionGroupEnd ; "Tools"
 !ifdef DOCBOOK_DIR
 Section "Documentation" SecDocumentation
 ;-------------------------------------------
+SetOutPath "$INSTDIR\Wireshark User's Guide"
+File /r "${DOCBOOK_DIR}\wsug_html_chunked\*.*"
+
 SetOutPath $INSTDIR
-File "${DOCBOOK_DIR}\user-guide.chm"
 File "${DOCBOOK_DIR}\faq.html"
 SectionEnd
 !endif
diff --git a/packaging/wix/CMakeLists.txt b/packaging/wix/CMakeLists.txt
index 78ac3fea32..5988b279af 100644
--- a/packaging/wix/CMakeLists.txt
+++ b/packaging/wix/CMakeLists.txt
@@ -16,6 +16,7 @@ set(WIX_GENERATED_FILES
 	${CMAKE_CURRENT_BINARY_DIR}/QtTranslation.wxs
 	${CMAKE_CURRENT_BINARY_DIR}/RadiusDict.wxs
 	${CMAKE_CURRENT_BINARY_DIR}/SNMPMibs.wxs
+	${CMAKE_CURRENT_BINARY_DIR}/UsersGuide.wxs
 )
 set(WIX_GENERATED_FILES ${WIX_GENERATED_FILES} PARENT_SCOPE)
 
@@ -47,6 +48,7 @@ set(WIX_OUT_FILES
 	${CMAKE_CURRENT_BINARY_DIR}/QtTranslation.wixobj
 	${CMAKE_CURRENT_BINARY_DIR}/RadiusDict.wixobj
 	${CMAKE_CURRENT_BINARY_DIR}/SNMPMibs.wixobj
+	${CMAKE_CURRENT_BINARY_DIR}/UsersGuide.wixobj
 	${CMAKE_CURRENT_BINARY_DIR}/Wireshark.wixobj
 	${CMAKE_CURRENT_BINARY_DIR}/WiresharkOptionsDlg.wixobj
 	${CMAKE_CURRENT_BINARY_DIR}/WiresharkWixUI.wixobj
@@ -217,6 +219,7 @@ set(WIX_CANDLE_DEFINES
 	-dQtTranslationDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_BUILD_TYPE}/translations
 	-dRadiusDictDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_BUILD_TYPE}/radius
 	-dSnmpMibDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_BUILD_TYPE}/snmp/mibs
+	-dUsersGuideDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_BUILD_TYPE}/docbook/wsug_html_chunked
 	-dVCRedistVersion=${MSVC_CRT_VERSION}
 	-dVCRedistDir=${MERGE_MODULE_DIR}
 	${d_smi_dir}
@@ -269,6 +272,14 @@ macro( ADD_WIX_PACKAGE_TARGET )
 			DEPENDS "${_wix_source_dir}/windeployqt-to-wix.ps1"
 		)
 
+		# UsersGuide.wxs. Collects the contents of wsug_html_chunked.
+		# Generated with heat.exe
+		add_custom_command(OUTPUT ${_wix_binary_dir}/UsersGuide.wxs
+			COMMAND ${WIX_HEAT_EXECUTABLE} dir ${CMAKE_BINARY_DIR}/docbook/wsug_html_chunked
+					${WIX_HEAT_FLAGS} -cg CG.Documentation -dr dirUsersGuide -var var.UsersGuideDir
+					-out ${_wix_binary_dir}/UsersGuide.wxs
+		)
+
 		# SNMPMibs.wxs. Collects all MIBs in "output" snmp/mibs
 		# directory. Generated with heat.exe
 		add_custom_command(OUTPUT ${_wix_binary_dir}/SNMPMibs.wxs
@@ -308,7 +319,7 @@ macro( ADD_WIX_PACKAGE_TARGET )
 			DEPENDS
 				${WIX_FILES}
 				copy_data_files
-				user_guide_chm
+				user_guide_html
 				faq_html
 		)
 		set_target_properties(wix_package_prep PROPERTIES
@@ -340,6 +351,7 @@ endmacro( ADD_WIX_PACKAGE_TARGET )
 set(CLEAN_FILES
 	DependentComponents.wxs
 	QtDependentComponents.wxs
+	UsersGuide.wxs
 	SNMPMibs.wxs
 	RadiusDict.wxs
 	Diameter.wxs
diff --git a/packaging/wix/ComponentGroups.wxi b/packaging/wix/ComponentGroups.wxi
index 0dd35eff3e..8516e65209 100644
--- a/packaging/wix/ComponentGroups.wxi
+++ b/packaging/wix/ComponentGroups.wxi
@@ -566,14 +566,7 @@
   </Fragment>
 
   <?ifdef DOCBOOK_DIR?>
-    <!-- User Guide -->
-    <Fragment>
-      <DirectoryRef Id="INSTALLFOLDER">
-        <Component Id="cmpUserGuide_chm" Guid="*">
-          <File Id="filUserGuide_chm" KeyPath="yes" Source="$(var.DOCBOOK_DIR)\user-guide.chm" />
-        </Component>
-      </DirectoryRef>
-    </Fragment>
+    <!-- User Guide is created by heat -->
     <!-- FAQ -->
     <Fragment>
       <DirectoryRef Id="INSTALLFOLDER">
@@ -584,7 +577,6 @@
     </Fragment>
     <Fragment>
       <ComponentGroup Id="CG.Documentation">
-        <ComponentRef Id="cmpUserGuide_chm" />
         <ComponentRef Id="cmpFAQ_html" />
       </ComponentGroup>
     </Fragment>
diff --git a/packaging/wix/DirectoryStructure.wxi b/packaging/wix/DirectoryStructure.wxi
index fe1b9f6d68..f06297edfd 100644
--- a/packaging/wix/DirectoryStructure.wxi
+++ b/packaging/wix/DirectoryStructure.wxi
@@ -23,6 +23,7 @@
               <Directory Id="dirPluginsVersionCodecs" Name="codecs"/>
             </Directory>
           </Directory>
+          <Directory Id="dirUsersGuide" Name="Wireshark User's Guide"/>
           <Directory Id="dirProfiles" Name="profiles"/>
           <Directory Id="dirSnmp" Name="snmp">
             <Directory Id="dirSnmpMibs" Name="mibs"/>
diff --git a/packaging/wix/README.adoc b/packaging/wix/README.adoc
index 1d36e9d6a8..45463a4e48 100644
--- a/packaging/wix/README.adoc
+++ b/packaging/wix/README.adoc
@@ -8,10 +8,10 @@ It might one day replace the NSIS installer, but needs to be a little more compl
 . You need the https://wixtoolset.org/[WiX toolset] to build the .msi installer.
 Version 3.10 or later is recommended.
 
-. SNMP, Radius, Diameter, and Qt translations files are harvested to be included in
-the installer.  Any custom/additional files just need to be written to the appropriate
-build output directory and the installer will pick them up.  NSIS required modifying
-a file (custom_mibs.txt, etc) for inclusion
+. The User's Guide, SNMP, Radius, Diameter, and Qt translations files are harvested to
+be included in the installer.  Any custom/additional files just need to be written to the
+appropriate build output directory and the installer will pick them up.  NSIS required
+modifying a file (custom_mibs.txt, etc) for inclusion
 
 . Plugin DLLs are not automatically harvested. To include your DLL, modify Plugins.wxi.