Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smark-1/wagtailterms
A Wagtail plugin to add support for glossary terms entity to Draftail
https://github.com/smark-1/wagtailterms
Last synced: 2 months ago
JSON representation
A Wagtail plugin to add support for glossary terms entity to Draftail
- Host: GitHub
- URL: https://github.com/smark-1/wagtailterms
- Owner: smark-1
- License: mit
- Created: 2024-03-07T19:53:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T00:20:53.000Z (6 months ago)
- Last Synced: 2024-07-22T01:29:14.465Z (6 months ago)
- Language: Python
- Homepage:
- Size: 563 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wagtail - Wagtail Terms - A plugin to add a glossary terms entity to the Draftail editor. (Apps / Rich text editor extensions)
README
# Wagtail Terms
A Wagtail package to add support for a glossary terms entity to Draftail
## Installation
```bash
pip install wagtailterms
```
Add `wagtailterms` to your `INSTALLED_APPS` in your Django settings file.
Make sure you have rest_framework in your installed apps as well.
Migrate the database
```bash
python manage.py migrate
```
Add `wagtailterms.urls` to your `urlpatterns` in your Django urls file.
the url should look like this:
```python
path('api/terms/', include('wagtailterms.urls')),
```
---
#### ⚠️ Note
The url path can be anything you want. This is the url that will be used to access the terms on the frontend
---
## Settings
All configurations for wagtailterms are done in the settings.py file in a dictionary called WAGTAILTERMS.
- icon - The icon for the terms. It is used in the draftail editor and for the viewset. All the icons available for [wagtail](https://docs.wagtail.org/en/latest/advanced_topics/icons.html) are valid options
- menu_order - Change the position of the terms snippet in the menu.
- style - Change the default css inline-style of the term
```python
WAGTAILTERMS = {
'icon': 'snippet',
'menu_order': 200,
'style': "text-decoration-line: underline; text-decoration-color: green;text-decoration-thickness: 3px;color:green;",
}
```
## Usage
This wagtail package adds a Draftail entity to create a term that is mapped to a definition. The most common use case would be for the user to hover over a word/phrase on a page and a definition would appear next to the word/phrase.
It allows you to Highlight a word/phrase in the Draftail/richtext editor and search for a definition that was created as a TermSnippet. In the editor the term name and definition will appear on top of the phrase when hovering over the phrase.
### Creating new terms
Click in the admin side bar Terms -> Add New
### Use term entity in editor
Search for term
Select term
Entity displayed in editor
### Display in template
To display the terms on the frontend the term shows up as a `` element
tag with a green underline and green text. In a future update this will be customizable.
The element has a data-term attribute that contains the term id. It is up to the developer to fetch
the term and definition to display it. To get the term by id fetch the term by id using the term API.
Rendered HTML of the term in the frontend:
```html
term 1
```
ℹ️ Above is the default style but this can be modified in the settings.
#### Quick implementation: ([See full example](./example/home/templates/home/quick_start.html))
Include in the template at the bottom of the page template.
```html
...
{% include 'wagtailterms/wagtailterms.html' %}
```
ℹ️ This loads the advanced implementation in page template.
#### The most basic implementation: ([See full example](./example/home/templates/home/basic_page.html))
```javascript
function showterm(e){
const termid = e.target.dataset.term
fetch(`/api/terms/${termid}/`)
.then(response=> response.json())
.then(data => {
alert(`term = ${data.term} \ndefinition = ${data.definition}`)
})
}
for(const term of document.querySelectorAll('[data-term]')){
term.onmouseover=showterm;
}
```
The page would look like this:
On hover
#### A more advanced way would be to use a library like [tippy.js](https://atomiks.github.io/tippyjs/) to
create a tooltip that appears when hovering over the term. ([See full example](./example/home/templates/home/advanced_page.html))
```javascript
function add_tooltips(){
const tips = tippy('[data-term]', {
content: 'Loading...',
allowHTML:true,
interactive:true,
theme:'light',
animation: 'scale-subtle',
onCreate(instance) {
// Setup our own custom state properties
// set if was loaded
instance._fetchInitualized = false;
instance._error = null;
},
onShow(instance) {
if (instance._fetchInitualized || instance._error) {
return;
}
instance._fetchInitualized = true;
fetch(`/api/terms/${instance.reference.dataset.term}/`)
.then(response => response.json())
.then(data => {
if (data.term){
instance.setContent(`
${data.term}
${data.definition}
`);
}else{
instance.setContent("Could not find definition
");
}
})
.catch(error => {
instance._error = error;
instance.setContent(`Request failed. ${error}`);
});
},
});
}
add_tooltips();
```
The page would look like this:
On hover
## REST API
`/api/terms/` will return:
[
{
"term": "term 1",
"definition": "
this is term 1
",
"id": 1
},
{
"term": "example 2",
"definition": "this is another example
",
"id": 2
}
]
/api/terms/1/ will return:
{
"term": "term 1",
"definition": "
this is term 1
",
"id": 1
}
## Changelog
### 0.1.1
- added settings to change the icon and menu order.
### 0.1.2
- fixed term search form wider than modal
- Add dark mode support
### 0.1.3
- Added setting to change frontend styles
- Added quick start template for default frontend implementation