Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update docs, indicate recent testing.

  • Loading branch information...
commit 4d0213cb3b6f2c6e41b0b1a93470a34016e3c84f 1 parent b6b775f
authored September 12, 2012
137  README.md
Source Rendered
@@ -11,55 +11,79 @@ Description
11 11
 * Donate link: <http://feedwordpress.radgeek.com/donate/>
12 12
 * License: GPL 2. See License below for copyright jots and tittles.
13 13
 * Requires at least: WordPress 3.0
14  
-* Tested up to: WordPress 3.3.2
  14
+* Tested up to: WordPress 3.4.2
15 15
 
16  
-FWP+: Keyword Filters works together with the FeedWordPress feed aggregator plugin
17  
-for WordPress weblogs. With the Keyword Filters module activated, you can set up
18  
-filtering rules that determine what to do with incoming posts based on the keywords
19  
-found in the text of the post, or on the categories assigned to it on its original
20  
-source. Filtering rules can be set up to apply to all of your subscriptions, or
21  
-can be applied only to posts coming in from one particular feed.
  16
+FWP+: Keyword Filters works together with the FeedWordPress feed aggregator
  17
+plugin for WordPress weblogs. With the Keyword Filters module activated, you can
  18
+set up filtering rules that determine what to do with incoming posts based on
  19
+the keywords found in the text of the post, or on the categories assigned to it
  20
+on its original source. Filtering rules can be set up to apply to all of your
  21
+subscriptions, or can be applied only to posts coming in from one particular
  22
+feed.
22 23
 
23 24
 Usage
24 25
 -----
25  
-Once you have installed and activated the add-on module (as per Installation below)
26  
-go to **Syndication --> Posts & Links** (to set up filtering rules that apply to
27  
-posts from *any* of your subscriptions), or go to the **Posts** settings page for
28  
-one of the individual feeds you subscribe to (to set up filtering rules that apply
29  
-only to posts from *that* particular source). Use the "+ Add Another Filter" link
30  
-to set up new rules. The rules in the "Keyword Filters" section will be applied
31  
-when a new incoming post matches the patterns you set up. The rules in the
32  
-"Default" section will be applied to any posts that don't match any of the patterns
33  
-you've set up.
34  
-
35  
-Your rules can be set up to filter posts out (so that they will not appear on your
36  
-FeedWordPress site), or to filter posts in (so that they *will* appear on your
37  
-site). You can also set up rules to assign matching posts to one or more particular
38  
-categories, or to apply one or more tags to them.
39  
-
40  
-**Searching for keywords in the post text:** To search for one or more keywords in
41  
-the text of an incoming post, just type the keywords, one after another, into the
42  
-"Posts containing [...]" box. This works roughly like a Google search: Keyword
43  
-Filters will search for posts that contain *all* of those keywords, as complete
44  
-words (so, for example, "cat dog" will search for posts that contain *both* the
45  
-word "cat" by itself, and the word "dog" by itself; it will not match "categories"
46  
-or "doggerel"). Keywords match regardless of uppercase or lowercase letters (so
47  
-"cat" will match not only "cat," but also "CAT," "cAt," etc.). If you want to set
48  
-up filters for posts that contain either "cat" or "dog" but not necessarily both,
49  
-set up two separate keyword filtering rules, one for each term.
50  
-
51  
-**Searching for regular expressions in the post text:** If you need more flexible
52  
-searching, you can search incoming posts for a Perl-compatible regular expression
53  
-by wrapping the keyword pattern in forward slashes (like /this/). So, for
54  
-example, if you need to match anything that includes the letters c-a-t, including
55  
-"cat," "cats," "categories," "signification," etc., use the following pattern:
  26
+
  27
+Once you have installed and activated the add-on module (as per Installation
  28
+below) go to **Syndication --> Posts & Links** (to set up filtering rules that
  29
+apply to posts from *any* of your subscriptions), or go to the **Posts**
  30
+settings page for one of the individual feeds you subscribe to (to set up
  31
+filtering rules that apply only to posts from *that* particular source). Use the
  32
+"+ Add Another Filter" link to set up new rules. The rules in the "Keyword
  33
+Filters" section will be applied when a new incoming post matches the patterns
  34
+you set up. The rules in the "Default" section will be applied to any posts that
  35
+don't match any of the patterns you've set up.
  36
+
  37
+Your rules can be set up to filter posts out (so that they will not appear on
  38
+your FeedWordPress site), or to filter posts in (so that they *will* appear on
  39
+your site). You can also set up rules to assign matching posts to one or more
  40
+particular categories, or to apply one or more tags to them.
  41
+
  42
+By default, FeedWordPress will include any post that appears on a feed, unless a
  43
+rule explicitly filters it out. So if you want to ensure that posts only appear
  44
+when they match one or more of your filtering rules, set up a "Default" rule
  45
+indicating that posts containing no matching keywords will be filtered out. Then
  46
+add rules to the "Keyword Filters" section specifying the conditions which will
  47
+allow a post to be filtered in.
  48
+
  49
+Rules you set up will either search for posts **placed into certain categories**
  50
+on their original source website, or posts **that contain certain keywords**.
  51
+You can also search for keywords based on an exact word match, or based on a
  52
+regular expression.
  53
+
  54
+**Searching for post categories:** To search for categories on a post, change
  55
+the "in their [...]" dropdown so that it reads "in their categories" instead of
  56
