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

<!-- jEdit buffer-local properties: -->
<!-- :tabSize=1:indentSize=1:noTabs=true:wrap=soft:maxLineLen=80: -->
<!-- :xml.root=users-guide.xml: -->

<chapter id="using-plugins"><title>Installing and Using Plugins</title>
 <para>
  A <firstterm>plugin</firstterm> is an application which is loaded and runs
  as part of another, host application. Plugins respond to user commands
  and perform tasks that supplement the host application's features.
 </para>
 <para>
  This chapter covers installing, updating and removing plugins. Documentation
  for the plugins themselves can be found in
  <guimenu>Help</guimenu>&gt;<guimenuitem>jEdit Help</guimenuitem>, and
  information about writing plugins can be found in <xref
  linkend="writing-plugins-part" />.
 </para>
 <sect1 id="plugin-manager"><title>The Plugin Manager</title>
  <para>
   <guimenu>Plugins</guimenu>&gt;<guimenuitem>Plugin Manager</guimenuitem>
   displays the plugin manager window. The plugin manager lists all installed
   plugins; clicking on a plugin in the list will display information about it.
  </para>
  <para>
   To remove plugins, select them (multiple plugins can be selected by
   holding down <keycap>Control</keycap>) and click <guibutton>Remove</guibutton>.
   This will display a confirmation dialog box first.
  </para>
  <para>
   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>.
  </para>
  <para>
   <guimenu>Plugins</guimenu>&gt;<guimenuitem>Plugin Options</guimenuitem> displays a dialog box for changing plugin settings.
  </para>
 </sect1>
 <sect1 id="installing-plugins"><title>Installing and Updating Plugins</title>
  <para>
   Plugins can be installed in two ways; manually, and from the plugin manager.
   In most cases, plugins should be installed from the plugin manager. It is
   easier and more convenient.
  </para>
  <para>
   To install plugins manually, go to <ulink
   url="http://plugins.jedit.org">http://plugins.jedit.org</ulink> in a web
   browser and follow the directions on that page.
  </para>
  <para>
   To install plugins from the plugin manager, make sure you are connected to
   the Internet and click the <guibutton>Install</guibutton> tab in
   the plugin manager window. The plugin manager will then download information
   about available plugins from the jEdit web site, and present a list of
   plugins compatible with your jEdit release.
  </para>
  <para>
   Click on a plugin in the list to see some information about it. To select
   plugins for installation, click the check box next to their names in the list.
  </para>
  <para>
   The <guibutton>Total size</guibutton> field shows the total size
   of all plugins chosen for installation, along with any plugins that will be
   automatically downloaded in order to fulfill dependencies.
  </para>
  <para>
   Once you have specified plugins to install, click <guibutton>Install</guibutton> to begin the download process.
  </para>
  <para>
   By default, the plugin manager does not download plugin source code, and installs the downloaded plugins in the <filename>jars</filename>
   subdirectory of the user-specific settings directory. These settings can be changed in <guilabel>Plugin Manager</guilabel> pane of the
   <guimenu>Utilities</guimenu>&gt;<guimenuitem>Global Options</guimenuitem>
   dialog box; see <xref linkend="pluginmgr-pane" />.
  </para>
  <para>
   The <guibutton>Update</guibutton> tab of the plugin manager 
   is very similar to the <guibutton>Install</guibutton> tab. It
   lists plugins for which updated versions are available. It will also offer to
   delete any obsolete plugins.
  </para>
  <sidebar><title>Proxy Servers and Firewalls</title>
   <para>
    If you are connected to the Internet through an HTTP proxy or SOCKS firewall,
    you will need to specify the relevant details in the
    <guibutton>Proxy Servers</guibutton> pane of the
    <guimenu>Utilities</guimenu>&gt;<guimenuitem>Global Options</guimenuitem>
    dialog box; see <xref linkend="firewall-pane"/>.
   </para>
  </sidebar>
 </sect1>
</chapter>