https://github.com/adamisntdead/excerpt

Hassle Free Excerpts/Extracts For ExpressionEngine 3 and 4 🎉💻
https://github.com/adamisntdead/excerpt

addon excerpt expression-engine expressionengine php plugin shorten

Last synced: about 2 months ago
JSON representation

Hassle Free Excerpts/Extracts For ExpressionEngine 3 and 4 🎉💻

• Host: GitHub
• URL: https://github.com/adamisntdead/excerpt
• Owner: adamisntdead
• License: mit
• Created: 2018-06-20T00:24:01.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-13T17:42:24.000Z (over 6 years ago)
• Last Synced: 2025-02-05T23:25:23.883Z (3 months ago)
• Topics: addon, excerpt, expression-engine, expressionengine, php, plugin, shorten
• Language: PHP
• Size: 4.88 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


> An excerpt creation plugin for Expression Engine 3 & 4 🎉

This is a rebuild of the [hacksaw](https://devot-ee.com/add-ons/hacksaw) plugin and [bbd_chopper](https://github.com/BlackBeltDesigns/bbd_chopper.ee_addon) - compatible with EE 3 & 4.

It allows you to create small excerpts of any html content with ease.

It can strip HTML content, append something (like `...`)

to the end, and let you cutoff by words, characters

or a cutoff point.

## Installation

* Download as a zip.

* Unzip to a folder, such as `excerpt`.

* Move folder to `system/user/addons` or your setup's equivilent.

* Install via control panel.

## Usage

To use Excerpt, just wrap your content with 

the `{exp:excerpt}` tag:

```php

{exp:excerpt}

Some
 Amazing

Content!

{exp:excerpt}

```


Which will be turned into `Some Amazing Content!`.  

To use the other options, the following parameters 

are supported:

```php

{exp:excerpt

    chars = "" // Limit number of characters

    words = "" // Limit number of words

    cutoff = "" // Cutoff at a given string

    append = "" // Add something to the end (eg. append="...")

    allow = "" // Allow certain HTML tags (eg. allow="
")

}

```

## License

MIT - Copyright (c) 2018 Adam Kelly