Files
help/CustomTarget_html.mk
Stephan Bergmann 09f72e6408 tdf#116240: Include --with-help=html in installation sets
...by extending the hackery in helpcontent2/CustomTarget_html.mk (see comment
there).  (Ultimately, the gbuild HelpTarget machinery should probably be adapted
to the needs of this new help format, once the old help format is no longer
supported?)

The Perl packaging code finds source files through the "include" paths specified
in instsetoo_native/util/openoffice.lst.in.  To avoid potential name clashes,
put the new .filelist files into
workdir/CustomTarget/helpcontent2/help3xsl/filelists/html-help/ sub-directories.

read_filelist in solenv/bin/modules/installer/filelists.pm does not strip white
space following the last item in a file list, but (with HAVE_GNUMAKE_FILE_FUNC)
the gb_HelpTarget_get_translation_target .filelist files (which are then
transformed with sed into the .html .filelist files read by the Perl packaging
code) may contain such trailing white space.  So $(strip ...) their content in
solenv/gbuild/HelpTarget.mk.

This is the helpcontent2 part of a change spanning core and helpcontent2.

Change-Id: I730caaaec783d0a0a9c79caf85268a775220dee3
Reviewed-on: https://gerrit.libreoffice.org/53724
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2018-05-02 10:42:28 +02:00

196 lines
8.2 KiB
Makefile

# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
#
# This file is part of the LibreOffice project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
$(eval $(call gb_CustomTarget_CustomTarget,helpcontent2/help3xsl))
# HACK!!
html_TREE_MODULES := sbasic scalc schart shared simpress smath swriter
html_TEXT_MODULES := $(html_TREE_MODULES) sdatabase sdraw
html_BMARK_MODULES := swriter:WRITER scalc:CALC simpress:IMPRESS sdraw:DRAW shared/explorer/database:BASE smath:MATH schart:CHART sbasic:BASIC shared:SHARED
$(eval $(call gb_CustomTarget_register_targets,helpcontent2/help3xsl,\
hid2file.js \
$(foreach lang,$(gb_HELP_LANGS),\
$(lang)/bookmarks.js \
$(lang)/contents.js \
$(lang)/html.text \
$(foreach module,$(html_TREE_MODULES),$(module)/$(lang)/contents.part) \
$(foreach module,$(html_BMARK_MODULES),$(firstword $(subst :, ,$(module)))/$(lang)/bookmarks.part) \
$(foreach module,$(html_TEXT_MODULES),filelists/html-help/$(module)/$(lang).filelist) \
) \
))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/hid2file.js : \
$(SRCDIR)/helpcontent2/help3xsl/get_url.xsl \
$(call gb_ExternalExecutable_get_dependencies,xsltproc)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),XSL,1)
$(call gb_Helper_abbreviate_dirs,\
( \
echo 'var map={' \
&& find $(SRCDIR)/helpcontent2/source/text -type f -name '*.xhp' \
| while read xhp; do \
$(call gb_ExternalExecutable_get_command,xsltproc) $< $$xhp \
| $(gb_AWK) 'NF' \
; done \
&& echo '};' \
) > $@ \
)
define html_gen_contents_html_dep
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/contents.part : $(call gb_HelpTarget__get_treefile,$(1),$(3))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/contents.part : TREE_FILE := $(call gb_HelpTarget__get_treefile,$(1),$(3))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/contents.part : LANG := $(2)
endef
define html_gen_contents_dep
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/contents.js : \
$(foreach module,$(html_TREE_MODULES),\
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(module)/$(1)/contents.part)
$(foreach module,$(html_TREE_MODULES),$(call html_gen_contents_html_dep,$(module)/$(1),$(1),helpcontent2/source/auxiliary/$(module)))
endef
$(eval $(foreach lang,$(gb_HELP_LANGS),$(call html_gen_contents_dep,$(lang))))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/%/contents.js :
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),CAT,2)
$(call gb_Helper_abbreviate_dirs,\
( \
echo "document.getElementById(\"Contents\").innerHTML='\\" \
&& cat $(filter %.part,$^) | $(gb_AWK) 'NF' \
&& echo "';" \
) > $@ \
)
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/%/contents.part : \
$(SRCDIR)/helpcontent2/help3xsl/get_tree.xsl \
$(call gb_ExternalExecutable_get_dependencies,xsltproc)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),XSL,1)
$(call gb_Helper_abbreviate_dirs,\
$(call gb_ExternalExecutable_get_command,xsltproc) \
--stringparam lang $(LANG) \
--stringparam local $(if $(HELP_ONLINE),'no','yes') \
--stringparam productversion $(PRODUCTVERSION) \
-o $@ \
$(SRCDIR)/helpcontent2/help3xsl/get_tree.xsl \
$(TREE_FILE) \
)
define html_gen_html_dep
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/html.text : \
$(foreach module,$(html_TEXT_MODULES),$(call gb_HelpTranslateTarget_get_target,$(module)/$(1)))
endef
$(eval $(foreach lang,$(filter-out en-US,$(gb_HELP_LANGS)),$(call html_gen_html_dep,$(lang))))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/%/html.text : \
$(SRCDIR)/helpcontent2/help3xsl/online_transform.xsl \
$(call gb_ExternalExecutable_get_dependencies,xsltproc)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),XSL,1)
$(call gb_Helper_abbreviate_dirs,\
cd $(if $(filter en-US,$*),$(SRCDIR),$(call gb_HelpTranslatePartTarget_get_workdir,$*))/helpcontent2/source \
&& rm -rf $(dir $@)text \
&& find text -name "*.xhp" \
| while read xhp; do \
mkdir -p $$(dirname $(dir $@)$$xhp) && \
$(call gb_ExternalExecutable_get_command,xsltproc) \
--stringparam Language $* \
--stringparam local $(if $(HELP_ONLINE),'no','yes') \
--stringparam root $(if $(filter WNT,$(OS)),$$(cygpath -m `pwd`),`pwd`)/ \
--stringparam productversion $(PRODUCTVERSION) \
-o $(dir $@)$${xhp%.xhp}.html \
$(SRCDIR)/helpcontent2/help3xsl/online_transform.xsl \
$(if $(filter WNT,$(OS)),$$(cygpath -m `pwd`),`pwd`)/$$xhp \
; done \
&& touch $@ \
)
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/%/bookmarks.js :
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),CAT,2)
$(call gb_Helper_abbreviate_dirs,\
( \
echo 'document.getElementsByClassName( "index" )[0].innerHTML='"'"'\' \
&& cat $(filter %.part,$^) \
&& echo "'" \
) > $@ \
)
define html__gen_bookmarks_lang_dep
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(2)/$(1)/bookmarks.part : \
$(call gb_HelpTranslateTarget_get_target,$(firstword $(subst /, ,$(2)))/$(1))
endef
define html__gen_bookmarks_lang_deps
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/bookmarks.js : \
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(2)/$(1)/bookmarks.part
$(if $(filter-out en-US,$(1)),$(call html__gen_bookmarks_lang_dep,$(1),$(2)))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(2)/$(1)/bookmarks.part : HELP_LANG := $(1)
endef
define html__gen_bookmarks_deps
$(foreach lang,$(gb_HELP_LANGS),$(call html__gen_bookmarks_lang_deps,$(lang),$(1)))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/%/bookmarks.part : APP := $(2)
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/$(1)/%/bookmarks.part : APPDIR := $(1)
endef
define html_gen_bookmarks_deps
$(call html__gen_bookmarks_deps,$(firstword $(1)),$(lastword $(1)))
endef
$(eval $(foreach module,$(html_BMARK_MODULES),$(call html_gen_bookmarks_deps,$(subst :, ,$(module)))))
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/%/bookmarks.part : \
$(SRCDIR)/helpcontent2/help3xsl/get_bookmark.xsl \
$(call gb_ExternalExecutable_get_dependencies,xsltproc)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),XSL,1)
$(call gb_Helper_abbreviate_dirs,\
( \
find $(if $(filter en-US,$(HELP_LANG)),$(SRCDIR),$(call gb_HelpTranslatePartTarget_get_workdir,$(HELP_LANG)))/helpcontent2/source/text/$(APPDIR) -name "*.xhp" \
| while read xhp; do \
$(call gb_ExternalExecutable_get_command,xsltproc) \
--stringparam app $(APP) \
--stringparam Language $(HELP_LANG) \
--stringparam local $(if $(HELP_ONLINE),'no','yes') \
--stringparam productversion $(PRODUCTVERSION) \
$(SRCDIR)/helpcontent2/help3xsl/get_bookmark.xsl \
$$xhp \
; done \
| sort -k3b -t\> -s \
| awk 'NF' \
) > $@ \
)
# The various gid_File_Help_*_Zip in scp2 that use EXTRA_ALL_GOOD_HELP_LOCALIZATIONS_LANG expect
# $(module)/$(lang).filelist files containing lists of files (in instdir) for the corresponding
# module/lang parts of help data. As a hack, generate those from the existing HelpTarget file
# lists, which specify the original .xhp files (in SRCDIR for en-US, translated for all other
# langs). For the shared module, also include the per-lang non .xhp/.html files from AllLangPackage
# helpcontent2_html_lang:
# html__filelist,lang,module
define html__filelist
$(call gb_CustomTarget_get_workdir,helpcontent2/help3xsl)/filelists/html-help/$(2)/$(1).filelist: \
$(call gb_HelpTarget_get_filelist,$(2)/$(1)) \
$(if $(filter $(2),shared),$(call gb_Package_get_target,helpcontent2_html_lang_$(1)))
mkdir -p $$$$(dirname $$@)
sed -e 's|$(if $(filter $(1),en-US),$(SRCDIR),$(call gb_HelpTranslatePartTarget_get_workdir,$(1)))/helpcontent2/source/|$(INSTROOT)/$(LIBO_SHARE_HELP_FOLDER)/$(1)/|g' -e 's|.xhp|.html|g' $(call gb_HelpTarget_get_filelist,$(2)/$(1)) > $$@
$(if $(filter $(2),shared),cat $(call gb_Package_get_target,helpcontent2_html_lang_$(1)) >> $$@,:)
endef
$(eval $(foreach lang,$(gb_HELP_LANGS),$(foreach module,$(html_TEXT_MODULES),$(call html__filelist,$(lang),$(module)))))
# vim: set noet sw=4 ts=4: