PageRenderTime 38ms CodeModel.GetById 12ms RepoModel.GetById 0ms app.codeStats 0ms

/jEdit/tags/jedit-4-5-pre1/doc/users-guide/using-plugins.xml

#
XML | 143 lines | 112 code | 28 blank | 3 comment | 0 complexity | 740b5010c1eb9727bbe1ea5f2b6b34ca MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <chapter id="using-plugins">
  3. <title>Installing and Using Plugins</title>
  4. <!-- jEdit buffer-local properties: -->
  5. <!-- :tabSize=1:indentSize=1:noTabs=true:wrap=hard:maxLineLen=80: -->
  6. <!-- :xml.root=users-guide.xml: -->
  7. <para>A <firstterm>plugin</firstterm> is an application which is loaded and
  8. runs as part of another, host application. Plugins respond to user commands
  9. and perform tasks that supplement the host application's features.</para>
  10. <para>This chapter covers installing, updating and removing plugins.
  11. Documentation for the plugins themselves can be found in
  12. <guimenu>Help</guimenu>&gt;<guimenuitem>jEdit Help</guimenuitem>, and
  13. information about writing plugins can be found in <xref
  14. linkend="writing-plugins-part" />.</para>
  15. <section id="plugin-manager">
  16. <title>The Plugin Manager</title>
  17. <para><guimenu>Plugins</guimenu>&gt;<guimenuitem>Plugin
  18. Manager</guimenuitem> displays the plugin manager window. It consists of
  19. three tabs: Manage, Update and Install. The Manage tab lists all
  20. installed plugins; clicking on a plugin in the list will display
  21. information about it.</para>
  22. <para>To remove plugins, select them (multiple plugins can be selected
  23. by holding down <keycap>Control</keycap>) and click
  24. <guibutton>Remove</guibutton>. This will display a confirmation dialog
  25. box first.</para>
  26. <para>To view plugin documentation, select a plugin and click
  27. <guibutton>Help</guibutton>. Note that plugin documentation can also be
  28. accessed by invoking <guimenu>Help</guimenu>&gt;<guimenuitem>jEdit
  29. Help</guimenuitem>.</para>
  30. <para> After you have tuned jEdit to your liking and want to install the
  31. same set of plugins onto another host, or another user's profile, you
  32. can export your currently installed plugin list as an xml file, known as
  33. a <emphasis role="bold">PluginSet</emphasis>. The
  34. <guibutton>Save</guibutton> rollover button allows you to save the list
  35. of installed and loaded plugins to an XML file. See <xref
  36. linkend="plugin-sets" /> for more information. </para>
  37. <para><guimenu>Plugins</guimenu>&gt;<guimenuitem>Plugin
  38. Options</guimenuitem> displays a dialog box for changing plugin
  39. settings.</para>
  40. </section>
  41. <section id="installing-plugins">
  42. <title>Installing and Updating Plugins</title>
  43. <para>Plugins can be installed in two ways; manually, and from the
  44. plugin manager. In most cases, plugins should be installed from the
  45. plugin manager. It is easier and more convenient.</para>
  46. <para>To install plugins manually, go to <ulink
  47. url="http://plugins.jedit.org">http://plugins.jedit.org</ulink> in a web
  48. browser and follow the directions on that page.</para>
  49. <para>To install plugins from the plugin manager, make sure you are
  50. connected to the Internet and click the <guibutton>Install</guibutton>
  51. tab in the plugin manager window. The plugin manager will then download
  52. information about available plugins from the jEdit web site, and present
  53. a list of plugins compatible with your jEdit release.</para>
  54. <para>Click on a plugin in the list to see some information about it. To
  55. select plugins for installation, click the check box next to their names
  56. in the list.</para>
  57. <para>The <guibutton>Total size</guibutton> field shows the total size
  58. of all plugins chosen for installation, along with any plugins that will
  59. be automatically downloaded in order to fulfill dependencies.</para>
  60. <para>If a previously saved PluginSet was selected, it will
  61. automatically be loaded whenever the Install tab is created, and you
  62. will see the filename in the hovertip of the
  63. <guibutton>choose</guibutton> rolloverbutton, as well as all of the
  64. plugins in that set already checked for you. </para>
  65. <para> You can clear the active PluginSet with the
  66. <guibutton>clear</guibutton> button next to it, or choose a different
  67. PluginSet xml file with the <guibutton>choose</guibutton> button. See
  68. <xref linkend="plugin-sets" /> for more information. </para>
  69. <para>Once you have specified plugins to install, click
  70. <guibutton>Install</guibutton> to begin the download process.</para>
  71. <para>By default, the plugin manager does not download plugin source
  72. code, and installs the downloaded plugins in the
  73. <filename>jars</filename> subdirectory of the user-specific settings
  74. directory. These settings can be changed in <guilabel>Plugin
  75. Manager</guilabel> pane of the
  76. <guimenu>Utilities</guimenu>&gt;<guimenuitem>Global
  77. Options</guimenuitem> dialog box; see <xref
  78. linkend="pluginmgr-pane" />.</para>
  79. <para>The <guibutton>Update</guibutton> tab of the plugin manager is
  80. very similar to the <guibutton>Install</guibutton> tab. It lists plugins
  81. for which updated versions are available. It will also offer to delete
  82. any obsolete plugins.</para>
  83. <sidebar>
  84. <title>Proxy Servers and Firewalls</title>
  85. <para>If you are connected to the Internet through an HTTP proxy or
  86. SOCKS firewall, you will need to specify the relevant details in the
  87. <guibutton>Proxy Servers</guibutton> pane of the
  88. <guimenu>Utilities</guimenu>&gt;<guimenuitem>Global
  89. Options</guimenuitem> dialog box; see <xref
  90. linkend="firewall-pane" />.</para>
  91. </sidebar>
  92. </section>
  93. <section id="plugin-sets">
  94. <title>Plugin Sets</title>
  95. <para> A <emphasis role="bold">PluginSet</emphasis> is a collection of
  96. plugins, represented as an XML file. These XML files can be created from the
  97. <guibutton>save</guibutton> button of the Manage tab of the Plugin Manager.
  98. Saving a PluginSet remembers all of the currently loaded plugins. </para>
  99. <para> When a PluginSet has been saved, it becomes the "default pluginset",
  100. which means that if you unload/uninstall plugins from that set and go back to the
  101. Install tab, you should see them selected for download again. To clear this
  102. setting, click on the <guibutton>clear</guibutton> button in the
  103. Install tab.
  104. </para>
  105. <para> It is posisble to Choose/Open a PluginSet from the Manage or the
  106. Install tab. The behavior of choosing a PluginSet depends on which tab
  107. you are on when you choose it. From the Manage tab, it unloads plugins that
  108. are loaded but not in the list. From the Install tab, it selects plugins
  109. from that list that are not loaded, marking them for download from Plugin
  110. Central. </para>
  111. <para> When choosing a PluginSet, the path can be given as a remote URL.
  112. This helps teachers and sysadmins direct the students/slaves to a standard
  113. set of plugins that are required for the course/job. </para>
  114. </section>
  115. </chapter>