Craft plugin for creating glossaries.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
glossary
.gitignore
LICENSE
README.md

README.md

Craft Glossary Plugin

Many sites require some sort of "directory"[^directory-name] of items, grouped appropriately.

[^directory-name]: Sadly, the name "Directory" has already been taken.

The most obvious example is a list of staff members, grouped by the first letter of their surname, but it could also be a list of offices organised by country, recipes organised by cooking method, and so forth.

It's possible to do all of this using Twig, but the result is messy and difficult to test. Glossary keeps your templates neat, and has a suite of unit tests to ensure everything runs smoothly.[^unit-tests]

[^unit-tests]: Unit testing of Craft plugins is still in its infancy, so you'll need to be comfortable digging through the code if you want to run them locally. Hopefully this will improve over time.

Requirements

Glossary has been tested with Craft 2.1.

Installation

  1. Download and unzip the Glossary plugin.
  2. Move the glossary directory to your /craft/plugins directory.
  3. Go to the "Settings → Plugins" page in your admin area, and click on the "Install" button next to the Glossary plugin.

Usage

Usage instructions are provided in the announcement blog post.

Support

If you've found a bug, please create an issue. If you want to shower us with praise and fiscal appreciation, you can start by finding us on Twitter.