Download the PHP package thesceneman/silverstripe-glossary without Composer

On this page you can find all versions of the php package thesceneman/silverstripe-glossary. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package silverstripe-glossary

Silverstripe Glossary

Adds a Glossary section to CMS admin where glossary terms can be defined. These terms can then be added to content via the WYSIWYG and the definitions will be rendered as interactive rollovers within webpage content.

Thanks to @MelissaWu-SS for writing the code that was the basis for this module

Requirements

version ^1

version ^0.2

Installation

Usage

After running composer run the usual vendor/bin/sake dev/build

This will add the Glossary section to the CMS admin:

Glossary admin

Here we can add glossary terms via standard gridfield. I've added some sample data in this example:

Glossary admin data

Now, we can add these terms to our WYSIWG markup. Select the word you'd like to apply the definition to, click the "Glossary" button, and choose the appropriate definition:
Adding glossary term to markup

Selecting glossary term

And finally here is the marked up content on a webpage (displayed at cursor hover state):

Glossary frontend

Customising the frontend

NB. With the release of v0.2.0 the Definition field on GlossaryTerms was changed from Varchar to HTMLText. The simple CSS only frontend implementation renders this as plaintext (in order to be rendered within span tags) so no markup will be carried to the frontend.

This module comes with a very basic frontend implementation out of the box and you'll likely want to change this to match your application. You may opt to keep the purely CSS rollover functionality and write some new CSS for the classes .inline-glossary-term and .inline-glossary-definition.

Alternatively you can overload the template at TheSceneman\SilverStripeGlossary\View\GlossaryShortcodeProvider.ss and use whatever markup and or Javascript components you'd like.

Maintainers

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.


All versions of silverstripe-glossary with dependencies

PHP Build Version
Package Version
Requires silverstripe/framework Version ^5.0
silverstripe/admin Version ^2.0
symbiote/silverstripe-gridfieldextensions Version ^4
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package thesceneman/silverstripe-glossary contains the following files

Loading the files please wait ....