feedwordpress / readme.txt

readme.txt in FeedWordPress 0.993, at readme.txt

158 lines 7.5 KB

Raw Download Zip

1	=== FeedWordPress ===
2	Contributors: Charles Johnson
3	Donate link: http://projects.radgeek.com/feedwordpress/
4	Tags: syndication, aggregation, feed, atom, rss
5	Requires at least: 1.5
6	Tested up to: 2.5.1
7	Stable tag: 0.993
8
9	FeedWordPress syndicates content from feeds you choose into your WordPress weblog.
10
11	== Description ==
12
13	* Author: [Charles Johnson](http://radgeek.com/contact)
14	* Project URI: <http://projects.radgeek.com/feedwordpress>
15	* License: GPL 2. See License below for copyright jots and tittles.
16
17	FeedWordPress is an Atom/RSS aggregator for WordPress. It syndicates content
18	from feeds that you choose into your WordPress weblog; if you syndicate several
19	feeds then you can use WordPress's posts database and templating engine as the
20	back-end of an aggregation ("planet") website. It was developed, originally,
21	because I needed a more flexible replacement for [Planet](http://www.planetplanet.org/)
22	to use at [Feminist Blogs](http://feministblogs.org/).
23
24	FeedWordPress is designed with flexibility, ease of use, and ease of
25	configuration in mind. You'll need a working installation of WordPress or
26	WordPress MU (versions [2.5][], [2.3][], [2.2][], [2.1][], [2.0][] or [1.5][]),
27	and also FTP or SFTP access to your web host. The ability to create cron jobs on
28	your web host is helpful but not absolutely necessary. You don't need to tweak
29	any plain-text configuration files and you don't need shell access to your web
30	host to make it work. (Although, I should point out, web hosts that don't
31	offer shell access are bad web hosts.)
32
33	[2.5]: http://codex.wordpress.org/Version_2.5
34	[2.3]: http://codex.wordpress.org/Version_2.3
35	[2.2]: http://codex.wordpress.org/Version_2.2
36	[2.1]: http://codex.wordpress.org/Version_2.1
37	[2.0]: http://codex.wordpress.org/Version_2.0
38	[1.5]: http://codex.wordpress.org/Version_1.5
39
40	== Installation ==
41
42	To use version 0.993 of FeedWordPress, you will need:
43
44	* an installed and configured copy of WordPress version 2.3.x, 2.2.x,
45	2.1.x, 2.0.x, or 1.5.x. (FeedWordPress will also work with the
46	equivalent versions of WordPress MU.)
47
48	* FTP or SFTP access to your web host
49
50	= New Installations =
51
52	1. Download the FeedWordPress archive in zip or gzipped tar format and
53	extract the files on your computer.
54
55	2. Create a new directory named `feedwordpress` in the `wp-content/plugins`
56	directory of your WordPress installation. Use an FTP or SFTP client to
57	upload the contents of your FeedWordPress archive to the new directory
58	that you just created on your web host.
59
60	3. Upgrade the copy of MagpieRSS packaged with WordPress by installing the
61	new copies of `rss.php` and `rss-functions.php` into the `wp-includes`
62	directory of your FeedWordPress installation. These files are stored in
63	the `MagpieRSS-upgrade` directory of your FeedWordPress archive. Strictly
64	speaking, upgrading MagpieRSS is optional; FeedWordPress will run
65	correctly without the upgrade. But if you hope to take advantage of
66	numerous bug fixes, or support for Atom 1.0, multiple post categories,
67	RSS enclosures, or multiple character encodings, then you need to
68	install the upgrade.
69
70	4. Log in to the WordPress Dashboard and activate the FeedWordPress plugin.
71
72	5. Once the plugin is activated, you can go to Syndication --> Options
73	and set (1) the link category that FeedWordPress will syndicate links
74	from (by default, "Contributors"), and (2) whether FeedWordPress will
75	use automatic updates or only manual updates.
76
77	5. Go to the main Syndication page to set up the list of sites that
78	you want FeedWordPress to syndicate onto your blog.
79
80	= Upgrades =
81
82	To upgrade an existing installation of FeedWordPress to version 0.993:
83
84	1. Download the FeedWordPress archive in zip or gzipped tar format and
85	extract the files on your computer.
86
87	2. If you are upgrading from version 0.98 or earlier, then you need to
88	create a new directory named `feedwordpress` in the `wp-content/plugins`
89	directory of your WordPress installation, and you also need to delete
90	your existing `wp-content/update-feeds.php` and
91	`wp-content/plugins/feedwordpress.php` files. The file structure for
92	FeedWordPress has changed and the files from your old version will not
93	be overwritten, which could cause conflicts if you leave them in place.
94
95	3. Upload the new PHP files to `wp-content/plugins/feedwordpress`,
96	overwriting any existing FeedWordPress files that are there. Also be
97	sure to upgrade the MagpieRSS module by uploading `rss.php` and
98	`rss-functions.php` from the `MagpieRSS-upgrade` directory in your
99	archive to the `wp-includes` directory of your WordPress installation.
100
101	3. If you are upgrading from version 0.96 or earlier, immediately log
102	in to the WordPress Dashboard, and go to Options --> Syndicated.
103	Follow the directions to launch the database upgrade procedure. The new
104	versions of FeedWordPress incorporate some long-needed improvements, but
105	old meta-data needs to be updated to prevent duplicate posts and other
106	possible maladies. If you're upgrading an existing installation, updates
107	and FeedWordPress template functions will not work until you've done
108	the upgrade. Then take a coffee break while the upgrade runs. It should,
109	hopefully, finish within a few minutes even on relatively large
110	databases.
111
112	4. If you are upgrading from version 0.98 or earlier, note that the old
113	`update-feeds.php` has been eliminated in favor of a (hopefully) more
114	humane method for automatic updating. If you used a cron job for
115	scheduled updates, it will not work anymore, but there is another,
116	simpler method which will. See [Setting Up Feed Updates](http://projects.radgeek.com/feedwordpress/install/#setting-up-feed-updates)
117	to get scheduled updates back on track.
118
119	5. Enjoy your new installation of FeedWordPress.
120
121	== Using and Customizing FeedWordPress ==
122
123	FeedWordPress has many options which can be accessed through the WordPress
124	Dashboard, and a lot of functionality accessible programmatically through
125	WordPress templates or plugins. For further documentation of the ins and
126	outs, see the documentation at the [FeedWordPress project homepage][].
127
128	[FeedWordPress project homepage]: http://projects.radgeek.com/feedwordpress/
129
130	== License ==
131
132	The FeedWordPress plugin is copyright © 2005-2007 by Charles Johnson. It uses
133	code derived or translated from:
134
135	- [wp-rss-aggregate.php][] by [Kellan Elliot-McCrea](kellan@protest.net)
136	- [MagpieRSS][] by [Kellan Elliot-McCrea](kellan@protest.net)
137	- [HTTP Navigator 2][] by [Keyvan Minoukadeh](keyvan@k1m.com)
138	- [Ultra-Liberal Feed Finder][] by [Mark Pilgrim](mark@diveintomark.org)
139
140	according to the terms of the [GNU General Public License][].
141
142	This program is free software; you can redistribute it and/or modify it under
143	the terms of the [GNU General Public License][] as published by the Free
144	Software Foundation; either version 2 of the License, or (at your option) any
145	later version.
146
147	This program is distributed in the hope that it will be useful, but WITHOUT ANY
148	WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
149	PARTICULAR PURPOSE. See the GNU General Public License for more details.
150
151	[wp-rss-aggregate.php]: http://laughingmeme.org/archives/002203.html
152	[MagpieRSS]: http://magpierss.sourceforge.net/
153	[HTTP Navigator 2]: http://www.keyvan.net/2004/11/16/http-navigator/
154	[Ultra-Liberal Feed Finder]: http://diveintomark.org/projects/feed_finder/
155
156	[GNU General Public License]: http://www.gnu.org/copyleft/gpl.html
157
158