/usr/share/doc/kildclient/html/apes07.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 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>E.7. Plugin Conventions</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="apes06.xhtml" title="E.6. Using GTK+ From Plugins"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">E.7. Plugin Conventions</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="apes06.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Appendix E. Writing Plugins</th><td style="width: 20%; text-align: right; "> </td></tr></table><hr/></div></header><section class="sect1" id="idm5398"><div class="titlepage"><div><div><h2 class="title" style="clear: both">E.7. Plugin Conventions</h2></div></div></div><p>The first convention about plugins has been mentioned already:
all plugins should define a <code class="function">help</code> describing
themselves. This help can be as detailed as necessary.</p><p>Another convention regards the use of triggers, aliases, macros,
timers and hooks. All of them should have names (and they should
always be referenced by names, because the plugin writer cannot know
which number will be assigned to them), and the names should consist
of the name of the plugin, a colon, and then some descriptive name for
the trigger (or alias, etc). This is to avoid name clashes with other
plugins.</p><p>Another aspect regarding triggers, aliases, macros, timers and
hooks is that they should only be created in the top-level scope,
which means they are created when the plugin is loaded. They must not
be created in a function that is called later, because this way they
would not be recognized as belonging to the plugin, and this would
create a mess for the user. So create them outside any
functions.</p></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="apes06.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; "> </td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">E.6. Using GTK+ From Plugins </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; "> </td></tr></table></div></footer></body></html>
|