Flamarkt Taxonomies

clarkwinkelmann

Taxonomies

Taxonomies for Flarum discussions, users and Flamarkt products.

The extension can be used with or without Flamarkt installed.

Installation

This extension will follow the future Flamarkt release cycles with possibly a few major 0.x versions during the beta. While this extension is pretty stable, manual operations might still be required between major versions. For this reason I recommend using the ^ requirement (that's what the command below will use) and not *, so you don't accidentally update without reading this README in the future.

composer require flamarkt/taxonomies

Go to admin panel, enable the Backoffice extension.
Go to Backoffice, enable Taxonomies extension.
Click Taxonomies at the top of the Backoffice sidebar to configure.

If you install Flamarkt in the future, you might need to run php flarum migrate via SSH to finish the integration between the 2 extensions.

All types of taxonomies are currently shown on a single page without proper separation.
Dedicated pages will be introduced in a future release.

Known issues

The backoffice for terms management is currently not paginated.
This can lead to backoffice performance issues with large numbers of terms, which is more likely to happen when custom values are allowed.

Changing the forum homepage can lead to issues.
Setting the homepage to user list of product list will likely lead to problems.
Setting the homepage to custom pages that aren't a searchable list of resources should be fine.

The list of available taxonomies and terms will be leaked by the REST API to any user allowed to use any of them.
This includes the user taxonomies even if the user is only allowed to edit discussion taxonomies and vice-versa.

Flamarkt Product support is still a work in progress.

Support

This extension is actively supported.
Please use the Flarum Discuss discussion to discuss features and report issues.

Please only create GitHub issues for bugs with reliable reproduction steps.

clarkwinkelmann

A little back-story on this extension, as some of you might have heard the name floating around in the past.

This extension actually started out under the FriendsOfFlarum namespace at the end of 2020, and was at the time being developed for a client still under Flarum beta 13. During the time it took to complete the extension, Flarum beta 13 was already quite outdated, and the extension wasn't compatible with the latest Flarum version yet. Beta versions were tagged for Flarum beta 13, but no official release was announced.

This also happened around the time FriendsOfFlarum was re-organizing, and after some discussion it was decided this extension would not join the FoF lineup, as to not add any more workload to the small team. My original plan was to release it under my own namespace.

Since then I have started working on the Flamarkt ecosystem (which is still a work in progress) and this extension plays a key role in the categorization of products in the e-commerce plugin. So I decided to integrate it into the Flamarkt namespace. The git history of the new extension doesn't go back to 2020 because the extension was entirely rewritten from scratch in typescript about 1 year ago.

The "Backoffice" part is part of the Flamarkt software and allows extensions of the Flamarkt ecosystem to be used without any e-commerce feature. Information on how to use the e-commerce part will be published in the future as part of the Flamarkt beta.

I will add screenshots and more documentation in the future. In the meantime you can refer to the old FoF README for a description of what each setting does https://github.com/FriendsOfFlarum/taxonomies

clarkwinkelmann

Version 0.1.3

This is a feature update and contains new migrations. You must run php flarum migrate after updating the extension.

Changes:

Added ability to scope a discussion taxonomy to a single tag or group of tags
Added permission to bypass min/max requirements
Show selected taxonomies and edit buttons on blog pages added by v17development/flarum-blog
Reduce vertical padding in mobile discussion composer if there are many controls

If a single tag is selected as the scope for a taxonomy, the taxonomy filter on the discussion list will only appear on that tag's page.

The compact layout in mobile discussion composer will trigger as soon as there are 5 controls in the editor, whether they be from Taxonomies or another extension, so for example:

Tags + 1 taxonomy + title + body = regular layout
Tags + 2 taxonomies + title + body = compact layout
Tags + 1 taxonomy + poll + title + body = compact layout

This is only a workaround for when there are 5 to ~8 controls in the editor. If you have more controls it will probably become unusable again.

Update sponsored by puppydreamwork

clarkwinkelmann

Version 0.1.4

Fix taxonomy access in tags that contain scoped permissions (priority issue with Flarum Tags extension would cause view/edit permissions to always be denied)
Enable viewing and removing deleted tags from the taxonomy scope setting. Deleted tags will be rendered as [Deleted] #<id> in the field

clarkwinkelmann

Version 0.1.5

Use Flarum ComposerState API to allow other extensions to integrate with Taxonomies in the discussion composer.
Expose taxonomy name through data- attribute in the discussion composer for easier theming through extensions.
Enable access to the composer taxonomy button through the keyboard.

This update is required to use the new integration features that will be released in the next versions of the Composer Page and Formulaire extensions.

tohsakarat

Hello!
When I want to enable the extension, here is a problem.
The logs say:
Image description

clarkwinkelmann

tohsakarat this is a consequence of the database table prefix causing the auto-generated index names to become too long. That issue can affect any extension that uses long table and/or column names, and this extension is one of them.

I suggest running Flarum in a dedicated database without any table prefix, this will be the easiest solution, and also cover you for other extensions that might have the same issue.

If you need to proceed with the current prefix, you'll need to manually create the tables and indexes with custom shorter names, and then manually mark the migrations as done. This is not easy to do.

I think there's also a way to raise the maximum index name length somewhere in the MySQL server settings, but I've never tried doing that.

I'm not currently planning to address this issue in the codebase. I might add a fatal error when the prefix is too long to at least prevent breaking the database with partial migrations.

Maybe in a future major version I'll rename everything to be a bit shorter. But the issue doesn't have a definite solution, there will always be a prefix length that makes the names become too long.

rob006

clarkwinkelmann If you need to proceed with the current prefix, you'll need to manually create the tables and indexes with custom shorter names, and then manually mark the migrations as done. This is not easy to do.

It would be easier to edit 20210401_000200_create_discussion_term_table.php and change $table->primary(['discussion_id', 'term_id']); to something like $table->primary(['discussion_id', 'term_id'], 'flamarkt_discussion_taxonomy_term_primary');. And then run migrations.

clarkwinkelmann

rob006 I don't want to make that change by its own in the migration files because there might be a need to address the index by its existing name in future migrations, so it would require a migration to rename existing indexes as well. I'll try to thing of a solution for this in v0.2

But as a local workaround yes, that would also be a solution.

Darkle

I have a question about the taxonomy term filters, a guest user can't see/use the filters (they throw a console error if accessed via URL and the dropdown doesn't appear) until you change the permission to "Non-activated and suspended members" in "See taxonomies on own user", is this on purpose?

