root/link-harvest/trunk/README.txt

Revision 20341, 3.1 kB (checked in by alexkingorg, 9 months ago)

version 1.1 ready for release

Line 
1 === Link Harvest ===
2 Tags: link, links, report, reporting, blogroll
3 Contributors: alexkingorg
4 Requires at least: 2.0
5 Tested up to: 2.3
6 Stable tag: 1.1
7
8 Link Harvest will go through all of your posts and pages and compile a list of all external links. Then it will create a live updating linkroll for you, based on your actual linking activity.
9
10 == Installation ==
11
12 1. Download the plugin archive and expand it (you've likely already done this).
13 2. Put the 'link-harvest.php' file into your wp-content/plugins/ directory.
14 3. Go to the Plugins page in your WordPress Administration area and click 'Activate' for Link Harvest.
15 4. If you are using a version of WP prior to 2.1, upload the included prototype.js to your wp-includes/js/ directory
16
17
18 == Harvesting Your Links ==
19
20 Once you have installed Link Harvest, you need to run a harvest to pull out links from your existing content. Running a harvest is simple, but it takes time. The harvest on my blog (~1250 posts with links) took several hours. You need to leave your browser open during this time for the harvest to complete.
21
22 To run a harvest, go to the Link Harvest options page (Options > Link Harvest), click the button to begin a harvest and follow the steps on the screen.
23
24 Note, harvest actions must be enabled (on the options page) to do a harvest. Harvest actions are automatically disabled after a completed harvest.
25
26 Once you have completed a harvest, any links you add in future posts will be added incrementally as you create the posts.
27
28
29 == Viewing your Link Harvest ==
30
31 Your links list is available to you at all times in the WordPress Admin interface (Dashboard > Link Harvest). You can also choose to show your links list in your blog.
32
33
34 == Showing your Link Harvest ==
35
36 = Token Method =
37
38 The token method is the easier way to show your links list, and is enabled by default. To show your links list, simply add the following to a page or post:
39
40 `###linkharvest###`
41
42 and your links list will appear in this place in the page/post.
43
44
45 = Template Tag Method =
46
47 You can always add a template tag to your theme (in a page template perhaps) to show your links list:
48
49 `<?php aklh_show_harvest($count = 50); ?>`
50
51
52 == Adding a links list/blogroll to your sidebar ==
53
54 To add a links list to your sidebar (like a blogroll), you can use the following template tag:
55
56 `<?php aklh_top_links(); ?>`
57
58 This will show the top 10 links, to show a different number of links set the number like so:
59
60 `<?php aklh_top_links(25); ?>`
61
62
63 == Known Issues ==
64
65 = Token Processing Time =
66
67 Using the token method to show your links list will add *very* minor additional processing to each post display on your site.
68
69
70 == Frequently Asked Questions ==
71
72 = My harvest got screwed up, how do I start over? =
73
74 You can re-harvest your links at any time by clicking the (Re)Harvest All Links button on the Link Harvest options page (Options > Link Harvest).
75
76
77 = Is there a way to fill empty page titles? =
78
79 Yes, simply go to the Link Harvest options page and use the links under the 'Backfill Empty Titles' heading.
80
81
82 = Anything else? =
83
84 That about does it - enjoy!
85
86 --Alex King
87
88 http://alexking.org/projects/wordpress
Note: See TracBrowser for help on using the browser.