Plugins

From GregariusWiki

Gregarius can be easily extended using plugins. For example, some plugins help you "mark items and feeds as read" in intelligent ways and others add extra buttons and features to your gregarius webpages.

Contents 1 Installing Plugins 2 Default Plugins 3 Other Plugins 4 Plugin Ideas 5 Plugin Development

[edit] Installing Plugins

• Download the plugin from the plugin repository.
• Copy it to the plugins/ directory of your Gregarius installation
• The new plugin should now appear in the list of plugins.
• Enable it by ticking the checkbox next to it and clicking Submit Changes at the bottom.

[edit] Default Plugins

Several plugins come with Gregarius by default:

• del.icio.us Tags - Fetches tag suggestions from del.icio.us.
• Doubleclick to Read - Marks items as read when they are double-clicked.
• Extra Button - adds an extra "Mark Feed/Folder as Read" button to the bottom of each Gregarius page.
• HTML filter - fixes some common xhtml markup errors.
• New window - makes off-site links appear in a new window.
• Rounded Corners - makes some GUI elements have rounded corners.
• RSS View - displays links to Gregarius' RSS feeds in the header and footer.
• Sticky Button - adds a navigation link pointing to a page showing all sticky items in Gregarius.
• Tidy HTML filter - cleans Gregarius content with the Tidy PHP extension.
• Url filter - replaces links in the form http://www.example.com with a "Slashdot style link" to [example.com]

[edit] Other Plugins

You can view a list of all available plugins at the plugin repository.

• Feed Filter with Regular Expressions - filters incoming items allowing you to include or exclude based upon one or more criteria applied to the title, description or both

[edit] Plugin Ideas

Here are a list of cool plugin ideas. If you would like to implement some of them we would love to have them on the plugin repository.

• Yahoo search results as RSS - Yahoo offers the ability to have search results for words you specify delivered as an RSS feed. Could this be integrated into Gregarius somehow? Obviously you can add the feed given by Yahoo, but it would be nicer to have it integrated.Link
• Package tracking - Create "personal" RSS feeds to track packages by interfacing with package companies' XML APIs. Feature already exists in Bloglines. Link
• Automatic Tagging - Create an automatic tagger Link1 , Link2
• Print an Item - Display a button which allow the user to print the current item, via a pop-up and using CSS styles. Link
• Vacation Feature - After a return from a vacation provide a "summary" theme that compiles the links stored in items and then provides a list of links to the user, with the ability to mark all items related to the links as read. Link
• A button to add an article as Persistant - Without to have to go to the menu and tick Persistant. (A shortcut in fact) Link This plugin is now included in the Gregarius code.
• Caching enclosures - A plugin to cache enclosures on the server. It's Here... It should be made aware of size restrictions. There is also the idea of caching all remote media (images, pdf, swf, etc) for "safe" browsing from work or other restricted networks.
• Automatic Highlighting - Automatically highlight given user keywords Link. Download this plugin from here.

[edit] Plugin Development

Documentation to write your own plugin is available. Up-to-date lists of plugin hooks and recommended API calls are also available.

If you think your plugin would be useful to the user community, please consider adding them to the plugin repository.