At first I didn't really understand what this meant and it was more a matter of trying the permissions one by one, maybe it's my fault I haven't slept much 😅

clarkwinkelmann

Version 0.1.6

Fix taxonomies visibility for guests. The "see all taxonomies" permissions for discussions and users were not read.
Fix possible discussion filter issue at page load if a user taxonomy uses the same slug as discussions.
Improve compatibility with other extensions that also use query string parameters to perma-link homepage filters.
Improve homepage performance by ignoring query parameters that are known to not be taxonomies. This logic already existed but the code had an error that made it ineffective.
Added language to the list of known query parameters when FoF Discussion Language is enabled.

There are still known compatibility issues with FoF Discussion Language depending on the extension load order. The next update of FoF Discussion Language will fix the other half of the issues.

piepiepie

hello
I found users can’t rename the discussion when using tags with Taxonmies

clarkwinkelmann

piepiepie can you share more details about your settings and what happens?

Is the rename button visible at all? what's the exact error message if the button is visible?

What's your rename permission value?

I'm a bit surprised if that's caused by Taxonomies because unlike the Tags extension this extension doesn't modify permissions at all.

piepiepie

clarkwinkelmann
I set that everyone can edit their title without limits.
the rename button isn’t visible with tag which use Taxonomies.It’s visible with other tags.The rename button has no mistake.
Wait for a moment I will take a screenshot

Upadate:
Oh I’m really sorry!I have mistake set my settings.
There’s nothing wrong with your extension

clarkwinkelmann

Version 0.1.7

Added ability to configure separately the perma-linkability and whether the dropdown should be visible in the discussion/user lists.
Added Scout search integration. See README for details.
Moved discussion, user and product taxonomies configuration to their own individual pages.
Refactored taxonomy edit modal to reduce the amount of scrolling required to access all options.

The database structure was modified. You must run php flarum migrate after updating.

clarkwinkelmann

Version 0.1.8

Fix "enable filters" feature not working correctly.
Fix links in discussion hero causing a full page refresh instead of navigating inside the single page app as expected.

lichengkun135

It would be nice if you could please show some screenshots of this extension to give us a better view of how this extension works. 😃

[deleted]

lichengkun135

I woukd like to see it also. Looks like @clarkwinkelmann put a lot effort in it...

clarkwinkelmann

While I do like screenshots, I have made the decision to not include any screenshot for any of my free/sponsored extensions. They take a significant amount of time to prepare and keep up to date, and I'm already quite limited in the amount of time I can dedicate to those extensions.

Once Flamarkt is ready in a few months there will be a demo forum with all the Flamarkt extensions including this one. There will also be paid extensions later on so their introduction videos will also show some of the free features in action.

If anyone wants to share their own screenshots or link to a website that uses the plugin, you are most welcome 😃

AnonymousCucumber

Hello!
This is a useful package, but a few questions have arisen:

How can I translate a few words in front-end? (my site is not for English).
After installing the package and creating Taxonomy, it looks like there is no SEO integration or settings (for example, title). Maybe this can be compensated by another package? Or is it planned to do something with the SEO settings in the future?

clarkwinkelmann

AnonymousCucumber can you share the exact texts or a screenshot of the content that is not translatable? If your current language pack doesn't translate it, you might be able to change the texts with Linguist. It's possible there are still a few places with hard-coded English, if someone can point them out I'll make them translatable.

I'm not sure what you mean by SEO integration. You would like the taxonomy values to be added to a discussion page <head> meta tags? Or you mean you want to change the page <title> to show some of the taxonomy terms? I don't think Flarum has anything in place to do this last one easily without conflicting with other extensions.

If you are referring to search, there's a taxonomy search gambit, optional filters on homepage and a fulltext search integration using Scout.