feedwordpress / readme.txt

readme.txt in FeedWordPress 2008.1105, at readme.txt

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