Changeset 7333

Show
Ignore:
Timestamp:
01/14/07 01:00:49 (18 months ago)
Author:
alexkingorg
Message:

readme content

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • link-harvest/trunk/README.txt

    r7103 r7333  
    1 Coming soon... 
     1=== Share This === 
     2Tags: link, links, report, reporting, blogroll 
     3Contributors: alexkingorg 
     4Requires at least: 2.0 
     5Tested up to: 2.0.5 
     6Stable tag: 1.0 
     7 
     8Link 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 
     121. Download the plugin archive and expand it (you've likely already done this). 
     132. Put the 'link-harvest.php' file into your wp-content/plugins/ directory. 
     143. Go to the Plugins page in your WordPress Administration area and click 'Activate' for Link Harvest. 
     154. 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 
     20Once 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 
     22To 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 
     24Note, harvest actions must be enabled (on the options page) to do a harvest. Harvest actions are automatically disabled after a completed harvest. 
     25 
     26Once 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 
     31Your 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 
     37= Token Method = 
     38 
     39The 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: 
     40 
     41`###linkharvest###` 
     42 
     43and your links list will appear in this place in the page/post. 
     44 
     45 
     46= Template Tag Method = 
     47 
     48You can always add a template tag to your theme (in a page template perhaps) to show your links list: 
     49 
     50`<?php aklh_show_harvest($count = 50); ?>` 
     51 
     52 
     53== Adding a links list/blogroll to your sidebar == 
     54 
     55To add a links list to your sidebar (like a blogroll), you can use the following template tag: 
     56 
     57`<?php aklh_top_links($count = 10); ?>` 
     58 
     59 
     60== Known Issues == 
     61 
     62= Token Processing Time = 
     63 
     64Using the token method to show your links list will add *very* minor additional processing to each post display on your site. 
     65 
     66 
     67== Frequently Asked Questions == 
     68 
     69= My harvest got screwed up, how do I start over? = 
     70 
     71You 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). 
     72 
     73 
     74= Is there a way to fill empty page titles? = 
     75 
     76Yes, simply go to the Link Harvest options page and use the links under the 'Backfill Empty Titles' heading. 
     77 
     78 
     79= Anything else? = 
     80 
     81That about does it - enjoy! 
     82 
     83--Alex King 
     84 
     85http://alexking.org/projects/wordpress