# GIMP - The GNU Image Manipulation Program
# Copyright (C) 1995 Spencer Kimball and Peter Mattis

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

# "Perlized" from C source by Sven Neumann <sven@gimp.org>

sub help {
    $blurb = "Load a help page.";

    $help = <<HELP;
This procedure loads the specified help page into the helpbrowser or
what ever is configured as help viewer. The help page is identified by
its domain and ID: if help_domain is NULL, we use the help_domain
which was registered using the gimp_plugin_help_register() procedure. If
help_domain is NULL and no help domain was registered, the help domain
of the main GIMP installation is used.
HELP

    &mitch_pdb_misc('2000');

    @inargs = (
	{ name => 'help_domain', type => 'string', null_ok => 1,
	  desc => "The help domain in which help_id is registered" },
	{ name => 'help_id', type => 'string',
	  desc => "The help page's ID" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPlugInManager *manager = gimp->plug_in_manager;

  if (! help_domain && manager->current_plug_in)
    help_domain = (gchar *)
      gimp_plug_in_manager_get_help_domain (manager,
                                            manager->current_plug_in->file,
                                            NULL);

  gimp_help (gimp, progress, help_domain, help_id);
}
CODE
    );
}


@headers = qw("core/gimp.h"
              "plug-in/gimpplugin.h"
              "plug-in/gimppluginmanager.h"
              "plug-in/gimppluginmanager-help-domain.h");

@procs = qw(help);

%exports = (app => [@procs], lib => [@procs]);

$desc = 'Help procedures';
$doc_title = 'gimphelp';
$doc_short_desc = 'Loading help pages using gimp_help.';
$doc_long_desc = 'Loading help pages using gimp_help.';

1;