/usr/share/doc/kildclient/html/apes04.xhtml is in kildclient-doc 3.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>E.4. Enabling and Disabling Plugins</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="apes03.xhtml" title="E.3. Disposing Data When the Plugin Is Unloaded"/><link rel="next" href="apes05.xhtml" title="E.5. Conditional Loading of Plugins"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">E.4. Enabling and Disabling Plugins</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="apes03.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Appendix E. Writing Plugins</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="apes05.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm5337"><div class="titlepage"><div><div><h2 class="title" style="clear: both">E.4. Enabling and Disabling Plugins</h2></div></div></div><p>As described in <a class="xref" href="chap_plugins.xhtml" title="Chapter 13. Plugins">Chapter 13, <em>Plugins</em></a>, the user can
enable or disable plugins. By default, disabling a plugin means
disabling all its triggers, macros, aliases, hooks and timers, and
enabling a plugin means enabling all the above items.</p><p>Most of the times that is enough, but for some plugins this
naive approach may not be appropriate. One such case is when a plugin
has some triggers (or any other kind of item) that is not necessarily
always enabled, and whose status is set by some other means.</p><p>In these cases, you can define two functions named
<code class="literal">ENABLE</code> and <code class="literal">DISABLE</code>. These will
be called when the plugin is being enabled and disabled, respectively,
and you can do whatever is necessary in there.</p><p>If these functions are defined, then the standard behaviour
(enabling or disabling all items) is <span class="emphasis"><em>not</em></span> done,
and you must do whatever is necessary by yourself. Also, no message is
printed, so you might want to print some informative message.</p><p>The functions should return a true value to indicate success. If
for some reason the operation could not be done and the status should
not be changed, return a false value and the status of the plugin will
not be altered. But use this feature with care.</p><p>If the functions are not defined, then the default behavior
described above is used. So if your plugin doesn't have special needs,
you do not need to define these functions.</p></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="apes03.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="ape.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="apes05.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">E.3. Disposing Data When the Plugin Is Unloaded </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> E.5. Conditional Loading of Plugins</td></tr></table></div></footer></body></html>
|