

	<h1>Automatic article excerpts</h1>

	<p>The <code>rss_auto_excerpt</code> plugin automatically displays article excerpts even if an excerpt has not been saved with an article.  If for some articles you have defined an excerpt, your own excerpt will be displayed rather than the auto-generated excerpt.  You can also override this feature so that an auto-generated excerpt is always displayed even if an excerpt has been defined.</p>

	<p>There are 4 different options for auto-generating the excerpt from the article body:</p>

	<ul>
		<li><strong>By Length</strong> &#8211; specify the number of characters to display from the article body</li>
		<li><strong>By Words</strong> &#8211; specify the number of words to display from the article body</li>
		<li><strong>By Sentences</strong> &#8211; specify the number of sentences to display from the article body</li>
	</ul>
	<ul>
		<li><strong>By Paragraphs</strong> &#8211; specify the number of paragraphs to display from the article body</li>
	</ul>

	<p>If auto-generating by length, the plugin will ensure that the excerpt does not cutoff in the middle of a word.  If based on the parameters passed into the plugin, the excerpt would not be shorter than the entire article body, the body will be shown instead.</p>

	<h1>Reverse excerpts</h1>

	<p>You can also use the plugin to generate a &#8220;reverse&#8221; excerpt by using the <em>skip</em> variants of the length attributes.  For example:<br />
<pre><code>&#60;txp:if_individual_article&#62;
  &#60;txp:rss_auto_excerpt skipparagraphs=&#34;1&#34; paragraphs=&#34;9999&#34; /&#62;
&#60;txp:else /&#62;
  &#60;txp:rss_auto_excerpt paragraphs=&#34;1&#34; /&#62;
&#60;/txp:if_individual_article&#62;
</code></pre></p>

	<p>This code would display the first paragraph of your article on an article listing page, but on an individual article page, you would see all paragraphs except the first.</p>

	<p>The skip tags could also be used to apply different styling to you first paragraph (i.e., larger font size) or character (i.e., drop caps).</p>

	<p><strong>The plugin will also automatically close any open <span class="caps">HTML</span> tags.</strong>  This will allow for proper handling of lists, bolded or italicized text and other situations.  You can also choose to strip out all <span class="caps">HTML</span> tags from the excerpt.</p>

	<h1>Plugin Attributes</h1>

	<table style="color:#333;font:normal 1em verdana;width: 100%;padding: 0 0 20px;margin: 0 auto 20px;border-bottom:1px solid #666;" id="list">
		<tr>
			<th style="vertical-align:middle;white-space: nowrap;">attribute name</th>
			<th style="vertical-align:middle;white-space: nowrap;">description</th>
			<th style="vertical-align:middle;white-space: nowrap;">default value</th>
			<th style="vertical-align:middle;white-space: nowrap;">example usage</th>
		</tr>
		<tr>
			<td>length</td>
			<td>The number of characters to display from the article body.</td>
			<td> &nbsp;</td>
			<td>length=&#8220;350&#8221;</td>
		</tr>
		<tr>
			<td>words</td>
			<td>The number of words to display from the article body.</td>
			<td> &nbsp;</td>
			<td>words=&#8220;50&#8221;</td>
		</tr>
		<tr>
			<td>sentences</td>
			<td>The number of sentences to display from the article body.</td>
			<td> &nbsp;</td>
			<td>sentences=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>paragraphs</td>
			<td>The number of paragraphs to display from the article body.</td>
			<td> &nbsp;</td>
			<td>paragraphs=&#8220;2&#8221;</td>
		</tr>
		<tr>
			<td>linktext</td>
			<td>The link text for the permlink to the full article.</td>
			<td>Keep Reading&#8230;</td>
			<td>linktext=&#8220;Read More&#8221;</td>
		</tr>
		<tr>
			<td>ending</td>
			<td>The text that will be displayed at the end of the excerpt when generating the excerpt by length or words.  This is used to show that text is being truncated.</td>
			<td>...</td>
			<td>ending=&#8221;........&#8221;</td>
		</tr>
		<tr>
			<td>linkwraptag</td>
			<td>The <span class="caps">HTML</span> tag that wraps the permlink to the full article.</td>
			<td>p</td>
			<td>linkwraptag=&#8220;span&#8221;</td>
		</tr>
		<tr>
			<td>linkclass</td>
			<td>The class attribute on the linkwraptag.</td>
			<td> &nbsp;</td>
			<td>linkclass=&#8220;morelink&#8221;</td>
		</tr>
		<tr>
			<td>linklabel</td>
			<td>A label that appears before the permlink to the full article.  It will appear outside the link tag.</td>
			<td> &nbsp;</td>
			<td>linklabel=&#8221;- &#8220;</td>
		</tr>
		<tr>
			<td>wrapreadmore</td>
			<td>Determines whether the permlink to the article will be wrapped in the last closing tag of the excerpt or placed outside.</td>
			<td>0</td>
			<td>wrapreadmore=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>excerptwraptag</td>
			<td>The <span class="caps">HTML</span> tag that wraps the excerpt of the full article.</td>
			<td>p</td>
			<td>excerptwraptag=&#8220;span&#8221;</td>
		</tr>
		<tr>
			<td>showlinkwithbody</td>
			<td>Determines whether the permlink to the article will be shown when the article body is displayed because the generated excerpt is not shorter than the article body.</td>
			<td>0</td>
			<td>showlinkwithbody=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>showlinkwithexcerpt</td>
			<td>Determines whether the permlink to the article will be shown when the automatic excerpt is displayed.</td>
			<td>1</td>
			<td>showlinkwithexcerpt=&#8220;0&#8221;</td>
		</tr>
		<tr>
			<td>overrideexcerpt</td>
			<td>Displays an automatic excerpt even if the article has an excerpt defined.</td>
			<td>0</td>
			<td>overrideexcerpt=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>striptags</td>
			<td>Strips <span class="caps">HTML</span> tags from the automatic excerpt that is displayed.</td>
			<td>0</td>
			<td>striptags=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>stripbreakstabs</td>
			<td>Strips line breaks and tabs from the automatic excerpt that is displayed.</td>
			<td>0</td>
			<td>stripbreakstabs=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>skiplength</td>
			<td>The number of characters to skip at the beginning of the display from the article body.</td>
			<td>0</td>
			<td>skiplength=&#8220;50&#8221;</td>
		</tr>
		<tr>
			<td>skipwords</td>
			<td>The number of words to skip at the beginning of the display from the article body.</td>
			<td>0</td>
			<td>skipwords=&#8220;2&#8221;</td>
		</tr>
		<tr>
			<td>skipsentences</td>
			<td>The number of sentences to skip at the beginning of the display from the article body.</td>
			<td>0</td>
			<td>skipsentences=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>skipparagraphs</td>
			<td>The number of paragraphs to skip at the beginning of the display from the article body.</td>
			<td>0</td>
			<td>skipparagraphs=&#8220;1&#8221;</td>
		</tr>
		<tr>
			<td>excerpt</td>
			<td>The field name to use for the article excerpt.</td>
			<td>excerpt</td>
			<td>excerpt=&#8220;custom1&#8221;</td>
		</tr>
		<tr>
			<td>body</td>
			<td>The field name to use for the article body.</td>
			<td>body</td>
			<td>body=&#8220;custom2&#8221;</td>
		</tr>
	</table>