Gimp.Procedure.set_help_uri

### Method

# Gimp Procedureset_help_uri

unstable since: 3.4

#### Declaration [src]

    void
    gimp_procedure_set_help_uri (
      GimpProcedure* procedure,
      const gchar* uri_reference
    )

#### Description [src]

Sets a URI Reference (in the meaning of RFC 3986, section 4.1) where documentation for this procedure will be available.

This function only accepts two types of URI references: full URI, but only with the scheme `https`, or a relative-path reference such as “docs/index.html” or “docs/manual.pdf”. Note how this doesn’t have a scheme part and allows to ship documentation with a plug-in. These relative paths are made relatively to the plug-in or extension’s root folder.

GIMP will open `uri_reference` using the default application registered for the file type. We recommend choosing the file type of your documentation conservatively, with types with default readers on every platform, such as `html` or `pdf` documentation.

This method is both complementary and redundant to `gimp_procedure_set_documentation()`, and in particular replace its `help_id` argument. In common cases, set the `blurb` (and optionally the `help`) arguments on `gimp_procedure_set_documentation()` yet keep `help_id` to `NULL`. Then set your documentation with this method instead:

    gimp_procedure_set_documentation (procedure,
                                      _("What this plug-in does"),
                                      NULL, NULL);
    gimp_procedure_set_help_uri (procedure,
                                 "https://example.org/my-plug-in-docs");

Note: these functions might get merged in the v4 API.

Available since: 3.4

#### Parameters

`uri_reference`

  Type: `const gchar*`

  The `procedure`‘s help URI Reference.

  The data is owned by the caller of the method.
  The value is a NUL terminated UTF-8 string.