Title: Documentation?
Last modified: August 21, 2016

---

# Documentation?

 *  [TIEro](https://wordpress.org/support/users/tiero/)
 * (@tiero)
 * [12 years, 8 months ago](https://wordpress.org/support/topic/documentation-33/)
 * Is there any documentation for the plugin? I had a look around and couldn’t find
   any.
 * It would be nice to know what each filter does, how it does it, how to do things
   like apply multiple keyword filters (in one or in several instances?), etc.
 * Thanks!
 * [http://wordpress.org/plugins/faf/](http://wordpress.org/plugins/faf/)

Viewing 6 replies - 1 through 6 (of 6 total)

 *  Plugin Author [Bas Schuiling](https://wordpress.org/support/users/basszje/)
 * (@basszje)
 * [12 years, 8 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214124)
 * I agree with you of course, but unfortunately I hardly have time to update the
   plugin with fixes & features, let alone write proper documentation for it. However
   all functions are ( should be ) commented.
 * You can find what the filters do quite easily by looking at the files in the 
   filters map. Each filters has it’s own file. The execute() function takes care
   of handling stuff. Most of them (like keywords filter ) are quite small so it
   should be easy to figure out.
 * FAF works with preliminary posts coming from FWP, something like this:
 * FeedWordpress Post -> FAF -> FAF decides which filter shoulf run -> Filter
 * and returning the modifed $post var back along this line.
 * Just let me know if you want to know more. When the version counter starts ticking
   towards 1.0 documentation will follow as well I hope 🙂
 *  Thread Starter [TIEro](https://wordpress.org/support/users/tiero/)
 * (@tiero)
 * [12 years, 7 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214243)
 * It was mostly little things. The tips cover most of it, but stuff like invalid
   characters (can’t put “[http://&#8221](http://&#8221); in the keyword filters,
   for example, as “/” is not allowed) and other little things that pop up.
 * The trouble is that most of the questions are very specific and only occur when
   I run into them, of course!
 *  Plugin Author [Bas Schuiling](https://wordpress.org/support/users/basszje/)
 * (@basszje)
 * [12 years, 7 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214245)
 * Well, that’s a bug and you should report them here right away!
 * Also little things that are annoying or could be better are to be placed here
   so I can improve the plugin. 🙂
 *  Thread Starter [TIEro](https://wordpress.org/support/users/tiero/)
 * (@tiero)
 * [12 years, 7 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214260)
 * I didn’t think of it as a bug… more a “limitation”. 🙂
 * Another example is being able to remove whole URLs, not just HTML markup. For
   example, taking out “[http://wordpress.org&#8221](http://wordpress.org&#8221);
   as text, as well as a clickable URL.
 * Ads, too. It’s really annoying when a syndicated feed has piles of ads in it 
   that get reproduced and mess with layout. Though that’s tougher to do and also
   raises some questions on ethical use, I suspect!
 *  Plugin Author [Bas Schuiling](https://wordpress.org/support/users/basszje/)
 * (@basszje)
 * [12 years, 7 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214261)
 * Unwanted limitations, the same.
 * Why don’t you use the remove html filter for ads?
 *  Thread Starter [TIEro](https://wordpress.org/support/users/tiero/)
 * (@tiero)
 * [12 years, 7 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214268)
 * Good point on the ads, I don’t remember seeing any since adding your filters (
   though there were tons before). My bad. 🙂
 * Of course, typed URLs still appear, as noted above.
 * Just realised I’d never said “thank you” – it’s a great plugin and has made things
   a lot smoother and cleaner on the sites where I have it installed. Great stuff!

Viewing 6 replies - 1 through 6 (of 6 total)

The topic ‘Documentation?’ is closed to new replies.

 * ![](https://s.w.org/plugins/geopattern-icon/faf.svg)
 * [FeedWordPress Advanced Filters](https://wordpress.org/plugins/faf/)
 * [Frequently Asked Questions](https://wordpress.org/plugins/faf/#faq)
 * [Support Threads](https://wordpress.org/support/plugin/faf/)
 * [Active Topics](https://wordpress.org/support/plugin/faf/active/)
 * [Unresolved Topics](https://wordpress.org/support/plugin/faf/unresolved/)
 * [Reviews](https://wordpress.org/support/plugin/faf/reviews/)

 * 6 replies
 * 2 participants
 * Last reply from: [TIEro](https://wordpress.org/support/users/tiero/)
 * Last activity: [12 years, 7 months ago](https://wordpress.org/support/topic/documentation-33/#post-4214268)
 * Status: not resolved