dnadesign/silverstripe-glossary

A dictionary like module allowing definitions to be set for in-content words.

Installs: 123

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 6

Forks: 0

Open Issues: 1

Type:silverstripe-vendormodule

1.0.4 2024-03-13 04:51 UTC

This package is auto-updated.

Last update: 2024-10-13 06:05:33 UTC


README

Overview

The Glossary module, developed by DNADesign, is a SilverStripe module designed for SilverStripe 5. This module empowers CMS users to enhance content by selecting specific words. When these words are clicked by front-end users, they can easily access detailed definitions.

Features

  • Seamless integration with SilverStripe 5
  • Empowers CMS users to select glossary words
  • Front-end users can click on glossary words for instant definitions

Installation

  1. Install the module using Composer:

    composer require dnadesign/silverstripe-glossary
  2. Run dev/build to update your database:

    vendor/bin/sake dev/build
  3. Configure the module in your SilverStripe CMS.

Usage

  1. In the CMS, locate the content where you want to add glossary words.
  2. Use the Glossary module interface to select and define glossary words.
  3. Save the changes, and the glossary words will be clickable on the front end.

TODO

  1. Caching
  2. Locales

Contribution

Feel free to contribute to the development of this module. Submit bug reports, feature requests, or even pull requests to help make the Glossary module even better.

License

This module is licensed under the BSD-3-Clause License.