dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated. 

2003-11-19  Michael Natterer  <mitch@gimp.org>

	* libgimpwidgets/tmpl/gimphelpui.sgml: updated.
This commit is contained in:
Michael Natterer 2003-11-19 01:17:06 +00:00 committed by Michael Natterer
parent 18afa1514f
commit fca3f8b3db
2 changed files with 11 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
devel-docs/ChangeLog
View File

@ -1,3 +1,7 @@
2003-11-19 Michael Natterer <mitch@gimp.org>
* libgimpwidgets/tmpl/gimphelpui.sgml: updated.
2003-11-19 Sven Neumann <sven@gimp.org>
* libgimpwidgets/tmpl/gimpquerybox.sgml: updated.

29
devel-docs/libgimpwidgets/tmpl/gimphelpui.sgml
View File

@ -23,27 +23,24 @@ gimp_query_int_box() etc.
</para>
<para>
Note that all help paths are relative to the root of the help system
in the current language. So if your language is "C", a help path of
"filters/foo_bar.html" will expand to
"${gimp_data_dir}/help/C/filters/foo_bar.html".
Help IDs are textual identifiers the help system uses to figure which
page to display.
</para>
<para>
All these functions finally call gimp_help_connect_help_accel() which
does the work of installing the "F1" accelerator.
All these dialog constructors functions call gimp_help_connect().
</para>
<para>
In most cases it will be ok to use gimp_plugin_help_func() which does
nothing but passing the @help_data string to gimp_help(). If your
In most cases it will be ok to use gimp_standard_help_func() which does
nothing but passing the @help_id string to gimp_help(). If your
plug-in needs some more sophisticated help handling you can provide
your own @help_func which has to call gimp_help() to actually display
the help.
</para>
@help_id:
@data:
@help_data:
<!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
@ -62,23 +59,11 @@ the help.
<!-- ##### FUNCTION gimp_standard_help_func ##### -->
<para>
This is the standard GIMP help function which does nothing but calling
gimp_help(). Please use gimp_plugin_help_func() for your plug-in's
help links.
</para>
<para>
Currently, gimp_standard_help_func() and gimp_plugin_help_func() do
exactly the same. The latter one was introduced to ensure future
flexibility.
</para>
<para>
See #GimpHelpFunc for the naming conventions of HTML help files.
</para>
@help_id:
@help_data: A unique help identifier.
@help_data:
<!-- ##### FUNCTION gimp_help_connect ##### -->