- Description:
Module for auto-linking glossary entries.
- Source:
- Copyright:
- 2023 Mihail Geshoski
- 2023 Mihail Geshoski
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Module for auto-linking glossary entries.
Members
(static, constant) init
- Description:
Initialize the module.
- Source:
Initialize the module.
(inner, constant) The :Object
- Description:
object containing the relevant selectors.
- Source:
object containing the relevant selectors.
Type:
- Object
Methods
(inner) fetchGlossaryEntry(entryId) → {Promise}
- Description:
Fetch the linked glossary entry.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
entryId |
int | The id of the linked glossary entry. |
Returns:
The glossary entry promise.
- Type
- Promise
(inner) generateTagListData(tags) → {Object}
- Description:
Generates an object that contains the data required to render a tag list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
tags |
array | The array containing the tags related to the linked glossary entry. |
Returns:
The data required to render a tag list.
- Type
- Object
(inner) glossaryEntryViewed(entryId) → {Promise}
- Description:
Notify that the linked glossary entry was viewed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
entryId |
int | The id of the linked glossary entry. |
Returns:
The promise object.
- Type
- Promise
(inner) registerEventListeners() → {void}
- Description:
Register the event listeners for the glossary entry auto-linker.
- Source:
Returns:
- Type
- void
(inner) showGlossaryEntry(entryId) → {Promise}
- Description:
Show the linked glossary entry in a modal.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
entryId |
int | The id of the linked glossary entry. |
Returns:
The modal promise.
- Type
- Promise