Plugin Glossary

Plugin Glossary
This extension provides a glossary of terms

Authors

Anyware Services

Most recent version

1.1.0

Tracking issues

https://issues.ametys.org/browse/GLOSSARY

Download

Latest version 

  1. Presentation
  2. Screenshots

Presentation

The Glossary plug-in allows you to add definitions of term to build a glossary. The text of contents is scanned and display a pop-up definition for words that can be found in the glossary.

This extention will be only available with 3.3 releases.

Screenshots

User manual

Glossary tool

Click on "Glossary" button of Home tab to open the glossary tool.

Select a language in the drop down list in the top of the tool.

This tool allows you to create / edit or delete the glossary terms.

Click on Add button to insert a new definition

  • Word: the word to add to the glossary
  • Variants: the alternative terms for the word, comma-separated (feminine/plural forms, verb conjugation, ...)
  • Definition: the word definition
  • Highlight in contents: Check the box to highlight occurrences of the word and its variants in contents, and display definition in a popup

Add a new definition on content edition

You can also add a new glossary term, directly in content edition.

On edition, select the term to add in glossary and clic on Add to glossary button

Pop-up definition in contents

The terms of glossary arec highlight in contents and the definition is displayed on mouseover.

The glossary service

Go to Add service menu to add the "Glossary" service.

Service's parameters

Parameters

Description

Mandatory

Title

The service title.
Leave empty if you do not want any title.

no

A page by letter

Check this box to organize the navigation in glossary by letters

yes

Display

Select the view to use for the service rendering.

yes

Tag the service page

Affect the "Glossary" tag to the page containing this service.

This is necessary to link the terms used in contents to the glossary.

Sample of rendering

Installation and download

Download

Installation / Integration

  • Add the plugin JAR in the WEB-INF/lib directory of your Ametys application.
  • Add the glossary tool button in your cms-ribbon-*.xmlfiles

    <control id="org.ametys.plugins.glossary.Glossary"/>
    
  • To add definition in contents edition, add the control org.ametys.glossary.editor.AddDefinition in the org.ametys.cms.content.EditionTab tab of your cms-ribbon-*.xmlfiles:

    <layout align="top" size="small">
          <control id="org.ametys.cms.edition.symbol.Insert"/>
          <control id="org.ametys.glossary.editor.AddDefinition"/>
          <control id="org.ametys.plugins.forms.Insert"/>
    </layout>
    
  • Restart the server
  • Add the right to manage glossary to users
  • To personalize the style of glossary terms in yours contents you can add CSS style for <dfn>tag. For example :

    dfn {
    	font-weight: bold;
    	font-style: normal;
    	border-bottom: 1px dashed #000;
    	text-decoration: none;
    }
    
    dfn a {
    	text-decoration: none !important;
    	border-bottom: 1px dashed #006BB1;
    }
    

Compatibility

Plugin version

1.0.x

1.1.x

Ametys 3.3.x

 
Ametys 3.4.x