ryanshrum / Hacksaw
Labels
Projects that are alternatives of or similar to Hacksaw
Notice (4/17/2018):
Unfortunately, due to not working with Craft anymore and a lack of time, I haven’t been able to get Hacksaw updated for Craft 3. I would recommend NY Studio's Tyopgrify or Top Shelf Craft’s Wordsmith (which includes native backwards compatibility for Hacksaw).
Additionally, if you would like to takeover as the maintainer of Hacksaw, please let me know and I will handover the reins.
Hacksaw for Craft CMS
A simple text truncation plugin for Craft CMS that takes your content and hacks it down to more manageable sizes.
Installation
To install Hacksaw, follow these steps:
- Download & unzip the file and place the
hacksawdirectory into yourcraft/pluginsdirectory
-OR-
Do agit clone https://github.com/ryanshrum/hacksaw.gitdirectly into yourcraft/pluginsfolder. You can then update it withgit pull
-OR-
Install with Composer viacomposer require ryanshrum/hacksaw - Install plugin in the Craft Control Panel under Settings > Plugins
- The plugin folder should be named
hacksawfor Craft to see it. GitHub recently started appending-master(the branch name) to the name of the folder for zip file downloads.
Usage
Hacksaw is a Twig filter that accepts the following parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
| hack | string | 'p' |
What you want to hack on ('characters', 'words' or 'paragraphs' - can also use first letter as short hand 'c', 'w' or 'p') |
| limit | int | 1 |
Starting point for chars limit (used with chars param) |
| allow | string | null |
Sometimes there are HTML tags in your content that you don' removed, pass them here |
| append | string | null |
String to append to the end of the excerpt |
Note: Cutoff has been deprecated from Hackasw.
Examples
Hacking by paragraphs is default, so if you wanted to limit your text to 5 paragraphs, you would only need to set the limit parameter:
{{ entry.richTextField|hacksaw(limit='5') }}
If you wanted to limit to 50 characters or words, you'd use both the hack and limit parameter:
{{ entry.richTextField|hacksaw(hack='characters', limit='50') }}
{{ entry.richTextField|hacksaw(hack='words', limit='50') }}
Hacksaw will strip all HTML from your excerpt by default. If you would like to keep some basic HTML you can use the allow parameter to keep specific HTML tags. For example, let's say you want to keep <a> and <b> tags:
Note: <p>'s are automatically allowed when hacking by paragraph.
{{ entry.richTextField|hacksaw(limit='10', allow='<a><b>') }}
Note: If you are including HTML in the append parameter, the elements must be present in the allow parameter. If you are including a Craft variable in any parameter, it must be added using the Twig concatenation operator, ~. Example of both:
{{ entry.richTextField|hacksaw(hack='w', limit='100', allow='<a>', append='<a href="' ~ entry.url ~ '">Continue...</a>') }}
Brought to you by Ryan Shrum