{"id":21065657,"url":"https://github.com/adaptlearning/adapt-contrib-glossary","last_synced_at":"2025-06-18T05:37:55.965Z","repository":{"id":18732474,"uuid":"21943906","full_name":"adaptlearning/adapt-contrib-glossary","owner":"adaptlearning","description":"An Adapt extension that allows a list of glossary terms","archived":false,"fork":false,"pushed_at":"2025-06-11T16:12:28.000Z","size":3494,"stargazers_count":5,"open_issues_count":3,"forks_count":15,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-06-11T17:54:02.226Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adaptlearning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-07-17T13:58:20.000Z","updated_at":"2025-04-01T08:44:27.000Z","dependencies_parsed_at":"2023-12-20T07:02:33.508Z","dependency_job_id":"86e941a9-5261-4096-aa9f-ec40abaf203d","html_url":"https://github.com/adaptlearning/adapt-contrib-glossary","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/adaptlearning/adapt-contrib-glossary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-glossary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-glossary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-glossary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-glossary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adaptlearning","download_url":"https://codeload.github.com/adaptlearning/adapt-contrib-glossary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-glossary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260497207,"owners_count":23018237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T17:55:58.923Z","updated_at":"2025-06-18T05:37:50.934Z","avatar_url":"https://github.com/adaptlearning.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# adapt-contrib-glossary\n\n**Glossary** is an *extension* for the [Adapt framework](https://github.com/adaptlearning/adapt_framework).\n\n\u003cimg src=\"https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/glossary.gif\" width='548' height='497' alt=\"demonstration of how the glossary looks and functions\" align=\"right\"\u003e\n\nThis extension allows for a list of glossary terms to be displayed (in alphabetical order) in the 'drawer' of the course. The terms can be clicked to reveal a definition. Features and options include:\n- the list of terms is searchable\n- the terms' descriptions are searchable\n- terms as they appear within course content may be linked to their associated entry in the glossary\n- headers may be enabled to group terms by their first letter/digit\n- an index may be enabled to make it easy to jump to group headers within a long list\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e \n## Installation\n\nFirst, be sure to install the [Adapt Command Line Interface](https://github.com/adaptlearning/adapt-cli), then from the command line run:-\n```console\nadapt install adapt-contrib-glossary\n```\nThis extension can also be installed by adding the extension to the adapt.json file before running `adapt install`:\n```json\n\"adapt-contrib-glossary\": \"*\"\n```\n## Usage\n\nYou can create links to items in the glossary in the format `\u003ca href='#' data-glossaryterm='About Framework'\u003eAdapt Framework\u003c/a\u003e`. You should avoid doing this in text that will be displayed within a Notify popup (e.g. question feedback) as the Glossary will open behind the Notify popup.\n\nThe index links to the group headers. If the index is enabled, group headings will be employed regardless of the value of `_isGroupHeadersEnabled`.\n\n## Settings overview\n\nThe attributes listed below are used in *course.json* to configure **Glossary**, and are properly formatted as JSON in [*example.json*](https://github.com/adaptlearning/adapt-contrib-glossary/blob/master/example.json).\n\n**\\_glossary** (object): The Glossary object that contains values for **\\_isEnabled**, **\\_drawerOrder*, **title**, **description**, **searchItemsAlert**, **clearSearch**, **searchPlaceholder**, **searchWithInDescriptionLabel**, **itemNotFoundMessage**, **\\_isSearchEnabled**, **\\_isIndexEnabled**, **\\_isGroupHeadersEnabled**, and **\\_glossaryItems**.\n\n\u003e**\\_isEnabled** (boolean): Turns **Glossary** on and off. Acceptable values are `true` and `false`.\n\n\u003e**\\_drawerOrder** (number): Determines the order in which this extension appears as a drawer item. Acceptable values are numbers.\n\n\u003e**title** (string): This text is displayed (along with the **description**) in the [Drawer](https://github.com/adaptlearning/adapt_framework/wiki/Core-modules#drawer) as part of a button that gives access to the **Glossary**.\n\n\u003e**description** (string): This text is displayed (along with the **title**) in the [Drawer](https://github.com/adaptlearning/adapt_framework/wiki/Core-modules#drawer) as part of a button that gives access to the **Glossary**.\n\n\u003e**searchItemsAlert** (string):  This text renders as an ARIA label. It is a message indicating the number of terms in the search result. It is not visible to the naked eye, but is read by accessibility devices. A dynamic value is suggested in [*example.json*](https://github.com/adaptlearning/adapt-contrib-glossary/blob/master/example.json).\n\n\u003e**clearSearch** (string): This phrase is associated with the \"Cancel Search\" button.\n\n\u003e**searchPlaceholder** (string): This text appears in the Search input until the learner enters text.\n\n\u003e**searchWithInDescriptionLabel** (string): This text is used as a label for the \"search within description\" checkbox.\n\n\u003e**itemNotFoundMessage** (string): This text appears when a search returns no results.\n\n\u003e**\\_isSearchEnabled** (boolean): Turns the search function on and off. Acceptable values are `true` and `false`. The default is `true`. If set to `false`, the search container is not displayed.\n\n\u003e**\\_isIndexEnabled** (boolean): Turns the index header on and off. Acceptable values are `true` and `false`. The default is `false`. If set to `false`, the index is not displayed. The index acts as a menu for grouped terms. It is most effective when used with long lists of terms. If **\\_isIndexEnabled** is set to `true`, **\\_isGroupHeadersEnabled** will be set to `true` when the course is running.\n\n\u003e**\\_isGroupHeadersEnabled** (boolean): Turns the group headers on and off. Terms are alphabetized and grouped by their initial character (number or letter). Acceptable values are `true` and `false`. The default is `false`.  Headers are most effective when used with long lists of terms. If **\\_isIndexEnabled** is set to `true`, **\\_isGroupHeadersEnabled** will be set to `true` when the course is running, regardless of its original value.\n\n\u003e**\\_glossaryItems** (object): This object stores properties for each glossary item. Multiple glossary items may be created. Each contains values for **term**, **termAriaLabel**  and **description**.\n\n\u003e\u003e**term** (string): The word or phrase that comprises the glossary term.\n\n\u003e\u003e**termAriaLabel** (string): Optional, reading of the word or phrase that comprises the glossary term. If unset, **term** provides the aria-label.\n\n\u003e\u003e**description** (string): This text is associated with each resource item. It renders as part of the aria label to tell screen readers that the content will open in an external link.\n\n\u003cdiv float align=right\u003e\u003ca href=\"#top\"\u003eBack to Top\u003c/a\u003e\u003c/div\u003e\n\n## Events\n\n| Event   |      Description      |  Object |\n|:----------|:--------------|:-------:|\n| _glossary:descriptionOpen_ |  Triggered when the user clicks on glossary item and its description get opened | viewId (string) |\n\n## Limitations\n\nTo be completed.\n\n----------------------------\n\u003ca href=\"https://community.adaptlearning.org/\" target=\"_blank\"\u003e\u003cimg src=\"https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg\" alt=\"adapt learning logo\" align=\"right\"\u003e\u003c/a\u003e\n**Author / maintainer:** Adapt Core Team with [contributors](https://github.com/adaptlearning/adapt-contrib-glossary/graphs/contributors)\n**Accessibility support:** WAI AA\n**RTL support:** Yes\n**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadaptlearning%2Fadapt-contrib-glossary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadaptlearning%2Fadapt-contrib-glossary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadaptlearning%2Fadapt-contrib-glossary/lists"}