office-gobmx/desktop/Extension_test-passive.mk
Stephan Bergmann 4a0ca73c31 Add some help content to test-passive.oxt
...mainly to test how well/poorly extension help is supported by
--with-help=html, but also as a kind of reference implementation.  (There are
also extensions in odk/examples/ that contain help content, namely
odk/examples/DevelopersGuide/Extensions/DialogWithHelp/ containing context-
sensitive help for a dialog, a topic that is not covered here.)

See <https://wiki.openoffice.org/wiki/Documentation/DevGuide/Extensions/
Help_Content#Integration_into_the_OpenOffice.org_help_system> for the ways an
extension's help content can be integrated into the "classic" (plain
--with-help) help system (citing sub-section headings used in that document):

* Help Viewer Contents page:

  The contained help.tree provides a "The test-passive Extension" section with
  a "The test-passive Extension" page (main.xhp).

* Help Viewer Index page:

  The contained main.xhp provides index entries for "test-passive extension" and
  "extensions"-"test-passive", and---only on the index pages of Calc and Writer
  ---for "test-passive extension in Calc and Writer".

* Help Viewer Find page:

  The contained main.xhp is indexer="include", so it should be found by e.g.
  searching for "bla bla".

* Context sensitive help and extended tool tips:

  The contained Addons.xcu has been extended with a small (floating by default)
  toolbar containing a "native" button (doing the same as the "passive - native"
  menu entry), and the contained main.xhp provides an extended tooltip of "Show
  the test-passive extension's native dialog" for that toolbar button (displayed
  when using "Help - What's This?" and hovering over the button).

  For context-sensitive help for dialogs, see the mention of
  odk/examples/DevelopersGuide/Extensions/DialogWithHelp/ above.

The contained help is only provided in "en" localization, which should thus be
used as fallback regardless for which locale LO is run.

The help-related XML files need to provide identifiers in lots of places, many
of which appear to be unused for the given example uses.  I specified those as
empty strings.

The workdir/Extension/test-passive.oxt extension can be built with `make
Extension_test-passive`.

Change-Id: I0e75f35df85683c9fae1d1384fa6afeaeb8a687d
Reviewed-on: https://gerrit.libreoffice.org/55736
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2018-06-13 13:32:05 +02:00

35 lines
1.3 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_Extension_Extension,test-passive,desktop/test/deployment/passive,nodeliver))
$(eval $(call gb_Extension_add_file,test-passive,generic.components,$(call gb_Rdb_get_target,passive_generic)))
$(eval $(call gb_Extension_add_file,test-passive,platform.components,$(call gb_Rdb_get_target,passive_platform)))
$(eval $(call gb_Extension_add_files,test-passive,, \
$(SRCDIR)/desktop/test/deployment/passive/Addons.xcu \
$(SRCDIR)/desktop/test/deployment/passive/ProtocolHandler.xcu \
$(SRCDIR)/desktop/test/deployment/passive/passive_python.py \
$(call gb_Jar_get_target,passive_java) \
))
$(eval $(call gb_Extension_add_files,test-passive,help/en, \
$(SRCDIR)/desktop/test/deployment/passive/help/en/help.tree \
))
$(eval $(call gb_Extension_add_files,test-passive,help/en/org.openoffice%2Fframework%2Fdesktop%2Ftest%2Fdeployment%2Fpassive, \
$(SRCDIR)/desktop/test/deployment/passive/help/en/main.xhp \
))
$(eval $(call gb_Extension_add_libraries,test-passive, \
passive_native \
))
# vim: set noet sw=4 ts=4: