README.text: 0.99 vs 0.95 · FeedWordPress

← All changes | README.text +310 -403 0.95 → 0.99 View file →

		@@ -1,192 +1,269 @@
1	1	FeedWordPress
2	2	=============
3	3
4		-* Author: [Charles Johnson](http://www.radgeek.com/contact)
5		-* Version: 0.95
	4	+* Author: [Charles Johnson](http://radgeek.com/contact)
	5	+* Version: 0.99
6	6	* Project URI: <http://projects.radgeek.com/feedwordpress>
7		-* License: GPL. See License below for copyright jots and tittles.
	7	+* License: GPL 2. See License below for copyright jots and tittles.
8	8
9	9	Introduction
10	10	------------
11		-FeedWordPress is an Atom/RSS aggregator for WordPress. It syndicates content
12		-from newsfeeds that you select into your WordPress blog; if you syndicate
13		-several newsfeeds then you can WordPress's posts database and templating engine
14		-as the back-end of an aggregation ("planet") website. I originally developed it
15		-because I needed a more flexible replacement for [Planet][] to use at
16		-[Feminist Blogs][].
	11	+FeedWordPress is an Atom/RSS aggregator for the WordPress weblog software. It
	12	+syndicates content from newsfeeds that you choose into your WordPress webblog;
	13	+if you syndicate several newsfeeds then you can use WordPress's posts database
	14	+and templating engine as the back-end of an aggregation ("planet") website. I
	15	+originally developed it because I needed a more flexible replacement for
	16	+[Planet][] to use at [Feminist Blogs][].
17	17
18	18	[Planet]: http://www.planetplanet.org/ "Planet Planet"
19	19	[Feminist Blogs]: http://www.feministblogs.org/
20	20
21	21	FeedWordPress is designed with flexibility, ease of use, and ease of
22		-configuration in mind. You'll need a working installation of [WordPress 1.5][]
23		-and FTP or SFTP access to your web host. The ability to create cron jobs on your
24		-web host would be very helpful but it's not absolutely necessary. You don't
25		-need to tweak any plain-text configuration files and you don't need shell
26		-access to your web host to make it work. (Although, I should point out, web
27		-hosts that don't offer shell access are bad web hosts.)
	22	+configuration in mind. You'll need a working installation of WordPress (version
	23	+[2.3][], [2.2][], [2.1][], [2.0][] or [1.5][]), and also FTP or SFTP access to
	24	+your web host. The ability to create cron jobs on your web host would be very
	25	+helpful but it's not absolutely necessary. You don't need to tweak any
	26	+plain-text configuration files and you don't need shell access to your web
	27	+host to make it work. (Although, I should point out, web hosts that don't
	28	+offer shell access are bad web hosts.)
28	29
29		- [WordPress 1.5]: http://wordpress.org/development/2005/02/strayhorn/
	30	+ [2.3]: http://codex.wordpress.org/Version_2.3
	31	+ [2.2]: http://codex.wordpress.org/Version_2.2
	32	+ [2.1]: http://codex.wordpress.org/Version_2.1
	33	+ [2.0]: http://codex.wordpress.org/Version_2.0
	34	+ [1.5]: http://codex.wordpress.org/Version_1.5
30	35
31		-Installation & Requirements
32		-You'll need a website with WordPress 1.5 installed and configured and FTP or
33		-SFTP access to your web space. You'll probably also want to have either (1)
34		-the ability to create cron jobs on your web host, or (2) a computer of your
35		-own that has always-on Internet access.
	36	+Installation
	37	+------------
	38	+### Requirements ###
36	39
37		-1. Install `feedwordpress.php` in your WordPress `plugins` directory and
38		- `update.php` in your WordPress `wp-content` directory.
39		-
40		-2. (Optional) Upgrade the copy of MagpieRSS packaged with WordPress by
41		- installing the new `rss-functions.php` (archived in
	40	+To use version 0.99 of FeedWordPress, you will need:
	41	+
	42	+1. an installed and configured copy of WordPress 2.3.x, 2.2.x, 2.1.x,
	43	+ 2.0.x, or 1.5.x. (FeedWordPress currently will not work with older
	44	+ versions of WordPress, or with WordPress MU.)
	45	+
	46	+2. FTP or SFTP access to your web host
	47	+
	48	+### Installation ###
	49	+
	50	+#### Upgrades ####
	51	+
	52	+To upgrade an existing installation of FeedWordPress to version 0.99:
	53	+
	54	+1. Download the FeedWordPress archive in zip or gzipped tar format and
	55	+ extract the files on your computer.
	56	+
	57	+2. If you are upgrading from version 0.98 or earlier, then you need to
	58	+ create a new directory named `feedwordpress` in the `wp-content/plugins`
	59	+ directory of your WordPress installation, and you also need to delete
	60	+ your existing `wp-content/update-feeds.php` and
	61	+ `wp-content/plugins/feedwordpress.php` files. The file structure for
	62	+ FeedWordPress has changed and the files from your old version will not
	63	+ be overwritten, which could cause conflicts if you leave them in place.
	64	+
	65	+3. Upload the new PHP files to `wp-content/plugins/feedwordpress`,
	66	+ overwriting any existing FeedWordPress files that are there. Also be
	67	+ sure to upgrade `wp-includes/rss.php` and
	68	+ `wp-includes/rss-functions.php` if you use the optional MagpieRSS
	69	+ upgrade, or don't use it yet but do want to syndicate Atom 1.0 feeds.
	70	+
	71	+3. If you are upgrading from version 0.96 or earlier, immediately log
	72	+ in to the WordPress Dashboard, and go to Options --> Syndicated. Follow
	73	+ the directions to launch the database upgrade procedure. The new
	74	+ versions of FeedWordPress incorporate some long-needed improvements, but
	75	+ old meta-data needs to be updated to prevent duplicate posts and other
	76	+ possible maladies. If you're upgrading an existing installation, updates
	77	+ and FeedWordPress template functions will not work until you've done
	78	+ the upgrade. Then take a coffee break while the upgrade runs. It should,
	79	+ hopefully, finish within a few minutes even on relatively large
	80	+ databases.
	81	+
	82	+4. If you are upgrading from version 0.98 or earlier, note that the old
	83	+ `update-feeds.php` has been eliminated in favor of a (hopefully) more
	84	+ humane method for automatic updating. If you used a cron job for
	85	+ scheduled updates, it will not work anymore, but there is another,
	86	+ simpler method which will. See [Setting Up Feed Updates][] below to get
	87	+ scheduled updates back on track.
	88	+
	89	+5. Enjoy your new installation of FeedWordPress.
	90	+
	91	+#### New Installations ####
	92	+
	93	+1. Download the FeedWordPress archive in zip or gzipped tar format and
	94	+ extract the files on your computer.
	95	+
	96	+2. Create a new directory named `feedwordpress` in the `wp-content/plugins`
	97	+ directory of your WordPress installation. Use an FTP or SFTP client to
	98	+ upload the contents of the `wp-content/plugins/feedwordpress` directory
	99	+ in the FeedWordPress archive to the new directory that you just created
	100	+ on your web host.
	101	+
	102	+3. (Optional) Upgrade the copy of MagpieRSS packaged with WordPress by
	103	+ installing the new `rss.php` and `rss-functions.php` (archived in
42	104	`OPTIONAL/wp-includes`) into your WordPress `wp-includes` directory.
	105	+ Upgrading MagpieRSS is necessary if you want to take advantage of
	106	+ support for Atom 1.0, multiple post categories, RSS enclosures, and
	107	+ multiple character encodings. (Note, however, that support for
	108	+ transliterating between character encodings is a very complex and
	109	+ iffy prospect in some PHP environments, so if you intend to use
	110	+ a lot of feeds with alternate encodings you should make sure that
	111	+ your installation of PHP is up-to-date and that you keep a copy of
	112	+ the old MagpieRSS around to compare results.)
43	113
44		-3. Log in to the WordPress Dashboard and activate the FeedWordPress plugin.
45		- Go to Options --> Syndication to set up initial settings for the
46		- syndication link category ("Contributors") by default and the RPC secret
47		- word (blank by default, but you should probably set it to something.)
	114	+4. Log in to the WordPress Dashboard and activate the FeedWordPress
	115	+ plugin.
48	116
49		-4. Set up links for syndication from the WordPress Dashboard using
50		- Links --> Syndicated or Links --> Import.
	117	+5. While you're at the Dashboard, once the plugin is activated, you can
	118	+ go to Syndication --> Options and set (1) the link category that
	119	+ FeedWordPress will syndicate links from (by default, "Contributors"),
	120	+ and (2) whether FeedWordPress will use automatic updates or only
	121	+ manual updates.
51	122
52		-5. FeedWordPress is now ready to feed syndicated content into WordPress.
53		- In order for it to actually receive that content, either (1) have your
54		- contributors add WordPress's XML-RPC URI to their blog's list of URIs
55		- to ping when they update posts, (2) set up a cron job to check in on all
56		- the feeds on a regular basis, or (3) both. If you do (2), you can either
57		- set up a job to run `php update-feeds.php` on your web host, or set one
58		- up on any computer with always-on Internet access to request
59		- `update-feeds.php` over the web.
60		-
61		- If your copy of WordPress is installed at <http://www.zyx.com/blog>, and
62		- you set the secret word for XML-RPC pings to "foo", then your XML-RPC
63		- URI will be <http://www.zyx.com/blog/xmlrpc.php>, and the URI to request
64		- for `update-feeds.php` to update all feeds will be
65		- <http://www.zyx.com/blog/wp-content/update-feeds.php?shibboleth=foo>
	123	+5. Go to the main Syndication page to set up the list of sites that
	124	+ you want FeedWordPress to syndicate onto your blog. (If you have the
	125	+ feeds you want to aggregate in a service such as Bloglines,
	126	+ you may prefer to export them to an OPML file and use WordPress's
	127	+ Blogroll --> Import Links to import them into the contributors
	128	+ category.)
66	129
67		-For detailed installation instructions, point your web browser to
68		-<http://projects.radgeek.com/feedwordpress/install>.
	130	+#### Setting Up Feed Updates ####
69	131
70		-Basic Concepts
71		-FeedWordPress is written as a plugin for [WordPress 1.5][]. It is designed to
72		-store all the data it needs within the WordPress database and to make that data
73		-easy to manage from within the WordPress Dashboard.
	132	+FeedWordPress is now ready to accept posts from its syndication sources. The
	133	+next thing to do is to make sure it knows when to go get them.
74	134
75		-### Contributors / Newsfeeds ###
	135	+N.B.: If you are upgrading from version 0.981 or earlier of FeedWordPress,
	136	+the system for checking for new posts has been overhauled, hopefully making it
	137	+more humane, and also easier to use for people who do not have access to task
	138	+scheduling tools such as `cron`. You will need to re-read this section and
	139	+change your set-up accordingly.
76	140
77		-FeedWordPress uses the WordPress Links database to keep a list of the feeds from
78		-which it will syndicate content. WordPress allows you to place links in
79		-categories; FeedWordPress will treat all and only the links in one category
80		-(by default, this is a category named "Contributors"; you can change the
81		-category that FeedWordPress will use using Options --> Syndication).
	141	+FeedWordPress allows you to choose whether it will check for new posts
	142	+automatically, or only when you manually request for it to check. By default,
	143	+FeedWordPress opts for the manual option -- so that you can get your feeds
	144	+set up properly before FeedWordPress begins importing new posts. If you want
	145	+to use automatically scheduled updates, remember to enable them in
	146	+Syndication --> Options after you finish setting up FeedWordPress.
82	147
83		-From WordPress's perspective, the list of Contributors are normal links, and
84		-they can be manipulated like other links through the WordPress Dashboard. If
85		-you need to add, remove, or change information for any contributors, you can
86		-do so easily under Links --> Syndicated. If you want to distribute the labor of
87		-adding, updating, and managing feeds, you can use the WordPress login and
88		-access privileges system. Users with an access level of 5 or greater can add,
89		-delete, and modify Contributors; users with an access level of 6 or greater can
90		-change syndication options.
	148	+##### Manual Feed Updates #####
91	149
92		-When FeedWordPress looks for new posts, it does so by retrieving one or all of
93		-the links from the Contributors category (depending on whether it has been told
94		-to scan for new posts on one or all of the feeds).
	150	+To manually check for new posts, log in to the WordPress Dashboard and go to the
	151	+main page under Syndication. You can use the "Update feeds now" button to
	152	+check for new posts on feeds that are due for a scheduled update, or use the
	153	+checkboxes and "Update Checked Feeds" button to force FeedWordPress to check one
	154	+or more specific feeds for new posts. FeedWordPress will check the selected
	155	+feed or feeds for new posts, and import any new content available.
95	156
96		-__Feed settings:__ All of the information for a syndicated feed is stored in
97		-the WordPress Links database. Feeds in the category to be syndicated (by
98		-default, "Contributors") use several fields of the standard WordPress Link
99		-record:
	157	+##### Automatic Feed Updates #####
100	158
101		-- The RSS URI is used to store the URI for the feed to be syndicated.
102		- (Note that this is not the same as the Link URI. The Link URI points
103		- to the human-readable front page of the website that the feed
104		- syndicates.)
	159	+If you choose an automatic update schedule, then FeedWordPress will
	160	+automatically check for new posts based on a schedule you determine. When
	161	+automatic updates are enabled, FeedWordPress will check for new posts when
	162	+(1) at least ten minutes have passed since the last update, and (2) a viewer
	163	+visits your FeedWordPress-enabled blog. (If you want the interval of time to
	164	+be shorter or longer, you can change the interval in the Dashboard under
	165	+Syndication --> Options.)
105	166
106		-- The Link URI is used to store a URI to the human-readable front page
107		- (not the feed!) of the syndicated website. FeedWordPress automatically
108		- updates this URI using the URI that is reported by the newsfeed whenever
109		- it checks the feed for new posts, so if the page moves this will be
110		- reflected automatically on your Contributors links list.
	167	+Note that this is not quite the same thing as precisely scheduled updating.
	168	+If you get at least one viewer every ten minutes, then FeedWordPress will be
	169	+regularly checking for new posts on schedule; if not, not. But for a relatively
	170	+active aggregator blog this is probably close enough for government work.
111	171
112		-- The Link Name is used to store the title of the syndicated website.
113		- By default, FeedWordPress automatically updates the name of the link
114		- whenever it checks for new posts, using the title that the
115		- newsfeed reports (so that if a Contributor changes the title of her
116		- website, this is reflected automatically on your Contributors links
117		- list). This behavior can be turned off for all feeds through the
118		- settings in Options --> Syndication. The default behavior can be
119		- overridden for specific feeds using the feed setting
120		- `hardcode name`.
	172	+However, if you want to ensure regular updates, and you have access to a
	173	+task-scheduling tool such as `cron`, you can use it to schedule regular
	174	+checks for updates on a fixed schedule. For example, using `cron`, you can
	175	+easily ensure that FeedWordPress checks for new posts regularly by adding the
	176	+following line to your crontab, substituting the actual address of your
	177	+WordPress installation for "http://www.zyx.com/blog/":
121	178
122		-- The Short Description is used to store the tagline of the syndicated
123		- website. By default, FeedWordPress automatically updates the description
124		- whenever it checks for new posts, using the tagline or description that
125		- the newsfeed reports (so that if a Contributor changes the tagline of
126		- her website, this is reflected automatically on your Contributors links
127		- list). his behavior can be turned off for all feeds through the
128		- settings in Options --> Syndication. The default behavior can be
129		- overridden for specific feeds using the feed setting
130		- `hardcode description`.
	179	+ /15 * * * curl http://www.zyx.com/blog/ > /dev/null
131	180
132		-- The Link Notes are used to store a collection of manually-encoded and
133		- automatically-generated settings that apply to this feed. The format of
134		- settings in Link Notes is:
135		-
136		- key1: value1
137		- key2: value2
138		- feed/key1: value1
139		- feed/key2: value2
140		-
141		- And so on. Values that are prefixed by 'feed/' are automatically
142		- generated from feed data every time the feed syndicated by this link is
143		- checked for updates. Values without the prefix are set manually by the
144		- user.
	181	+If you don't have direct access to `cron` or a similar scheduling tool, you
	182	+can use online tools such as [WebCron](http://www.webcron.org/?lang=en) to
	183	+schedule a regular fetch of your blog's front page to much the same effect.
145	184
146		-The Link Notes section can be used to add, remove, and change custom feed
147		-settings. For example, if you want to add the feed setting for
148		-`unfamiliar author` with the value `filter`, you can do so by going to Links -->
149		-Syndicated, clicking the "Edit" link for the feed that you wish to add this
150		-setting for, and then adding the following, on a line by itself, to the Link
151		-Notes section:
	185	+##### Feed Updates using XML-RPC #####
152	186
153		- unfamiliar author: filter
	187	+FeedWordPress also allows syndicated blogs to notify you of updates using the
	188	+XML-RPC "recently updated" pings (in the standard format accepted by
	189	+Weblogs.com, Ping-O-Matic, Technorati, and other blogging services). Most
	190	+blogging software allows users to add a URI to the list of URIs that get pinged
	191	+with each new update -- see, for example, **Options --> Writing --> Update
	192	+Services in WordPress, or Configuration --> Preferences --> Publicity /
	193	+Remote Interfaces / TrackBack** in Movable Type. If you can get a contributor
	194	+to add your XML-RPC URI to her list of update services to ping, then whenever
	195	+she updates her blog, her blogging software will notify your FeedWordPress
	196	+installation, and FeedWordPress will look up her feed to grab the new posts off
	197	+of it. (If you have WordPress installed at <http://www.zyx.com/blog>, say, the
	198	+URI for her to ping should be <http://www.zyx.com/blog/xmlrpc.php>).
154	199
155		-To remove the setting, follow the same procedure, but find the line for the
156		-feed setting that you want to remove and remove it. To change the value, simply
157		-change the text that follows after the colon.
	200	+Basic Concepts
	201	+--------------
	202	+FeedWordPress is written as a plugin for the WordPress weblog software. It is
	203	+designed to store all the data it needs within the WordPress database and to
	204	+make that data easy to manage from within the WordPress Dashboard.
158	205
159		-Most settings in the Link Notes have no effect on FeedWordPress, but you can use
160		-them to store information for templates to retrieve using the `get_feed_meta()`
161		-template function in a post context (see Template API below). For example, many
162		-aggregator sites use a "face" image for each feed to visually distinguish posts
163		-from different feeds. To implement a face feature, you could add something
164		-like this to each feed's Link Notes, on a line by itself:
	206	+### Contributors / Newsfeeds ###
165	207
166		- face: http://www.zyx.com/mugs/ugly
	208	+FeedWordPress uses the WordPress Links database to keep a list of the feeds from
	209	+which it will syndicate content. WordPress allows you to place links in
	210	+categories; FeedWordPress will make use of all and only the links in one
	211	+category (by default, this is a category named "Contributors"; you can change
	212	+the category that FeedWordPress will use using Options --> Syndication).
167	213
168		-The URI should be changed out for each feed to point to the appropriate image,
169		-of course. Then, to use the setting from within a template:
	214	+From WordPress's perspective, the list of Contributors are normal links, and
	215	+they can be manipulated like other links through the WordPress Dashboard.
	216	+However, FeedWordPress provides a nicer interface for adding, removing, or
	217	+changing information for the Contributor Links from the WordPress Dashboard,
	218	+under Links --> Syndicated.
170	219
171		- // In a post context
172		- <?php $img = get_feed_meta('face'); if (strlen($img) > 0): ?>
173		- <img src="<?=$img?>" alt="" />
174		- <?php endif; ?>
	220	+If you want to distribute the labor of adding, updating, and managing feeds
	221	+between several people, you can use the WordPress login andaccess privileges
	222	+system. Any users with an access level of 5 or greater can add, delete, and
	223	+modify Contributors; users with an access level of 6 or greater can change
	224	+syndication options.
175	225
	226	+When FeedWordPress looks for new posts, it retrieves one or all of the links
	227	+from the Contributors category (depending on whether it has been told to scan
	228	+for new posts on one or all of the feeds), determines which of them should be
	229	+polled for updates (based on how long it has been since the last time each feed
	230	+was polled for updates), and then uses an HTTP conditional GET to check for
	231	+updates at the "RSS URI" for each Link that it selects. Any new posts are added
	232	+to the database, and old posts that have been updated since the last poll are
	233	+updated to reflect the new version.
	234	+
	235	+__Feed settings:__ All of the information for a syndicated feed is stored in the
	236	+WordPress Links database, and can be easily edited using an interface that
	237	+FeedWordPress provides under Links --> Syndicated. (If you're curious about
	238	+the technical details of how the information is stored, you can find out more
	239	+under [API: How feed information is stored][].)
	240	+
	241	+You can use a feed's Edit link under Links --> Syndicated to affect how
	242	+FeedWordPress prcesses posts from that feed. (Most of these options can either
	243	+be set for one particular feed using Links --> Syndicated --> Edit, or set
	244	+as the default for all feeds using Options --> Syndication.) The Edit
	245	+link also allows you to set Custom Feed Settings for use in templates,
	246	+through the use of the [`get_feed_meta()`][get_feed_meta] template function in a
	247	+post context (see [Template API][]). For example, many aggregator sites use a
	248	+"face" image for each feed to visually distinguish posts from different feeds.
	249	+To implement a face feature, you could add a custom setting for each Contributor
	250	+Link, with the key of "face" and a URI such as "http://www.zyx.com/mugs/ugly"
	251	+for the value. (The URI should be changed out for each feed to point to the
	252	+appropriate image, of course.) Then, to use the setting from within a template,
	253	+add something like:
	254	+
	255	+ // In a post context
	256	+ <?php $img = get_feed_meta('face'); if (strlen($img) > 0): ?>
	257	+ <img src="<?=$img?>" alt="" />
	258	+ <?php endif; ?>
	259	+
176	260	... which will display the image, if any, whose URI is set in the "face" setting
177	261	for the feed that post comes from. If there is no "face" setting for a
178		-particular feed, ``get_feed_meta()`` will return an empty string and no image
179		-will be displayed.
	262	+particular feed, [`get_feed_meta()`][get_feed_meta] will return an empty string
	263	+and no image will be displayed.
180	264
181		-Not all feed settings are only for templates. Some affect how FeedWordPress
182		-processes posts from that feed. Currently, the settings with special effects
183		-on FeedWordPress are `cats`, `hardcode name`, `hardcode description`,
184		-`hardcode categories`, `post status`, `comment status`, `ping status`,
185		-`unfamiliar author`, and `unfamiliar categories`. For descriptions of their
186		-effects, see Special Feed Settings below.
	265	+ [API: How feed information is stored]: http://projects.radgeek.com/feedwordpress/api#how-feed-information-is-stored
187	266
188	267	### Syndicated Posts ###
189	268
190	269	Whenever FeedWordPress updates, it scans one or more of the feeds in its
		@@ -194,14 +271,16 @@
194	271	database. Syndicated posts are displayed on your WordPress pages like any other
195	272	posts: they can be listed in archives by category, author, or date; they can be
196	273	found with the search box; and they are included in the newsfeed of your blog.
197	274
198		-In your WordPress templates (Presentation --> Theme Editor) you can access
199		-special information about syndicated posts using functions provided by
200		-FeedWordPress, such as `is_syndicated()`, `the_syndication_source()`,
201		-`the_syndication_source_link()`, and `get_feed_meta()`. For example, here is
202		-the template code that I use (in a post context) to display both the author's
203		-name and the original source of the post in the templates for [Feminist Blogs][]:
	275	+In your WordPress templates (Presentation --> Theme Editor) you can access
	276	+special information about syndicated posts using [functions provided by
	277	+FeedWordPress][Template API], such as [`is_syndicated()`][is_syndicated],
	278	+[`the_syndication_source()`][the_syndication_source],
	279	+[`the_syndication_source_link()`][the_syndication_source_link], and
	280	+[`get_feed_meta()`][get_feed_meta]. For example, here is the template code that
	281	+I use (in a post context) to display both the author's name and the original
	282	+source of the post in the templates for [Feminist Blogs][]:
204	283
205	284	<cite class="feed">from <?php the_author_posts_link()?><?php
206	285	if (is_syndicated() and (get_the_author() !== get_syndication_source())):
207	286	echo ' @ <a href="'; the_syndication_source_link(); echo '">';
		@@ -208,9 +287,9 @@
208	287	the_syndication_source();
209	288	echo '</a>';
210	289	endif; ?></cite>
211	290
212		-For more information on template functions, see Template API below.
	291	+For more information on template functions, see [Template API][].
213	292
214	293	### Categories ###
215	294
216	295	WordPress allows for posts to be placed in categories. Each syndicated post
		@@ -220,34 +299,31 @@
220	299
221	300	1. Categories (or "tags") that the original author placed the post in on
222	301	her blog
223	302
224		-2. Categories that you set explicitly for each feed using the `cats`
225		- feed setting. For example, if you wanted all the posts from Alas, A Blog
226		- to be placed in the "Pacific Northwest" category and the "Cartoonists"
227		- category (in addition to any categories that they were placed in on
228		- Alas, A Blog), you could do this by going to Links --> Syndicated,
229		- clicking the "Edit" link for Alas, A Blog, and adding the following line
230		- to the Link Notes section:
231		-
232		- cats: Pacific Northwest:Cartoonists
	303	+2. Categories that you set explicitly for each feed using the
	304	+ Categories checkbox under Links --> Syndicated --> Edit. For
	305	+ example, if you wanted all the posts from Alas, A Blog to be placed in
	306	+ the "Pacific Northwest" category and the "Cartoonists" category (*in
	307	+ addition to* any other categories that they were placed in on Alas, A
	308	+ Blog), you could do this by creating the categories, going to **Links
	309	+ --> Syndicated**, clicking the "Edit" link for Alas, A Blog, and
	310	+ checking those two categories under the checkbox captioned "Categories."
233	311
234		- (The colon separates one category name from the next.)
235		-
236	312	Given the list of category names, FeedWordPress looks for categories in the
237	313	WordPress database with the same name as either (1) the category name, or
238	314	(2) one of the "aliases" listed in the category description.
239	315
240		-__Aliases:__ Different often authors use slightly different names for
241		-categories that mean the same thing (contributors to Feminist Blogs, for
242		-example, used categories including "Feminism", "feministy stuff",
243		-"Women's Issues", "Gender Issues", "Gender Equality", and so on). If you want
244		-FeedWordPress to treat one category name as a synonym for another, you can
245		-do so by creating an "alias" for the category. For example, to make
246		-FeedWordPress treat posts that are placed in the category "feministy stuff" as
247		-if they had been placed in the category "Feminism", go to Manage --> Categories,
248		-find the category "Feminism" and click the "Edit" link for it, and then add
249		-the following to the Description field, on a line by itself:
	316	+__Aliases:__ Different often authors use slightly different names for categories
	317	+that mean the same thing (contributors to Feminist Blogs, for example, used
	318	+categories including "Feminism", "feministy stuff", "Women's Issues", "Gender
	319	+Issues", "Gender Equality", and so on). If you want FeedWordPress to treat one
	320	+category name as a synonym for another, you can do so by creating an "alias" for
	321	+the category. For example, to make FeedWordPress treat posts that are placed in
	322	+the category "feministy stuff" as if they had been placed in the category
	323	+"Feminism", go to Manage --> Categories, find the category "Feminism" and
	324	+click the "Edit" link for it, and then add the following to the Description
	325	+field, on a line by itself:
250	326
251	327	a.k.a.: feministy stuff
252	328
253	329	You can add as many aliases as you like. You can also add any other text that
		@@ -253,38 +329,38 @@
253	329	You can add as many aliases as you like. You can also add any other text that
254	330	you like to the Description without interfering with FeedWordPress's ability to
255	331	use the aliases. Each alias must be on a line by itself.
256	332
257		-__Unfamiliar categories:__ By default, if one of the category names that a
258		-newsfeed provides is unfamiliar -- that is, if there is not yet any category
259		-with that name (or with that name as an alias) in your WordPress database --
260		-then by default FeedWordPress will automatically create a new category with
261		-that name and place the current post in it. The default behavior can be changed,
262		-using either the global settings in Options --> Syndication or the
263		-`unfamiliar categories` feed setting (see Feed Settings above), so that unfamiliar
264		-categories will not be added to the database. If you choose to disable the
265		-creation of new categories, you can also choose whether or not FeedWordPress
	333	+__Unfamiliar categories:__ If one of the category names that a newsfeed provides
	334	+is unfamiliar -- that is, if there is not yet any category in your WordPress
	335	+database that either has that name, or uses that name as an alias -- then by
	336	+default FeedWordPress will automatically create a new category with that name
	337	+and place the current post in it. The default behavior can be changed so that
	338	+unfamiliar categories will not be added to the database, using the
	339	+Unfamiliar categories setting, either for all feeds (under **Options -->
	340	+Syndication*) or for one particular feed* (under Links --> Syndicated).
	341	+
	342	+If you choose to disable the creation of new categories, either for all feeds or
	343	+for one particular feed, then you can also choose whether or not FeedWordPress
266	344	should syndicate posts that do not match any of the categories that are
267		-currently in the database.
	345	+currently in the database. This allows you to do some simple filtering of posts
	346	+by category: if you want to your blog to syndicate only the posts in one
	347	+particular category from a feed that has several categories, you could do so by
	348	+creating a category by that name, adding the new feed(s), and then setting
	349	+Unfamiliar categories under Links --> Syndicated --> Edit to "don't
	350	+create new categories and don't syndicate posts unless they match at least one
	351	+familiar category".
268	352
269		-One of the uses of this feature is filtering posts by category: if you want to
270		-your blog to syndicate only the posts in one particular category from a feed
271		-that has several categories, you could do so by creating a category by that
272		-name, adding the new feed(s), and then adding the following line to the Link
273		-Notes section of the feed(s) that you want to filter:
274		-
275		- unfamiliar categories: filter
276		-
277	353	Since only posts in categories that are in your database will be included, and
278	354	only the category or categories that you wanted posts from has been added to
279		-your database, this will filter out all the posts that aren't in the category
280		-or categories that you defined ahead of time. (Similarly, you could set up
	355	+your database, this will filter out all the posts that aren't in the category or
	356	+categories that you defined ahead of time. (Similarly, you could set up
281	357	FeedWordPress so that all the feeds are filtered by author by creating the set
282	358	of users named after the authors you want to syndicate, and then setting the
283		-default behavior for all feeds at Options --> Syndication).
	359	+default behavior for all feeds at Options --> Syndication).
284	360
285	361	If you need a category filter with more complex logic, you can always create a
286		-`syndicated_item` filter in PHP (see Plugin API below) that manipulates the
	362	+`syndicated_item` filter in PHP (see [Plugin API][]) that manipulates the
287	363	`['categories']` array of a syndicated item.
288	364
289	365	### Authors ###
290	366
		@@ -292,10 +368,10 @@
292	368	(If a feed doesn't, then FeedWordPress will create an author's name based on
293	369	the title of the feed from which the item was taken.) This information is used
294	370	to determine the WordPress user that the post will be attributed to. Given the
295	371	name of the author, FeedWordPress looks for authors in the WordPress database
296		-with the same name as either (1) their login, (2) their first name, (3) their
297		-nickname, (4) their full name, or (5) one of the "aliases" listed in the
	372	+with the same name as either (1) their login, (2) their display name, (3) their
	373	+e-mail address (if given), or (4) one of the "aliases" listed in the
298	374	user's profile.
299	375
300	376	__Aliases:__ If there is an author who posts under more than one name (for
301	377	example, one of our contributors at [Feminist Blogs][] posts on several
		@@ -302,13 +378,13 @@
302	378	different blogs, sometimes using her full name and sometimes using only her
303	379	first name), then you can ensure that FeedWordPress will attribute those posts
304	380	to the same author by creating "aliases" for the author. For example, to make
305	381	FeedWordPress treat posts by "Joseph Cardinal Ratzinger" and posts by "Pope
306		-Benedict XVI" as having the same author, go to Users --> Authors & Users, click
307		-on the "Edit" link for Pope Benedict XVI, and add a line like this to the
	382	+Benedict XVI" as having the same author, go to Users --> Authors & Users,
	383	+click on the "Edit" link for Pope Benedict XVI, and add a line like this to the
308	384	Profile text:
309	385
310		- a.k.a.: Joseph Cardinal Ratzinger
	386	+ a.k.a.: Joseph Cardinal Ratzinger
311	387
312	388	You can add as many aliases as you like. You can also add any other text that
313	389	you like to the Profile without interfering with FeedWordPress's ability to use
314	390	the aliases. Each alias must be on a line by itself.
		@@ -317,207 +393,31 @@
317	393	unfamiliar -- that is, if there is no-one with that name registered in the
318	394	WordPress author's database -- then by default FeedWordPress will automatically
319	395	create a new user account with the given name and attribute the post to the new
320	396	user. The default behavior can be changed, using either the global settings in
321		-Options --> Syndication or the `unfamiliar author` feed setting (see Feed
322		-Settings above), so that posts by unfamiliar authors will either be attributed
323		-to a default author (instead of creating a new user account to attribute them
324		-to), or filtered out and not syndicated at all.
	397	+Options --> Syndication or the [feed settings][] under **Links -->
	398	+Syndicated --> Edit**, so that posts by unfamiliar authors will either be
	399	+attributed to a default author (instead of creating a new user account to
	400	+attribute them to), or filtered out and not syndicated at all.
325	401
326		-One of the uses of this feature is filtering posts by author: if you want to
	402	+One of the uses of this feature is to filtering posts by author: if you want to
327	403	your blog to syndicate only the posts by one particular author from a feed that
328	404	has several authors, you could do so by creating a user account with that
329		-author's name, adding the new feed(s), and then adding the following line to the
330		-Link Notes section of the feed(s) that you want to filter:
331		-
332		- unfamiliar author: filter
333		-
334		-Since only posts by authors that are in your database will be included, and only
335		-the author that you wanted posts from has been added to your database, this will
	405	+author's name, adding the new feed(s), and then setting Unfamiliar authors
	406	+under Links --> Syndicated --> Edit to "don't syndicate the post". Since
	407	+only posts by authors that are in your database will be included, and only the
	408	+author that you wanted posts from has been added to your database, this will
336	409	filter out posts by anyone else on the feeds with that setting. (Similarly, you
337	410	could set up FeedWordPress so that all the feeds are filtered by author by
338	411	creating the set of users named after the authors you want to syndicate, and
339		-then setting the default behavior for all feeds at Options --> Syndication).
	412	+then setting the default behavior for all feeds at **Options -->
	413	+Syndication**).
340	414
341	415	If you need an author filter with more complex logic than this allows, you can
342		-always create a `syndicated_item` filter in PHP (see Plugin API below) that
	416	+always create a `syndicated_item` filter in PHP (see [Plugin API][]) that
343	417	manipulates the `['author_name']` or `['dc']['creator']` elements of a
344	418	syndicated item.
345	419
346		-Special Feed Settings
347		-Most feed settings (see Feed Settings above) have no effect on FeedWordPress
348		-itself, but can be useful because they can be accessed from templates using the
349		-`get_feed_meta()` template function in a post context (see Feed Settings above
350		-for an example). However, you can use some feed settings to affect how
351		-FeedWordPress will process posts from that particular feed. Currently, these
352		-special settings are:
353		-
354		-- `cats:` a colon-separated list of default categories for any post coming
355		- from this feed. So, for example, a this line in its Notes section:
356		-
357		- cats: computers:web
358		-
359		- ... will make FeedWordPress place any posts syndicated from that feed in
360		- the "computers" and "web" categories. Note that by default,
361		- FeedWordPress will place them in those categories in addition to any
362		- categories that the author of the post put them in on her own website.
363		- If you want to place posts from a feed only in the categories you
364		- explicitly set, then you should use the `cats` setting together with
365		- the `unfamiliar categories` setting. (See Categories above and
366		- `unfamiliar categories` below for the nitty-gritty.)
367		-
368		-- `hardcode name: (yes\|no)`
369		-
370		- By default, FeedWordPress updates the value of the Link Name field
371		- automatically to reflect the title that is reported by a syndicated
372		- feed--so that if one of your contributors changes the title of her
373		- website, the change will be reflected on your Contributors list after
374		- the next update. If you want to stop this behavior (so that you can
375		- set the title of a Contributor link manually -- e.g. so that you can use
376		- an abbreviated form for reasons of space), you can change the default
377		- behavior for all feeds using the settings in Options --> Syndication.
378		- If you want to override the default behavior for only one feed, you
379		- can use the `hardcode name` feed setting. If FeedWordPress updates the
380		- title of all feeds by default, but you wish to use a manually-set title
381		- for one particular feed, you can add a line like this to the Link Notes
382		- section of the feed that you want to manually set the title for:
383		-
384		- hardcode name: yes
385		-
386		- Similarly, if FeedWordPress uses your manually-entered titles for all
387		- feeds by default, but you wish to use an automatically updated title for
388		- one particular feed, you can add a line like this to the Link Notes
389		- section of the feed that you want to manually set the title for:
390		-
391		- hardcode name: no
392		-
393		- If `hardcode name` is absent, or set to a value other than `yes` or
394		- `no`, FeedWordPress will follow the default behavior set under
395		- Options --> Syndication.
396		-
397		-- `hardcode description: (yes\|no)`
398		-
399		- By default, FeedWordPress updates the value of the Link Description
400		- field automatically to reflect the tagline or description that is
401		- reported by a syndicated feed--so that if one of your contributors
402		- changes the tagline for her website, the change will be reflected on
403		- your Contributors list after the next update. If you want to stop this
404		- behavior (so that you can set the taglien of a Contributor link manually
405		- -- e.g. so that you can use it to provide information of another sort or
406		- use an abbreviated form for reasons of space), you can change the
407		- default behavior for all feeds using the settings in Options -->
408		- Syndication. If you want to override the default behavior for only one
409		- feed, you can use the `hardcode description` feed setting. If
410		- FeedWordPress updates the description of all feeds by default, but you
411		- wish to use a manually-set description for one particular feed, you can
412		- add a line like this to the Link Notes section of that particular feed:
413		-
414		- hardcode description: yes
415		-
416		- Similarly, if FeedWordPress uses your manually-entered descriptions for
417		- all feeds by default, but you wish to use an automatically updated
418		- description for one particular feed, you can add a line like this to the
419		- Link Notes section of that particular feed:
420		-
421		- hardcode description: no
422		-
423		- If `hardcode description` is absent, or set to a value other than `yes`
424		- or `no`, FeedWordPress will follow the default behavior set under
425		- Options --> Syndication.
426		-
427		-- `hardcode categories: (yes\|no)`
428		-
429		- This setting has been deprecated. If set to `yes` it is now treated
430		- as equivalent to `unfamiliar categories: default`. (See below.)
431		-
432		-- `post status:` sets the default post status for posts from this feed
433		- This can be 'publish', 'draft', or 'private'. By default, it is set to
434		- 'publish' (syndicated posts go online immediately).
435		-
436		-- `comment status:` sets the default status for comments on posts
437		- syndicated from this feed. By default, all comments on syndicated posts
438		- are closed, but you can set it to 'open', 'closed', or 'registered_only'
439		- for particular feeds.
440		-
441		-- `ping status:` sets the default status for receiving TrackBack and
442		- PingBack pings on posts syndicated from this feed. By default,
443		- syndicated posts are closed to pings, but you can set this to 'open' or
444		- 'closed' for particular feeds.
445		-
446		-- `unfamiliar authors: (create\|default\|filter)`
447		-
448		- By default, FeedWordPress creates new author accounts whenever it finds
449		- a new post that is by an author whose name is not already in the
450		- WordPress database, and uses that account for this post and any future
451		- posts by an author of that name. FeedWordPress also allows you to
452		- attribute posts by unfamiliar authors to a default user account
453		- (currently, this means the System Administrator account), instead of
454		- creating a new author, or simply not to syndicate posts by unfamiliar
455		- authors (thus only syndicating posts by authors who are already in the
456		- database).
457		-
458		- Which of these FeedWordPress does by default can be set using the
459		- settings in Options --> Syndicated. You can also override the default
460		- behavior for specific feeds by adding the `unfamiliar author` feed
461		- setting to the Link Notes section of a feed. For example, to ensure that
462		- FeedWordPress filters out posts by unfamiliar authors for one particular
463		- feed, add the setting:
464		-
465		- unfamiliar author: filter
466		-
467		- To ensure that FeedWordPress assigns posts by unfamiliar authors to the
468		- default user account instead of creating a new user account, add the
469		- setting:
470		-
471		- unfamiliar author: default
472		-
473		- If you changed the default behavior under Options --> Syndicated but
474		- want to ensure that FeedWordPress creates new author accounts for
475		- unfamiliar authors on one specific feed, add the setting:
476		-
477		- unfamiliar author: create
478		-
479		- If the setting is anything other than `create`, `default`, or `filter`,
480		- FeedWordPress will ignore the setting and follow the default behavior
481		- that you specified under Options --> Syndication.
482		-
483		-- `unfamiliar categories: (create\|default\|filter)`
484		-
485		- By default, FeedWordPress creates categories whenever it finds a new
486		- post that is placed in categories whose names are not already in the
487		- WordPress database. FeedWordPress allows you to change this behavior,
488		- so that it will not create new category names. It also allows you to
489		- choose whether or not posts must match at least one familiar category
490		- to be syndicated at all.
491		-
492		- Which of these FeedWordPress does by default can be set using the
493		- settings in Options --> Syndicated. You can also override the default
494		- behavior for specific feeds by adding the `unfamiliar categories` feed
495		- setting to the Link Notes section of a feed. For example, to ensure
496		- that, when adding new posts from one particular feed, FeedWordPress
497		- does not create new categories, and filters out any posts that don't
498		- match at least one of the categories that you have already defined,
499		- add the setting:
500		-
501		- unfamiliar categories: filter
502		-
503		- To ensure that FeedWordPress does not create new categories, but
504		- will still syndicate categories even if they don't match any of the
505		- pre-defined categories, add the following to the feed settings:
506		-
507		- unfamiliar categories: default
508		-
509		- If you changed the default behavior under Options --> Syndicated but
510		- want to ensure that FeedWordPress creates new categories for posts
511		- from one particular feed, add the setting:
512		-
513		- unfamiliar categories: create
514		-
515		- If the setting is anything other than `create`, `default`, or `filter`,
516		- FeedWordPress will ignore the setting and follow the default behavior
517		- that you specified under Options --> Syndication.
518		-
519	420	Template API
520	421	------------
521	422	When activated, FeedWordPress makes the following functions available for use by
522	423	themes/templates:
		@@ -529,9 +429,9 @@
529	429	* ``get_syndication_permalink()``: in a post context, returns the URI of
530	430	the permalink for this post on the website it was syndicated from
531	431
532	432	* ``the_syndication_permalink()``: in a post context, outputs the value
533		- returned by ``get_syndication_permalink()``
	433	+ returned by [``get_syndication_permalink()``][get_syndication_permalink]
534	434
535	435	* ``get_syndication_source_link()``: in a post context, returns the URI of
536	436	the front page (not the feed) of the website this post was syndicated
537	437	from
		@@ -536,9 +436,10 @@
536	436	the front page (not the feed) of the website this post was syndicated
537	437	from
538	438
539	439	* ``the_syndication_source_link()``: in a post context, outputs the URI
540		- returned by ``get_syndication_source_link()``
	440	+ returned by
	441	+ [``get_syndication_source_link()``][get_syndication_source_link]
541	442
542	443	* ``get_syndication_source()``: in a post context, returns the
543	444	human-readable title of the website that a syndicated post was
544	445	syndicated from
		@@ -543,15 +444,15 @@
543	444	human-readable title of the website that a syndicated post was
544	445	syndicated from
545	446
546	447	* ``the_syndication_source()``: in a post context, outputs the value
547		- returned by ``get_syndication_source()``
	448	+ returned by [``get_syndication_source()``][get_syndication_source]
548	449
549	450	* ``get_syndication_feed():`` in a post context, returns the URI of the
550	451	feed (not the front page) that this post was syndicated from
551	452
552	453	* ``the_syndication_feed()``: in a post context, outputs the value
553		- returned by ``get_syndication_feed()``
	454	+ returned by [``get_syndication_feed()``][get_syndication_feed]
554	455
555	456	* ``get_feed_meta($key)``: in a post context, returns the value, if any,
556	457	of the feed setting ``$key`` for the feed that this post was syndicated
557	458	from
		@@ -557,21 +458,21 @@
557	458	from
558	459
559	460	By default, FeedWordPress also places a filter on the standard functions
560	461	``get_permalink()`` and ``the_permalink()`` that substitutes the URI returned by
561		-``get_syndication_permalink()`` for the URI generated by WordPress. This means
562		-that by default the permalinks listed on your website and in your newsfeed will
563		-link to the location of the posts on the source website, not to their location
564		-on your website. You can switch this behavior on or off at Options -->
565		-Syndication in the WordPress Dashboard.
	462	+[``get_syndication_permalink()``][get_syndication_permalink] for the URI
	463	+generated by WordPress. This means that by default the permalinks listed on your
	464	+website and in your newsfeed will link to the location of the posts on the
	465	+source website, not to their location on your website. You can switch this
	466	+behavior on or off at Options --> Syndication in the WordPress Dashboard.
566	467
567		-### Plugin API ###
568		-
	468	+Plugin API
	469	+----------
569	470	FeedWordPress creates five hooks through the WordPress plugin architecture that
570	471	you can plug in to using PHP WordPress plugins, to supplement ordinary
571	472	FeedWordPress behavior, or to filter posts according to criteria that you set.
572	473	The hooks are the action ``feedwordpress_update``, the action
573		-``feedwordpress_check_feed``, the action ``feedwordpress_update_complete``, the
	474	+``feedwordpress_check_feed``, the action ``feedwordpress_update_complete``, the
574	475	filter ``syndicated_item``, the filter ``syndicated_post``, the action
575	476	``post_syndicated_item``, and the action ``update_syndicated_item``.
576	477
577	478	For more information, see <http://projects.radgeek.com/feedwordpress/api>.
		@@ -577,12 +478,13 @@
577	478	For more information, see <http://projects.radgeek.com/feedwordpress/api>.
578	479
579	480	License
580	481	-------
581		-The FeedWordPress plugin is copyright (c) 2005 by Charles Johnson. It uses code
582		-derived or translated from:
	482	+The FeedWordPress plugin is copyright (c) 2005-2007 by Charles Johnson. It uses
	483	+code derived or translated from:
583	484
584	485	- [wp-rss-aggregate.php][] by [Kellan Elliot-McCrea](kellan@protest.net)
	486	+- [MagpieRSS][] by [Kellan Elliot-McCrea](kellan@protest.net)
585	487	- [HTTP Navigator 2][] by [Keyvan Minoukadeh](keyvan@k1m.com)
586	488	- [Ultra-Liberal Feed Finder][] by [Mark Pilgrim](mark@diveintomark.org)
587	489
588	490	according to the terms of the [GNU General Public License][].
		@@ -587,11 +489,11 @@
587	489
588	490	according to the terms of the [GNU General Public License][].
589	491
590	492	This program is free software; you can redistribute it and/or modify it under
591		-the terms of the [GNU General Public License][] as published by the Free Software
592		-Foundation; either version 2 of the License, or (at your option) any later
593		-version.
	493	+the terms of the [GNU General Public License][] as published by the Free
	494	+Software Foundation; either version 2 of the License, or (at your option) any
	495	+later version.
594	496
595	497	This program is distributed in the hope that it will be useful, but WITHOUT ANY
596	498	WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
597	499	PARTICULAR PURPOSE. See the GNU General Public License for more details.
		@@ -596,8 +498,10 @@
596	498	WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
597	499	PARTICULAR PURPOSE. See the GNU General Public License for more details.
598	500
599	501	[wp-rss-aggregate.php]: http://laughingmeme.org/archives/002203.html
	502	+ [MagpieRSS]: http://magpierss.sourceforge.net/
600	503	[HTTP Navigator 2]: http://www.keyvan.net/2004/11/16/http-navigator/
601	504	[Ultra-Liberal Feed Finder]: http://diveintomark.org/projects/feed_finder/
	505	+
602	506	[GNU General Public License]: http://www.gnu.org/copyleft/gpl.html
603	507