diff --git a/README.md b/README.md index f828e48..4ecbcc5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # @rohberg/volto-slate-glossary -Volto Add-On `@rohberg/volto-slate-glossary` adds tooltips for glossary terms of [collective.glossary](https://github.com/collective/collective.glossary) +Volto add-on `@rohberg/volto-slate-glossary` adds tooltips for glossary terms of [collective.glossary](https://github.com/collective/collective.glossary) [![npm](https://img.shields.io/npm/v/@rohberg/volto-slate-glossary)](https://www.npmjs.com/package/@rohberg/volto-slate-glossary) [![Unit tests](https://github.com/rohberg/volto-slate-glossary/actions/workflows/unit.yml/badge.svg)](https://github.com/rohberg/volto-slate-glossary/actions/workflows/unit.yml) @@ -9,8 +9,12 @@ Volto Add-On `@rohberg/volto-slate-glossary` adds tooltips for glossary terms of ![Tooltips @rohberg/volto-slate-glossary](https://github.com/rohberg/volto-slate-glossary/raw/main/docs/volto-slate-glossary-tooltips.png) +Install Plone add-on [collective.glossary](https://github.com/collective/collective.glossary) in your backend. +This provides the content type `glossary`. + Determine where to apply tooltips in your project by match configuration: +```javascript import { Tooltips } from '@rohberg/volto-slate-glossary/components'; export default function applyConfig(config) { @@ -28,6 +32,7 @@ Determine where to apply tooltips in your project by match configuration: return config; } +``` By default we show a tooltip when a word matches case insensitively: when the term is "Hello" or "hello", a tooltip is shown for "Hello", "hello", "HELLO", "hElLo", etcetera. @@ -39,19 +44,14 @@ config.settings.glossary.caseSensitive = true; Regardless of this setting, when you have a fully uppercase term, for example `REST` (Representational State Transfer), always only the exact word `REST` gets a tooltip, not `rest` or `Rest`. -By default we show a tooltip for all matches on a page. -You can configure this to only show a tooltip for the first match: +By default we show tooltips for all occurrences of a term. -``` +Since version 2.0.0 you can configure to only show tooltips for the first occurence on a page. + +```js config.settings.glossary.matchOnlyFirstOccurence = true; ``` -Install Plone add-on [collective.glossary](https://github.com/collective/collective.glossary) in your backend. -This provides the content type `glossary`. - User can opt-out by setting glossarytooltips to false. Add a boolean member field *glossarytooltips* for it. - - -This add-on requires Volto with Slate editor. Be sure to upgrade to Volto >= 16.0.0-alpha.15. diff --git a/packages/volto-slate-glossary/news/11.feature b/packages/volto-slate-glossary/news/11.feature index 1b733bc..229f27d 100644 --- a/packages/volto-slate-glossary/news/11.feature +++ b/packages/volto-slate-glossary/news/11.feature @@ -1 +1 @@ -Show an alphabet navigation on glossary. Clicking a letter scrolls the entries for this letter into view. @mauritsvanrees +Show an alphabet navigation on glossary. Clicking a letter scrolls the entries for this letter into view. @mauritsvanrees, @ksuess