2017 © Pedro Peláez
 

typo3-cms-extension tev_glossary

3ev Glossary TYPO3 Extension

image

3ev/tev_glossary

3ev Glossary TYPO3 Extension

  • Wednesday, April 12, 2017
  • by 3ev
  • Repository
  • 7 Watchers
  • 0 Stars
  • 144 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 19 Versions
  • 0 % Grown

The README.md

TYPO3 Glossary Extension

Latest Stable Version License, (*1)

Define a glossary of words to be higlighted across your TYPO3 site., (*2)

Installation

$ composer require "3ev/tev_glossary"

Dependencies

The Glossary Extension requires jQuery and Bootstrap to be present on your site, as glossary entries will be highlighted using Bootstrap popovers., (*3)

Usage

Install the TYPO3 extension through the Extension Manager. You'll then be able to add glossary entries from the List View. You can add glossary entries to any storage folder or page - they will be found globally., (*4)

Once you've added your glossary entries, you'll need to add the glossary javascript file to any pages you want the glossary to highlight entries on. You can do this via Typoscript, Fluid or VHS. Here's an example using VHS:, (*5)

<v:asset.script name="tev-glossary" path="EXT:tev_glossary/Resources/Public/js/tev-glossary.js" standalone="1" />

This file needs to be included after jQuery and the Boostrap javascript, ideally in your page footer., (*6)

There is also a provided Glossary Browser Plugin, which displays a list of all glossary terms, grouped by first letter. You can add this plugin to any page to display an index for your glossary. For more information on the markup generated by this plugin, see the Styling section., (*7)

Styling

Highlights

Each highlighted glossary entry will be wrapped in a <span/> with a class of tev-glossary-highlight. Each popover uses the default Bootstrap markup, but is given an additional class of tev-glossary-popover. You can style these elements as you wish, no default styling is included., (*8)

Browser plugin

The Glossary Browser Plugin generates the following markup:, (*9)



  • A
  • B
    • ...

CSS classes are set for every element, so the markup is very easy to style., (*10)

Overriding Templates

You can fully override any templates in this extension in the normal Extbase way, by adding the following Typoscript in your own extension:, (*11)

plugin.tx_tevglossary {
    view {
        templateRootPaths {
            # The default index is 0, so use any index from 1 upwards

            1 = EXT:your_ext/Path/To/Template/Overrides/
        }
    }
}

You can do the same for partialRootPaths or layoutRootPaths too. Any templates added to the configured directories will be preferred over the default ones., (*12)

Configuration

The following Typoscript constants are available for you to configure the plugin with:, (*13)

plugin.tx_tevglossary.config.enable, (*14)

1 by default. Enable glossary highlighting. You can use this to disable glossary highlighting on certain pages with Extension Templates., (*15)

plugin.tx_tevglossary.config.selector, (*16)

p by default. The CSS selector used to search for text on the page to highlight., (*17)

plugin.tx_tevglossary.config.popover_position, (*18)

top by default. The Bootstrap popover display position., (*19)

plugin.tx_tevglossary.config.popover_toggle, (*20)

hover by default. The Bootstrap popover display trigger., (*21)

plugin.tx_tevglossary.config.first_occurence_only, (*22)

0 by default. Display definitions only on first occurrence of the glossary item in the page., (*23)

License

MIT © 3ev, (*24)

The Versions

12/04 2017

dev-master

9999999-dev https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

12/04 2017

v2.0.8

2.0.8.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

10/11 2015

v2.0.7

2.0.7.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

09/09 2015

v2.0.6

2.0.6.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

08/09 2015

v2.0.5

2.0.5.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

08/09 2015

v2.0.4

2.0.4.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

26/08 2015

v2.0.3

2.0.3.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

25/08 2015

v2.0.2

2.0.2.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

24/08 2015

v2.0.1

2.0.1.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

The Development Requires

by Avatar 3ev
by Ben Constable

24/08 2015

v2.0.0

2.0.0.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

03/08 2015

v1.3.2

1.3.2.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

31/07 2015

v1.3.1

1.3.1.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

31/07 2015

v1.3.0

1.3.0.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

31/07 2015

v1.2.0

1.2.0.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

31/07 2015

v1.1.1

1.1.1.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

31/07 2015

v1.1.0

1.1.0.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

31/07 2015

v1.0.2

1.0.2.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

30/07 2015

v1.0.1

1.0.1.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable

30/07 2015

v1.0.0

1.0.0.0 https://github.com/3ev/tev_glossary

3ev Glossary TYPO3 Extension

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Avatar 3ev
by Ben Constable