Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 2.47 KB

File metadata and controls

99 lines (72 loc) · 2.47 KB
layout document
category Tags
published true
title Excerpt
description The excerpt tag is used to return the excerpt text, if any, associated with the article being displayed.
tags
Article tags

Excerpt

Contents

  • Table of contents {:toc}

Syntax

<txp:excerpt />

The excerpt tag is a single tag which is used to return the excerpt text, if any, associated with the article being displayed.

The conditional tag if_excerpt can be used to check if there is an excerpt.

Attributes

This tag has no attributes of its own. It accepts only the {% include atts-global-link.html %}.

Examples

Example 1: Excerpt and 'read more' button

This example explains how you could display the excerpt in an article list, and excerpt + body in an individual article. Use the following in an article form:

<txp:if_article_list>
    <txp:if_excerpt>
        <txp:excerpt />
        <p class="read-more">
            <a href="<txp:permlink />#body" title="<txp:title />">Full article</a>
        </p>
    <txp:else />
        <txp:body />
    </txp:if_excerpt>
<txp:else />
    <txp:if_excerpt>
        <txp:excerpt />
    </txp:if_excerpt>
    <div id="body">
        <txp:body />
    </div>
</txp:if_article_list>

Other tags used: body, else, if_article_list, if_excerpt, permlink, title.

Example 2: Display the excerpt text or a default link

Use the following within an article form:

<txp:if_excerpt>
    <txp:excerpt />
<txp:else />
    <p>
        Section:
        <txp:section title="1" link="1" />
    </p>
</txp:if_excerpt>

Other tags used: else, if_excerpt, section.

Example 3: Automatically extract the excerpt from body text

From Textpattern 4.8.0, use the following within an article form to:

  • strip HTML tags form the body text
  • limit the excerpt to the first 35 words
  • append ellipses to the trimmed content

Adjust the 35 to suit your application.

<txp:body escape="tags" trim="/^\W*((?:\w+\W+){35})\w.*$/s" replace="$1&hellip;" />

Other tags used: body.

Example 4: trim paragraphs tags from the excerpt

From Textpattern 4.7.0, tags can use global attributes. In this example any paragraph tags within the excerpt are excluded (escaped):

<txp:excerpt escape="p" />