Skip to content
This repository has been archived by the owner on Nov 4, 2021. It is now read-only.

manifestuk/glossary.craft-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Craft Glossary Plugin

Many sites require some sort of "directory"1 of items, grouped appropriately.

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.2

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.

Footnotes

  1. Sadly, the name "Directory" has already been taken.

  2. 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.