PHPackages club-1/flarum-ext-sphinx-glossary - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. club-1/flarum-ext-sphinx-glossary ActiveFlarum-extension club-1/flarum-ext-sphinx-glossary ================================= Add links to the definition of terms defined in a Sphinx documentation inventory. v1.0.3(4mo ago)122[2 issues](https://github.com/club-1/flarum-ext-sphinx-glossary/issues)AGPL-3.0-or-laterPHPPHP >=7.4CI passing Since Apr 17Pushed 4mo ago1 watchersCompare [ Source](https://github.com/club-1/flarum-ext-sphinx-glossary)[ Packagist](https://packagist.org/packages/club-1/flarum-ext-sphinx-glossary)[ GitHub Sponsors](https://github.com/sponsors/n-peugnet)[ RSS](/packages/club-1-flarum-ext-sphinx-glossary/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (7)Versions (8)Used By (0) CLUB1 Sphinx Glossary ===================== [](#club1-sphinx-glossary) [![License](https://camo.githubusercontent.com/398898b5adf87bbb4595fa050c0881480ef4bdfb0dd23527fb62ba4ea29c6717/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4147504c2d2d332e302d2d6f722d2d6c617465722d626c75652e737667)](https://camo.githubusercontent.com/398898b5adf87bbb4595fa050c0881480ef4bdfb0dd23527fb62ba4ea29c6717/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4147504c2d2d332e302d2d6f722d2d6c617465722d626c75652e737667) [![Latest Stable Version](https://camo.githubusercontent.com/6934d48983f584f2a3f96b2bbafbf32dcf828f25afebde8cb3d6a190144bfa1a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f636c75622d312f666c6172756d2d6578742d737068696e782d676c6f73736172792e737667)](https://packagist.org/packages/club-1/flarum-ext-sphinx-glossary) [![Total Downloads](https://camo.githubusercontent.com/ecff76f358259b39739c8354146239ac6459edf6474cd5917490ac60859c7aed/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f636c75622d312f666c6172756d2d6578742d737068696e782d676c6f73736172792e737667)](https://packagist.org/packages/club-1/flarum-ext-sphinx-glossary) [![Coverage](https://camo.githubusercontent.com/df3ea3673c6267312cc4ff0a6ef85cd04981370089ab8a30b628ea5a17f629b3/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f67682f636c75622d312f666c6172756d2d6578742d737068696e782d676c6f73736172792f6d61696e3f746f6b656e3d48464a51533443314a4b)](https://codecov.io/gh/club-1/flarum-ext-sphinx-glossary) [![Build Status](https://camo.githubusercontent.com/aaae20c215cecacc869271779e8b26c475852bffb0736ddc1dc3102c84df9dae/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f636c75622d312f666c6172756d2d6578742d737068696e782d676c6f73736172792f636865636b2e796d6c3f6272616e63683d6d61696e)](https://github.com/club-1/flarum-ext-sphinx-glossary/actions/workflows/check.yml) A [Flarum](http://flarum.org) extension. Add links to the definition of terms defined in a [Sphinx documentation](https://www.sphinx-doc.org/) inventory. [![demo image](https://camo.githubusercontent.com/8a03884c9e308a61e9aa0736bbddb20792334f624008488c37d9894bae5b4c8a/68747470733a2f2f7374617469632e636c7562312e66722f6e69636f6c61732f70726f6a656374732f666c6172756d2d6578742d737068696e782d676c6f73736172792f62616e6e65722e706e67)](https://camo.githubusercontent.com/8a03884c9e308a61e9aa0736bbddb20792334f624008488c37d9894bae5b4c8a/68747470733a2f2f7374617469632e636c7562312e66722f6e69636f6c61732f70726f6a656374732f666c6172756d2d6578742d737068696e782d676c6f73736172792f62616e6e65722e706e67) This is a quite niche extension and it is still a little bit rough around the edges but it works nicely. It could be useful if your community is gathered around a software project that defines a bunch of terms in a Sphinx documentation. For now it does not have any GUI admin panel settings. It can only be configured through the [Flarum console](https://docs.flarum.org/console/). This extension is based on the [intersphinx feature](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) of Sphinx and is configured in a similar fashion. Mappings that resemble the [`intersphinx_mapping` configuration value](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping) can be added to the database using the `sphinx:add` command. Then the `sphinx:update` command fetches and parses the corresponding inventories to populate the glossary. This command is scheduled to run daily. It uses HTTP caching and PHP streams to stay low on resources. By default only the `std:term` roles are used as glossary entries. This can be changed on a per mapping basis, using the `--role=ROLE` option. For example: ``` php flarum sphinx:add club1 https://club1.fr/docs/fr/ --role=term --role=logiciel --role=commande ``` Installation ------------ [](#installation) Install with composer: ``` composer require club-1/flarum-ext-sphinx-glossary:"*" ``` Usage ----- [](#usage) After enabling the extension from the admin panel, the following Flarum commands are available: ``` sphinx:add Add a Sphinx documentation inventory to the mapping list sphinx:list List the Sphinx inventory mappings sphinx:objects Display info about the loaded Sphinx objects sphinx:remove Remove a Sphinx documentation inventory from the mapping list and all its objects sphinx:update Update Sphinx glossary entries by downloading the latest inventories ``` ### Recommendation [](#recommendation) This extension alone does not apply the formatting changes to previously posted comments. I you want to reparse all the comments posts of the database it is recommended to install and enable the [`club-1/flarum-ext-chore-commands`](https://github.com/club-1/flarum-ext-chore-commands) extension and use its `chore:reparse` command. Updating -------- [](#updating) ``` composer update club-1/flarum-ext-sphinx-glossary:"*" php flarum migrate php flarum cache:clear ``` Development ----------- [](#development) The following tools are needed for development: - [Make](https://www.gnu.org/software/make/) - [Composer](https://getcomposer.org/) - [BusyBox](https://busybox.net/) Acknowledgement --------------- [](#acknowledgement) This extension is based on the following libraries: - [s9e\\TextFormatter](https://github.com/s9e/TextFormatter)'s [Keyword plugin](https://s9etextformatter.readthedocs.io/Plugins/Keywords/Synopsis/) - [PHP Sphinx Inventory Parser](https://github.com/club-1/sphinx-inventory-parser) Links ----- [](#links) - [Packagist](https://packagist.org/packages/club-1/flarum-ext-sphinx-glossary) - [GitHub](https://github.com/club-1/flarum-ext-sphinx-glossary) - [Discuss](https://discuss.flarum.org/d/32764) ### Health Score 32 — LowBetter than 72% of packages Maintenance57 Moderate activity, may be stable Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~166 days Recently: every ~249 days Total 7 Last Release 123d ago Major Versions v0.3.0 → v1.0.02023-05-03 ### Community Maintainers ![](https://www.gravatar.com/avatar/e9795ca225ea502ac9b23147fc8e47ca23e95e3e78e7ceb74b897ea6306aad19?d=identicon)[n-peugnet](/maintainers/n-peugnet) --- Top Contributors [![n-peugnet](https://avatars.githubusercontent.com/u/23519418?v=4)](https://github.com/n-peugnet "n-peugnet (84 commits)") --- Tags flarumflarum-extensionintersphinxsphinxsphinx-docflarum ### Embed Badge ![Health badge](/badges/club-1-flarum-ext-sphinx-glossary/health.svg) ``` [![Health](https://phpackages.com/badges/club-1-flarum-ext-sphinx-glossary/health.svg)](https://phpackages.com/packages/club-1-flarum-ext-sphinx-glossary) ``` ### Alternatives [fof/upload The file upload extension for the Flarum forum with insane intelligence. 188171.7k15](/packages/fof-upload)[fof/byobu Well integrated, advanced private discussions. 61105.8k9](/packages/fof-byobu)[fof/gamification Upvotes and downvotes for your Flarum community 4157.1k6](/packages/fof-gamification)[fof/user-bio Add a user bio to user profiles 2196.5k9](/packages/fof-user-bio)[flarum-lang/russian Russian language pack for Flarum. 13126.1k](/packages/flarum-lang-russian)[fof/drafts Allow users to create post and discussion drafts 1771.1k5](/packages/fof-drafts) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)