| Current File : /home/lifechur/carp-wp-2.0.9/README.html |
<html>
<head>
<title>CaRP/WP Users Manual</title>
<style type="text/css">
body {
background-color;#eee;
margin:0;
padding:0;
}
#everything {
position:relative;
top:0;
left:50%;
width:640px;
margin-left:-320px;
}
#allstyle {
position:relative;
border:1px solid #ccc;
background-color:#fff;
padding:12px 20px 12px 70px;
}
h1, h2 { margin-left:-50px; }
h3, ol, ul { margin-left:-25px; }
code {
font-weight:bold;
color:#063;
}
</style>
</head>
<body><div id="everything"><div id="allstyle">
<h1>CaRP/WP Users Manual</h1>
<p>© 2008-12 Antone Roundy</p>
<p>CaRP/WP is a WordPress plugin that, working with CaRP,
enables you to display RSS feeds, including Amazon.com
affiliate feeds and YouTube feeds, in your WordPress posts
and pages or in a widget.</p>
<h2>Installation</h2>
<ol>
<li>Install <a href="http://www.geckotribe.com/rss/carp/">CaRP</a>.
It does NOT need to be installed inside your WordPress folder --
in fact, it's probably better to install it OUTSIDE of your WordPress folder.
Be sure to copy the code that the installer script gives you at the end.</li>
<li>In this plugin's "extras" folder, you'll find carp-wp-theme.php, carp-wp-widget-theme.php and carp-wp-youtube-theme.php.
Upload them to your CaRP themes folder.</li>
<li>Upload the 'carp-wp' folder and its contents to the '/wp-content/plugins/' folder.</li>
<li>Activate the plugin through the 'Plugins' menu in WordPress</li>
<li>In the WordPress 'Settings' menu ('Options' in older versions of WordPress),
'CaRP/WP' submenu, enter the path to CaRP that the installer script gave you.
This should include everything inside the quotation marks on the line that begins with 'require_once'.</li>
<li>If you wish to display Amazon.com affiliate feeds, enter your Associate Tag.</li>
<li>Update any of the other options you wish to change.</li>
</ol>
<h2>Upgrading</h2>
<ol>
<li>Upload all of the files in the carp-wp folder to the carp-wp folder in your WordPress themes folder.</li>
<li>If the locations of any of the files have changed, delete the old files.</li>
<li>If there are any new theme files that you haven't already uploaded to your CaRP themes folder, upload them.</li>
<li>If upgrading from a version of CaRP/WP prior to 2.0, go to your WordPress 'Settings' menu,
'CaRP/WP' submenu, and save your settings.
Do this even if you don't make any changes in order to store new settings that have been added to CaRP/WP.</li>
</ol>
<h2>Frequently Asked Questions</h2>
<h3>How do I display a feed?</h3>
<p>Enter the following code in your post or page content,
substituting in the URL of the desired feed:</p>
<code>[carpwp:feed{http://example.com/feed.rss}][/carpwp]</code>
<h3>How do I aggregate multiple feeds together?</h3>
<p>Enter the following code in your post or page content,
substituting in the URLs of the desired feeds, and choosing
a unique "groupkey" for each output formatting
configuration. Note that it is only necessary to specify
the encoding of the feed if CaRP is unable to determine it
automatically.</p>
<code>[carpwp:aggregate{groupkey}]<br />
feed={http://example.com/feed1.rss}<br />
feed={http://example.com/feed2.rss},UTF-8<br />
feed={http://example.com/feed3.rss}<br />
[/carpwp]</code>
<p>If you have CaRP version 4.0 or higher, you may also use
the "interleave" style of aggregating as follows:</p>
<code>[carpwp:interleave{groupkey}]<br />
feed={http://example.com/feed1.rss}<br />
feed={http://example.com/feed2.rss},UTF-8<br />
feed={http://example.com/feed3.rss}<br />
[/carpwp]</code>
<h3>How to I display an Amazon.com affilite feed?</h3>
<p>Add the following to your WordPress theme's stylesheet (usually "style.css"):</p>
<code>
.floatimgleft img { float:left; margin-right:15px; }
</code>
<p>Or, alternatively, add this code to your post or page content:</p>
<code>
<style type="text/css"><!--<br/>
.floatimgleft img { float:left; margin-right:15px; }<br/>
//--><br/>
</style>
</code>
<p>Enter the following code in your post or page content,
substituting in the keywords to use to perform the search:</p>
<code>
<div class="floatimgleft">[carpwp:amazon{keywords go here}][/carpwp]</div>
</code>
<h3>How do I display a YouTube feed</h3>
<p>Note: YouTube support requires CaRP Evolution 4.0 or higher.</p>
<p>To display a tag or keyword-based YouTube feed, enter the
following code in your post or page content, substituting
the keywords or tags you wish to search for:</p>
<code>[carpwp:youtube-tag{keywords go here}][/carpwp]</code>
<p>Or to display videos by particular YouTube user, substitute
their username in the following:</p>
<code>[carpwp:youtube-user{username goes here}][/carpwp]</code>
<h3>How do I customize the output?</h3>
<p>Enter code like the following between the opening and
closing tags ([carpwp:...] and [/carpwp]). The first word
is the name of a CaRP configuration variable, and the value
after the "=" sign is the value to set it to. These names
and values are exactly that same as are used with CaRP's
"CarpConf" function. Enter each configuration setting on a
separate line.</p>
<code>cborder=<br />
iorder=link,author,desc<br />
ai=<br /></code>
<p>Note that, as in the last line of the example above, the
"<" character in some HTML tags must be replaced with "&lt;"
because of how WordPress processes content internally.</p>
<p><a href="http://carp.docs.geckotribe.com/full-index.php">Documentation for CaRP's options</a></p>
<p>To customize the display of YouTube feeds, you may either
edit carp-wp-youtube-theme.php (to change your default
YouTube configuration) or enter code like the following
between the opening and closing tags. Specify plugin
settings by entering "youtube-" followed by the setting
name.</p>
<code>youtube-language=de<br />
youtube-show-border=1</code>
<p><a href="http://carp.docs.geckotribe.com/plugins/youtube.php">Documentation for CaRP's YouTube Plugin</a></p>
<h3>How do I set a configuration value containing line breaks?</h3>
<p>Since line breaks don't actually render as line breaks in
HTML, it shouldn't be necessary. However, if you really
need to, you'll have to create a CaRP theme file, specify
the configuration settings using "CarpConf", and load the
theme.</p>
<h3>How do I load a CaRP theme?</h3>
<p>If you wish to load a CaRP theme other than your default
theme, enter the following between the opening and closing
tags, substituting in the name of the desired theme file:</p>
<code>theme=theme-file.php</code>
<h3>How do I override my default Amazon.com settings?</h3>
<p>Enter code like the following between the opening and
closing tags:</p>
<code>amazon_search_type=new<br />
amazon_threshold=3<br />
amazon_no_customer_tags=0</code>
<h3>How do I display a feed in a widget?</h3>
<ol>
<li>In the WordPress 'Appearance' menu (or 'Design' menu in older versions), 'Widgets' submenu,
add the CaRP/WP widget to your blog.</li>
<li>To display the same feed everywhere the widget is
displayed, go to the 'Settings' menu, 'CaRP/WP' submenu and
enter [carpwp:...] tags settings just as described above to
display a feed.</li>
<li>To override the global setting and display something
else on the post page for a particular post, on the editing
page for that post, scroll down to the 'Custom Fields'
section, enter 'carpwp' as the key, and your [carpwp:...]
tags and settings as the value.</li>
</ol>
<h3>How about a full example?</h3>
<p>Okay, here's an example of an Amazon affiliate feed in a
div with some CaRP configuration and setting overrides:</p>
<code><div id="carpamazon">[carpwp:amazon{rss marketing}]
theme=my_amazon_theme.php<br />
cborder=<br />
iorder=link,image,desc<br />
ilinkstyle=font-weight:bold;<br />
ai=<br />
amazon_search_type=new<br />
amazon_threshold=3<br />
[/carpwp]</div></code>
<p>Format the div and its contents by putting something like
this in your theme's CSS stylesheet:</p>
<code>#carpamazon {<br />
float:right;<br />
margin-left:10px;<br />
width:260px;<br />
border:1px solid #ccc;<br />
background-color:#eee;<br />
padding:4px 7px;<br />
}<br />
#carpamazon a {<br />
font-size:120%;<br />
}<br />
#carpamazon img {<br />
float:left;<br />
margin-right:7px;<br />
}</code>
</div></div></body>
</html>