====== feedmod plugin ======

---- plugin ----
description: Action plugin which modifies parts of the full html feed to make it suitable for blogging with DokuWiki
author     : Gina Häußge, Michael Klier
email      : dokuwiki@chimeric.de
type       : Action
lastupdate : 2008-05-24
compatible : 2008-05-05
depends    : 
conflicts  : 
similar    : 
tags       : feed, blogging, blogsuite, blog
----

^ Download | [[http://chimeric.de/_src/plugin-feedmod.tgz|plugin-feedmod.tgz]] |

===== Description =====
This [[doku>plugin:action|Action Plugin]] modifies the content of [[doku>DokuWiki|DokuWiki's]] **full html** feed to make it suitable for blogging purposes. It removes the first headline from the feed item body and sets it as feed item title. It also detects if the page uses the [[discussion]] plugin and adds a link to the discussion section after the feed item. It has also support for a custom footer template which gets added to each feed item. This can be used to add links to social bookmarking services for example (see [[#customization]]).

**Note:** The plugin modifies the feed only if two conditions are set, namely when the ''content'' is set to ''html'' and ''linkto'' is set to ''direct'' (see [[..syndication|syndication]]).

===== Installation =====
Download the archive and unpack it into ''<dokuwiki>/lib/plugins''.

  * [[http://www.chimeric.de/_src/plugin-feedmod.tgz|.tgz]] Plugin Manager.
  
The plugin is also available via darcs.

<code>
% cd <dokuwiki>/lib/plugins
% darcs get http://chimeric.de/_dev/darcs/dokuwiki/plugins/feedmod
</code>

===== Customization =====
The plugin has support for a custom //footer// template which gets added to every feed item. To get it working you have to create a file named ''_footer.txt'' below the plugin directory. The plugin contains a ''_footer.txt.dist'' file which contains some examples. The following replacement patterns can be used in this file.

^ @URL@ | Full url to the feed item |
^ @PAGE@ | Page id of the feed item |
^ @TITLE@ | Title (first headline) of the feed item |
^ @AUTHOR@ | Author of the feed item (wiki page) |

Here's a short example for social bookmarking services:

<file>
<a href="http://digg.com/submit?phase=2&url=@URL@" title="Digg this post">Digg this post</a> &middot;
<a href="http://www.stumbleupon.com/submit?url=@URL@" title="Digg this post">Stumble it</a> &middot;
<a href="http://del.icio.us/post/?url=@URL@" title="Save to del.icio.us">Save to del.icio.us</a>
</file>

===== Resources =====
  * [[http://darcs.chimeric.de/darcsweb.cgi?r=feedmod|Darcs Repository]]
  * [[http://www.chimeric.de/_dev/codereference/|Source Code Documentation]]

===== ToDo =====

===== Feature Requests =====
**You`re missing something? Add it here!**

===== Bugs =====
**You`ve found a bug? Add it here!**