cogContrib extension which depends on xwiki-platform
TypeXAR
CategoryApplication
Developed by

Sarthak Gupta, Vincent Massol

Active Installs17
Rating
Rate!
2 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

The Glossary application has the following features:

  • Add a new Glossary entry [Currently supports only single word entries emoticon_smile]
  • View and filter all existing Glossary entries
  • Search for Glossary entries
  • Glossary Transformation for the ability to create links if a glossary entry appears on a wiki page.

Main view:
Glossary.png

Adding a new Glossary entry

Enter the glossary entry, that you want to add in the text box and click the "Add Glossary Item" button

addglossary1.png

On the next page add a description to the glossary entry. After that Save the page.

addglossary2.png

Viewing existing Glossary entries

Existing glossary entries are shown in the live table as shown below:

viewglossary1.png

On clicking a glossary entry, you will be directed to the page associated with it.

viewglossary2.png

Searching Glossary entries

Enter the entry you want to search in the search box as shown and click the "Search" button.

searchglossary1.png

You will be directed to the search page where you will see the matching entry resuts.

searchglossary2.png

Glossary Transformation in action

 

As we have the word "LOL" as a glossary entry, it will appear as a link on any page in which it appears as shown below:

glossarytransformation1.png

On clicking that link, you will be directed to that glossary page.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

This transformation is not active by default. 

To activate it, edit WEB-INF/xwiki.properties, look for a property named rendering.transformations and make sure it's uncommented and contains the value glossary

For example:

rendering.transformations = macro, icon, glossary
Make sure you restart your XWiki instance for the change to take effect.

Release Notes

v0.3

  • Closed GLOSSARY-12 Add ability to create Glossary entries anywhere in the wiki
  • Closed GLOSSARY-9 Problem with default macro visibility
  • Closed GLOSSARY-6 Glossary Transformation breaks links

Dependencies

Dependencies for this extension (org.xwiki.contrib.glossary:application-glossary-ui 0.3):

Tags:
Created by Vincent Massol on 2018/06/29 23:57
    

Get Connected