Dear Wiki user, You have subscribed to a wiki page or wiki category on "Nutch Wiki" for change notification.
The following page has been changed by JakeVanderdray: http://wiki.apache.org/nutch/WritingPlugins ------------------------------------------------------------------------------ == Introduction == - Writing a plugin allows you to extend and change Nutch without having to modify the core system. In writing a plugin, you're actually providing one or more ''extensions'' of the existing ''extension-points'' . The core Nutch ''extension-points'' are themselves defined in a plugin, the [http://lucene.apache.org/nutch/apidocs/org/apache/nutch/plugin/ExtensionPoint.html NutchExtensionPoints] plugin (they are listed in the !NutchExtensionPoints [http://svn.apache.org/viewcvs.cgi/lucene/nutch/trunk/src/plugin/nutch-extensionpoints/plugin.xml?view=markup plugin.xml] file). Each ''extension-point'' define an interface that must be implemented by the ''extension''. Nutch core extension points are (Please update this list with any I've missed): + Plugins allow you to extend and change Nutch without having to modify the core system. All of the parsing, indexing and searching that nutch does is actually accomplished with varrious plugins. In writing a plugin, you're actually providing one or more ''extensions'' of the existing ''extension-points'' . The core Nutch ''extension-points'' are themselves defined in a plugin, the [http://lucene.apache.org/nutch/apidocs/org/apache/nutch/plugin/ExtensionPoint.html NutchExtensionPoints] plugin (they are listed in the !NutchExtensionPoints [http://svn.apache.org/viewcvs.cgi/lucene/nutch/trunk/src/plugin/nutch-extensionpoints/plugin.xml?view=markup plugin.xml] file). Each ''extension-point'' define an interface that must be implemented by the ''extension''. Nutch core extension points are: * [http://lucene.apache.org/nutch/apidocs/org/apache/nutch/clustering/OnlineClusterer.html OnlineClusterer] -- An extension point interface for online search results clustering algorithms (from javadoc). * [http://lucene.apache.org/nutch/apidocs/org/apache/nutch/indexer/IndexingFilter.html IndexingFilter] -- Permits one to add metadata to the indexed fields. All plugins found which implement this extension point are run sequentially on the parse (from javadoc). @@ -28, +28 @@ * A build.xml file that tells ant how to build your plugin. * The source code of your plugin. - == Plugin.xml == - - The plugin.xml file describes your plugin including the names of your extensions and specificly what they're extending. - - == Build.xml == - - Tells ant how to build your plugin. - == Getting Nutch to Use Your Plugin == In order to get Nutch to use your plugin, you need to edit your conf/nutch-site.xml file and add the name of your plugin to the list of plugin.includes. - - == Compiling == - - Running 'ant' in the root of your checkout directory should get everything compiled and jared up. The next time you run a crawl your parser and index filter should get used. - - == Deploying == - - You'll need to run 'ant war' to compile a new ROOT.war file. Once you've deployed that, your query filter should get used when searches are performed. <<< See also: WritingPluginExample
