Commit 031a1dfe authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

improved docs for gimp-plugin-help-register.

2008-12-16  Sven Neumann  <sven@gimp.org>

	* tools/pdbgen/pdb/plug_in.pdb: improved docs for
	gimp-plugin-help-register.

	* app/pdb/plug-in-cmds.c
	* libgimp/gimpplugin_pdb.c: regenerated.


svn path=/trunk/; revision=27797
parent bd909141
2008-12-16 Sven Neumann <sven@gimp.org>
* tools/pdbgen/pdb/plug_in.pdb: improved docs for
gimp-plugin-help-register.
* app/pdb/plug-in-cmds.c
* libgimp/gimpplugin_pdb.c: regenerated.
2008-12-16 Sven Neumann <sven@gimp.org>
* app/tools/gimpgegltool.c (gimp_gegl_tool_operation_blacklisted):
......
......@@ -445,7 +445,7 @@ register_plug_in_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-plugin-domain-register",
"Registers a textdomain for localisation.",
"This procedure adds a textdomain to the list of domains Gimp searches for strings when translating its menu entries. There is no need to call this function for plug-ins that have their strings included in the gimp-std-plugins domain as that is used by default. If the compiled message catalog is not in the standard location, you may specify an absolute path to another location. This procedure can only be called in the query function of a plug-in and it has to be called before any procedure is installed.",
"This procedure adds a textdomain to the list of domains Gimp searches for strings when translating its menu entries. There is no need to call this function for plug-ins that have their strings included in the 'gimp-std-plugins' domain as that is used by default. If the compiled message catalog is not in the standard location, you may specify an absolute path to another location. This procedure can only be called in the query function of a plug-in and it has to be called before any procedure is installed.",
"Sven Neumann <sven@gimp.org>",
"Sven Neumann",
"2000",
......@@ -476,7 +476,7 @@ register_plug_in_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-plugin-help-register",
"Register a help path for a plug-in.",
"This procedure changes the help rootdir for the plug-in which calls it. All subsequent calls of 'gimp-help' from this plug-in will be interpreted relative to this rootdir.",
"This procedure registers user documentation for the calling plug-in with the GIMP help system. The domain_uri parameter points to the root directory where the plug-in help is installed. For each supported language there should be a file called 'gimp-help.xml' that maps the help IDs to the actual help files.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2000",
......
......@@ -35,11 +35,11 @@
* This procedure adds a textdomain to the list of domains Gimp
* searches for strings when translating its menu entries. There is no
* need to call this function for plug-ins that have their strings
* included in the gimp-std-plugins domain as that is used by default.
* If the compiled message catalog is not in the standard location, you
* may specify an absolute path to another location. This procedure can
* only be called in the query function of a plug-in and it has to be
* called before any procedure is installed.
* included in the 'gimp-std-plugins' domain as that is used by
* default. If the compiled message catalog is not in the standard
* location, you may specify an absolute path to another location. This
* procedure can only be called in the query function of a plug-in and
* it has to be called before any procedure is installed.
*
* Returns: TRUE on success.
*/
......@@ -71,9 +71,11 @@ gimp_plugin_domain_register (const gchar *domain_name,
*
* Register a help path for a plug-in.
*
* This procedure changes the help rootdir for the plug-in which calls
* it. All subsequent calls of gimp_help() from this plug-in will be
* interpreted relative to this rootdir.
* This procedure registers user documentation for the calling plug-in
* with the GIMP help system. The domain_uri parameter points to the
* root directory where the plug-in help is installed. For each
* supported language there should be a file called 'gimp-help.xml'
* that maps the help IDs to the actual help files.
*
* Returns: TRUE on success.
*/
......
......@@ -79,7 +79,7 @@ sub plugin_domain_register {
This procedure adds a textdomain to the list of domains Gimp searches
for strings when translating its menu entries. There is no need to
call this function for plug-ins that have their strings included in
the gimp-std-plugins domain as that is used by default. If the compiled
the 'gimp-std-plugins' domain as that is used by default. If the compiled
message catalog is not in the standard location, you may specify an
absolute path to another location. This procedure can only be called
in the query function of a plug-in and it has to be called before any
......@@ -119,9 +119,12 @@ sub plugin_help_register {
$blurb = "Register a help path for a plug-in.";
$help = <<HELP;
This procedure changes the help rootdir for the plug-in which calls it. All
subsequent calls of gimp_help() from this plug-in will be interpreted relative
to this rootdir.
This procedure registers user documentation for the calling plug-in
with the GIMP help system. The domain_uri parameter points to the root
directory where the plug-in help is installed. For each supported
language there should be a file called 'gimp-help.xml' that maps the
help IDs to the actual help files.
HELP
&mitch_pdb_misc('2000');
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment