INSTALLING SIMPLE GLOSSARY

    The Simple Glossary plugin doesn't require any special configuration to work. Simply install it via the Atlassian Marketplace, or one of the other methods detailed below, and you're ready to use it the moment the install finished.

    COMPATABILITY WITH JIRA

    Simple Glossary is compatible with Atlassian JIRA 6.4 and above+.

    INSTALLING VIA ATLASSIAN MARKETPLACE

    1. Go to the Simple Glossary Atlassian Marketplace page.
    2. Buy or evaluate the add-on with a free 30 day trial.
    3. Login to your JIRA account, if required, to proceed installation of the add-on. The license key is automatically configured into the add-on configuration for free trial licenses.

    INSTALLING VIA JIRA PLUGIN MANAGER

    1. In JIRA, click on the Admin gear, and find and click the "Add-Ons" link.

      The Find New Add-ons page is displayed.

    2. Search the Marketplace for 'Glossary' as the search phrase.
    3. Buy the add-on or start the free trial for 30 days.
    4. Login to your JIRA account, if required, to proceed installation of the add-on. The license key is automatically configured into the add-on configuration for free trial licenses.

    INSTALLING MANUALLY

    Use manual install if you have a specific version of Simple Glossary downloaded from the marketplace or sent by some other file sharing method:

    1. In JIRA, click on the Admin gear, and find and click the "Add-Ons" link.

      The Find New Add-ons page is displayed.
    2. Once the "Find new add-ons" page shows, go to Manage add-ons


    3. Click and navigate to the jar file that you already have.
    4. Click Upload, and wait for the confirmation dialog that the install finished.
    5. Buy the add-on or start the free trial for 30 days.
    6. Login to your JIRA account, if required, to proceed installation of the add-on. The license key is automatically configured into the add-on configuration for free trial licenses.

    USING SIMPLE GLOSSARY

    Browsing the Glossary

    The glossary can be found by navigating to a project, and clicking on the "Glossary" item in the left navigation bar.

    The initial view will show you which letters of the alphabet contain terms.

    If there are no terms defined yet, simply click on the "Add Term" button to begin adding some.

    Clicking on a term will bring the up the detailed view of the selected term, showing the definition, and also showing other terms that begin with the same letter.

    Creating a Term

    To add a term, navigate to the Glossary, and click on the "Add Term" button.

    The form for adding a term provides a text field for the term itself, a description, and any amount of synonyms.

    The Term can be a single or multiple words, as well as entire phrases, or an acronym.
    The Definition supports JIRA Wiki markup, and thus can contain any of the typical JIRA macros.
    The Synonyms should be a comma separated list of words or phrases that will be associated with this term.

    Editing a Term

    To edit a term, navigate to the Glossary, find the term you wish to edit by either browsing for it or searching.
    Once you're viewing the term definition, simply click on the "Edit Term" button, and the edit form will load. From there, follow the same steps as when Creating a Term.

    Searching Terms

    Searching terms can be done via the convenient Search box in the header of the glossary screens. Searching includes both the term itself, as well as the definition.

    The results will show all the letters that contain a term matching your search. Simple click one, and the definition will be displayed.

    Terms within Issues

    Any term that is found within an issue is automatically highlighted within the issue, no matter whether it is within the description, or a comment.
    Simply hover over a term, and a popup will appear with the definition inside of it.
    For added convenience, all terms that occur within an issue are also displayed in the "Issue Dictionary"

    Using the "Issue Dictionary"

    Each issue not only highlights the matching terms within the issue itself, but also shows a small "Issue Dictionary" in the right sidebar of the issue. This area contains all the terms found within the current issue, providing a quick overview.
    Clicking any of the terms will show the definition for the term, the same way it would when hovering over a term.

    MISC

    Settings

    The Simple Glossary plugin does not currently provides any plugin-specific settings for JIRA Administrators.

    Feature Requests

    If you can think of a feature you would like to see in Simple Glossary, don't hesitate to email us at support@tss.io, and let us know.

    We are always looking for ways to improve our plugins, and get them more in line with what our customers need.

    Licensing Notice

    The Simple Glossary add-on contains some code that covers this license:

    Copyright (c) 2013, Atlassian Pty Ltd
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    • Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.