Download the PHP package club-1/flarum-ext-sphinx-glossary without Composer

On this page you can find all versions of the php package club-1/flarum-ext-sphinx-glossary. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of club-1/flarum-ext-sphinx-glossary

Informations about the package flarum-ext-sphinx-glossary

CLUB1 Sphinx Glossary

License Latest Stable Version Total Downloads Coverage Build Status

A Flarum extension. Add links to the definition of terms defined in a Sphinx documentation inventory.

demo image

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.

This extension is based on the intersphinx feature of Sphinx and is configured in a similar fashion. Mappings that resemble the intersphinx_mapping configuration value 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

Install with composer:

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

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 extension and use its chore:reparse command.

Updating

Development

The following tools are needed for development:

Acknowledgement

This extension is based on the following libraries:

Links

All versions of flarum-ext-sphinx-glossary with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
ext-curl Version *
club-1/sphinx-inventory-parser Version ^1.0
flarum/core Version ^1.2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package club-1/flarum-ext-sphinx-glossary contains the following files

Loading the files please wait ....