Gossamer Links Help


Table of Contents

PlugIn Help
Warning:
Plugins contain code that will get executed on your system. You should be careful before installing any plugins from a source that you do not trust! 

Your plugin management screen is divided into three options:

  • Plugin Manager - This lets you install, uninstall, edit and delete plugins from Gossamer Links
  • Plugin Download - This lets you fetch plugins from Gossamer Threads, remote URL's, or from your own computer.
  • Plugin Wizard - This helps you create your own plugin! If you are interested in learning more about creating your own plugins, please check out the Links SQL Developers Guide for more information.

This page will go over how to manage your plugins, download new ones, and install and remove existing ones.

The Plugin Manager:
The plugin manager lets you install, remove or edit plugins. The opening screen contains:

  • A list of plugins already installed on your system. It will show you the plugin name, plugin author, and version number, and offer you the choice of removing the plugin or editing it.
  • A list of plugins available to be installed. Again, the plugin name, plugin author and version number are shown, as well as links to install the plugin or remove it from your system. 

Installing Plugins
To install a plugin, simply click on Install beside the plugin you want to add. A screen will be displayed confirming that you want to add the plugin and display any special instructions from the plugin author. You can then confirm the install, or abort and return to the main screen. Upon confirming the install, the plugin will be installed, and will show up on your list of installed plugins. Also, a menu will appear on the left showing any special functions the plugin provides. 

Removing Plugins
Removing plugins is just as simple. Simply click Uninstall beside the plugin and you will be prompted with a confirmation screen displaying any special message from the plugin author. You can then click Full Uninstall, or Skip Plugin Uninstall. You would want to skip the plugin uninstall if you don't want to lose any data the plugin created. For instance, the SearchLogger plugin stores keywords users have searched on. If you didn't want to lose this data, you would click Skip Plugin Uninstall. Typically, a Full Uninstall is recommended.

Upgrading Plugins
Plugins get improved all the time, and upgrading is a snap. When you install a plugin, if it is already on your system, you will be prompted if you want to overwrite it or not with the newer version. Simply click overwrite, and the plugin will get upgraded.

Editing Plugins
You can edit your installed plugins. Simply click on Edit beside the plugin you want to edit. This lets you temporairly disable a plugin hook, while you are testing, or remove menu choices you don't use, as well as set plugin options.

Removing Plugins
If you are tired of a plugin and don't plan to use it again, you can remove it from your Uninstalled list. This actually removes the file, and is not recoverable. Be sure you are done with the plugin before removing it.

Plugin Download:
There are three ways to add new plugins.

1. View a list of plugins on Gossamer Threads. Clicking here will show you a list of plugins available for download from Gossamer Threads. You can just pick which one you want and it will automatically download it to your computer. Then simply click on Install and it will be activated.

2. You can enter in a URL to a plugin, and Gossamer Links will fetch the plugin and save it to your computer.

3. You can upload a plugin file, and Gossamer Links will save it to your computer.

Once the plugin has been retrieved, it shows up in the Uninstalled list. Simply click Install and it will be added to the list.

That's all there is to it! Interested in expanding Gossamer Links? Be sure to read the Gossamer Links Developers Guide!

Table of Contents