/jEdit/tags/jedit-4-2-pre4/doc/users-guide/using-plugins.xml

 1<!-- jEdit buffer-local properties: -->
 2<!-- :tabSize=1:indentSize=1:noTabs=true:wrap=soft:maxLineLen=80: -->
 3<!-- :xml.root=users-guide.xml: -->
 4
 5<chapter id="using-plugins"><title>Installing and Using Plugins</title>
 6 <para>
 7  A <firstterm>plugin</firstterm> is an application which is loaded and runs
 8  as part of another, host application. Plugins respond to user commands
 9  and perform tasks that supplement the host application's features.
10 </para>
11 <para>
12  This chapter covers installing, updating and removing plugins. Documentation
13  for the plugins themselves can be found in
14  <guimenu>Help</guimenu>&gt;<guimenuitem>jEdit Help</guimenuitem>, and
15  information about writing plugins can be found in <xref
16  linkend="writing-plugins-part" />.
17 </para>
18 <sect1 id="plugin-manager"><title>The Plugin Manager</title>
19  <para>
20   <guimenu>Plugins</guimenu>&gt;<guimenuitem>Plugin Manager</guimenuitem>
21   displays the plugin manager window. The plugin manager lists all installed
22   plugins; clicking on a plugin in the list will display information about it.
23  </para>
24  <para>
25   To remove plugins, select them (multiple plugins can be selected by
26   holding down <keycap>Control</keycap>) and click <guibutton>Remove</guibutton>.
27   This will display a confirmation dialog box first.
28  </para>
29  <para>
30   To view plugin documentation, select a plugin and click <guibutton>Help</guibutton>. Note that plugin documentation can also be accessed by invoking <guimenu>Help</guimenu>&gt;<guimenuitem>jEdit Help</guimenuitem>.
31  </para>
32  <para>
33   <guimenu>Plugins</guimenu>&gt;<guimenuitem>Plugin Options</guimenuitem> displays a dialog box for changing plugin settings.
34  </para>
35 </sect1>
36 <sect1 id="installing-plugins"><title>Installing and Updating Plugins</title>
37  <para>
38   Plugins can be installed in two ways; manually, and from the plugin manager.
39   In most cases, plugins should be installed from the plugin manager. It is
40   easier and more convenient.
41  </para>
42  <para>
43   To install plugins manually, go to <ulink
44   url="http://plugins.jedit.org">http://plugins.jedit.org</ulink> in a web
45   browser and follow the directions on that page.
46  </para>
47  <para>
48   To install plugins from the plugin manager, make sure you are connected to
49   the Internet and click the <guibutton>Install</guibutton> tab in
50   the plugin manager window. The plugin manager will then download information
51   about available plugins from the jEdit web site, and present a list of
52   plugins compatible with your jEdit release.
53  </para>
54  <para>
55   Click on a plugin in the list to see some information about it. To select
56   plugins for installation, click the check box next to their names in the list.
57  </para>
58  <para>
59   The <guibutton>Total size</guibutton> field shows the total size
60   of all plugins chosen for installation, along with any plugins that will be
61   automatically downloaded in order to fulfill dependencies.
62  </para>
63  <para>
64   Once you have specified plugins to install, click <guibutton>Install</guibutton> to begin the download process.
65  </para>
66  <para>
67   By default, the plugin manager does not download plugin source code, and installs the downloaded plugins in the <filename>jars</filename>
68   subdirectory of the user-specific settings directory. These settings can be changed in <guilabel>Plugin Manager</guilabel> pane of the
69   <guimenu>Utilities</guimenu>&gt;<guimenuitem>Global Options</guimenuitem>
70   dialog box; see <xref linkend="pluginmgr-pane" />.
71  </para>
72  <para>
73   The <guibutton>Update</guibutton> tab of the plugin manager 
74   is very similar to the <guibutton>Install</guibutton> tab. It
75   lists plugins for which updated versions are available. It will also offer to
76   delete any obsolete plugins.
77  </para>
78  <sidebar><title>Proxy Servers and Firewalls</title>
79   <para>
80    If you are connected to the Internet through an HTTP proxy or SOCKS firewall,
81    you will need to specify the relevant details in the
82    <guibutton>Proxy Servers</guibutton> pane of the
83    <guimenu>Utilities</guimenu>&gt;<guimenuitem>Global Options</guimenuitem>
84    dialog box; see <xref linkend="firewall-pane"/>.
85   </para>
86  </sidebar>
87 </sect1>
88</chapter>