+"in their text." Then enter the name of the category you want to search for in
  57
+the keyword box. Note that **category matches must be exact matches:** putting
  58
+`"Stuff"` in the box will match posts that had the category "Stuff" on the
  59
+original source website, but not (e.g.) posts that had a category called "Stuff
  60
+and Nonsense".
  61
+
  62
+**Searching for keywords in the post text:** To search for one or more keywords
  63
+in the text of an incoming post, just type the keywords, one after another, into
  64
+the "Posts containing [...]" box. This works roughly like a Google search:
  65
+Keyword Filters will search for posts that contain *all* of those keywords, as
  66
+complete words (so, for example, "cat dog" will search for posts that contain
  67
+*both* the word "cat" by itself, and the word "dog" by itself; it will not match
  68
+"categories" or "doggerel"). Keywords match regardless of uppercase or lowercase
  69
+letters (so "cat" will match not only "cat," but also "CAT," "cAt," etc.). If
  70
+you want to set up filters for posts that contain either "cat" or "dog" but not
  71
+necessarily both, set up two separate keyword filtering rules, one for each
  72
+term.
  73
+
  74
+**Searching for regular expressions in the post text:** If you need more
  75
+flexible searching, you can search incoming posts for a Perl-compatible regular
  76
+expression by wrapping the keyword pattern in forward slashes (like /this/). So,
  77
+for example, if you need to match anything that includes the letters c-a-t,
  78
+including "cat," "cats," "categories," "signification," etc., use the following
  79
+pattern:
56 80
 
57 81
 	/cat/
58 82
 
59 83
 Regular expression searches are usually case-sensitive, so this will match "cat"
60 84
 and "categories" but not "Cats" or "signifiCATion." To make the search ignore
61  
-case, so that it will match "Cats" or "signifiCATion" as well, use the i modifier
62  
-on the pattern:
  85
+case, so that it will match "Cats" or "signifiCATion" as well, use the i
  86
+modifier on the pattern:
63 87
 
64 88
 	/cat/i	
65 89
 
@@ -71,39 +95,32 @@ You can use regular expression syntax for more complicated patterns:
71 95
 
72 96
 	/the \s+ (fat \s+)? cat \s+ sat \s+ (up)?on \s+ the \s+ [a-z]+/ix
73 97
 
74  
-Will match "the fat cat sat on the mat", "The CAT sat upon the mat", "The FAT cAt
75  
-sat upon the dais," and a number of other phrases.
76  
-
77  
-**Searching for post categories:** To search for categories on a post, change the
78  
-"in their [...]" dropdown so that it reads "in their categories" instead of "in
79  
-their text." Then enter the name of the category you want to search for in the
80  
-keyword box. Note that category matches must be exact matches, so putting "Stuff"
81  
-in the box will match posts that had the category "Stuff" on the original source
82  
-website, but not (e.g.) posts that had a category called "Stuff and Nonsense".
  98
+Will match "the fat cat sat on the mat", "The CAT sat upon the mat", "The FAT
  99
+cAt sat upon the dais," and a number of other phrases.
83 100
 
84 101
 Installation
85 102
 ------------
86 103
 
87 104
 To use FWP+: Keyword Filters, you will need:
88 105
 
89  
-* 	an installed and configured copy of [WordPress][] (version 3.0 or later).
  106
+* an installed and configured copy of [WordPress][] (version 3.0 or later).
90 107
 
91  
-*	an installed and configured copy of [FeedWordPress][]
  108
+* an installed and configured copy of [FeedWordPress][]
92 109
 
93  
-*	FTP, SFTP or shell access to your web host
  110
+* FTP, SFTP or shell access to your web host
94 111
 
95 112
 Here's what you do.
96 113
 
97  
-1.	Download the FWP+: Keyword Filters installation package and extract the files
98  
-	on your computer. 
  114
+1.  Download the FWP+: Keyword Filters installation package and extract the
  115
+    files on your computer. 
99 116
 
100  
-2.	Create a new directory named `fwp-keyword-filters` in the `wp-content/plugins`
101  
-	directory of your WordPress installation. Use an FTP or SFTP client to upload
102  
-	the contents of the installation package to the new directory that you just
103  
-	created on your web host.
  117
+2.  Create a new directory named `fwp-keyword-filters` in the 
  118
+    `wp-content/plugins` directory of your WordPress installation. Use an FTP or
  119
+    SFTP client to upload the contents of the installation package to the new
  120
+    directory that you just created on your web host.
104 121
 
105  
-3.	Log in to the WordPress Dashboard, go to the Plugins page, and activate the
106  
-	FWP+: Keyword Filters module.
  122
+3.  Log in to the WordPress Dashboard, go to the Plugins page, and activate the
  123
+    FWP+: Keyword Filters module.
107 124
 
108 125
 License
109 126
 -------
2  fwp-keyword-filters.php
@@ -2,7 +2,7 @@
2 2
 /*
3 3
 Plugin Name: FWP+: Keyword Filters
4 4
 Plugin URI: http://feedwordpress.radgeek.com/
5  
-Description: simple and flexible keyword filtering for FeedWordPress syndicated posts
  5
+Description: simple and flexible keyword or category filtering for FeedWordPress syndicated posts
6 6
 Version: 2012.0601
7 7
 Author: Charles Johnson
8 8
 Author URI: http://radgeek.com/

0 notes on commit 4d0213c

Please sign in to comment.
Something went wrong with that request. Please try again.