Dirk: New plugin API function: PLG_getDocumentationUrl

2009-04-11T17:11:01Z

New plugin API function: PLG_getDocumentationUrl

New page

In some situations, Geeklog will need a link to a plugin's documentation. The following plugin API function provides this information:

<pre>function PLG_getDocumentationUrl($type, $file)</pre>

Where <code>$type</code> is the internal name of the plugin (e.g. <tt>'spamx'</tt>) and <code>$file</code> is a name for the part of the documentation being requested.

On the plugin side, this would be implemented as

<pre>function plugin_getdocumentationurl_foo($file)</pre>

== Documentation Links ==

Currently, <code>$file</code> can be one of the following:
* <tt>'index'</tt> - a link to the index page of the plugin's documentation
* <tt>'config'</tt> - a link to the part of the plugin's documentation where the configuration options are explained (see below for details)

We may want to add support for more values of <code>$file</code> in the future, e.g. <tt>'help'</tt> to link to the plugin's help, etc.

== Conventions ==

* When the plugin does not offer the file type requested, it should return <code>false</code> or an empty string.
* The URLs do not have to be in the same directory or even on the same site.
* The caller should not make any assumptions about the URLs.
* The documentation doesn't have to be provided as static HTML pages - it could just as well be created dynamically, i.e. link to a .php script.

=== Config Links ===

Geeklog will request a file type <tt>'config'</tt> to link to a description of the plugin's configuration options from the Configuration admin panel (the <tt>(?)</tt> links next to the configuration options).

Geeklog will attach an anchor of the form <tt>#desc_''optionname''</tt> to the supplied URL, assuming that such an anchor exists on the page so that the user will be taken directly to the description of the option in question.

[[Category:Plugin Development]]

PLG getDocumentationUrl - Revision history

Dirk: New plugin API function: PLG_getDocumentationUrl