README

a plugin for Craft CMS

A Top Shelf Craft creation
Michael Rog, Proprietor

...because you have all the best words.

tl:dr

Wordsmith is a blazing fast, multi-byte safe, one-stop text manipulation toolkit for Craft CMS.

Features

• Trim and truncate text or HTML (by paragraph, word, or character)
• Beautify your typography (smart quotes, widow-prevention, ampersand styling, etc.)
• Change case and inflection
• Transliterate international text
• Search, count, isolate, and replace substrings
• Parse Emoji, using standard and short names
• Parse names to get their parts (e.g. first name, last name, etc.)
• Parse a URL to get its parts (e.g. host name, path, query string, fragment, etc.)
• Get a YouTube or Vimeo video ID from a URL
• Match and re-case Roman numerals
• Calculate text statistics like word count, sentence count, and readability
• Tell whether a variable value is string-like
• ...and much more...

Installation

1. From your project directory, use Composer to require the plugin package:

   composer require topshelfcraft/wordsmith
   

2. In the Control Panel, go to Settings → Plugins and click the “Install” button for Wordsmith.

3. There is no Step 3.

Wordsmith is also available for installation via the Craft CMS Plugin Store.

Documentation

A comprehensive Guide, along with Release Notes, can be found in the documentation:

https://wordsmith.docs.topshelfcraft.com