Keywords: A dynamic glossary for Flarum

Justoverclock

Keywords

Compatibility: beta 16 and 1.0

A Flarum extension. This extension maps the words written in the posts and allows you to build a real glossary for your website.

demo

Usage

Simply install the extension, and add your word and definitions through the extension settings page:

Installation

Install with composer:

composer require justoverclock/flarum-ext-keywords

Updating

composer update justoverclock/flarum-ext-keywords
php flarum cache:clear

Links

Video Demo:

askvortsov

Justoverclock Just a UI suggestion, but for the "delete" button, you might want to use a "trash" icon.

When we were working on this, we used a regular html <button>. However, you could also use the Flarum Button component and pass it fas fa-trash as the icon attr, which would result in this design.

Eren65465024

Justoverclock It's a very useful plugin. Thanks a lot my friend.

1Dot

Hello Justoverclock Can you please also add title tag and description meta tag for glossary page as its very important for seo!

Bishwas-py

Justoverclock Whenever I go to /glossary directly it shows issues with styles and js. The site gets totally messed up. Suggest you fix it. Here you can see it.

Mark73

Ok... this is clever.

luceos

You had me at your second screenshot 😂

tankerkiller125

Now this is pretty damn cool in my book.

Justoverclock

askvortsov thats a nice suggestion, i will implement this in the next update 🙂

Justoverclock

definitely better 🙂

askvortsov

Justoverclock Oh, one more idea. I think this might be easier to navigate if the terms were sorted by key.

[deleted]

@Justoverclock thank you! This is very useful flarum extension.

Justoverclock

askvortsov what do u mean exactly? A filter to search the key to delete?

askvortsov

Justoverclock I mean in the example above, if the order was:

composer
extension
flarum
object

A filter/search for keys could also be cool.

Then, another interesting feature could be an import cool where a CSV could be imported. JS is capable of handling/parsing CSVs, so it could all be done in the frontend.

Justoverclock

askvortsov damn! Ok but I need your brain for 1 year more or less 😂

I think I can handle alphabetical order, but for the csv I think is out of my knowledge 🤐

Also I think that this extension can be useful here on discuss, to give automatic info to users and guest

JohnP

Great extension idea, it's one of those things that most a lot of people will not realise they want/need until they see it and then suddenly realise they do.

I'm going to have a play with it later.

ctml

Fantastic idea and looks great, will be very useful for many I'm sure including myself. Thank you for this!

giter

Great job!

Hari

Awesome tool 😍

010101

Very cool! This could even be used as a canned response of sorts. If people are always asking the same question at your forum, and as long as the answer is relatively short, you could quickly reply with: "Answer #103" They hover over that and see, "Flarum will be stable when it's stable." 😄

ctml

I'm not sure how it's done on other sites, but maybe it could have a maximum number of times each keyword will have the pop-up enable? I haven't used it yet, but I wonder if a specific word was used many times throughout a post if you'd want every instance underlined or perhaps just the first X times.

Justoverclock

ctml based on many example that I see on other website, this happen rarely. Usually no one use the same words a lot of time in a sentence. But this could be a nice feauture too.

I will put this into my todo list also

EvilExecutor

OMG! You're awesome 😊

ctml

Justoverclock the best example I could think of would be blog posts, because they tend to be longer and about a specific subject so the number of times a keyword could be used over may be much higher.

Thanks for considering it!