Difference between revisions of "plugins"

From GeneWeb
Jump to: navigation, search
(Plugins)
 
(start plugin descriptions)
Line 17: Line 17:
 
  plugins=pl1,pl2,pl3
 
  plugins=pl1,pl2,pl3
 
where {{c|pli}} is the name of the desired plugin.
 
where {{c|pli}} is the name of the desired plugin.
 +
 +
==Existing plugins==
 +
 +
===Cgl===
 +
The {{c|cgl}} plugin is an example of plugin whose function is limited to a post processing of the data produced by GeneWeb, removing in this data stream all occurrences of {{c|href}}.
 +
This plugin supersedes the {{c|cgl=on}} command one can add to the URL to ask for suppression of href links.
 +
 +
===V7===
 +
The v7 plugin regroups in a single place the traditional V7 behavior of GeneWeb (over time a V8 plugin may offer a new set of templates).
 +
All GUI related informations that were located in the {{c|hd}} repository folder are now located in {{c|plugins/v7/assets}}.

Revision as of 19:23, 13 August 2021

150px-Geographylogo svg.png Language: English • Deutsch • français

Plugins

GeneWeb version 7.1 offers a plugin mechanism allowing functional extensions without impacting the core operation of the system.

Developers should explore existing plugins to infer the overall mechanism, but it should be noted that such development requires a good understanding of both the OCaml language and GeneWeb itself. Developers will find plugins in the plugins folder of the GitHub repository. In the plugins folder, each plugin is in a sub_folder names pl_name_plugin. The command make distrib will compile those plugins and install then in a distribution/plugin folder. Ressources (templates, images, lexicon entries) associated with each plugin are located in an assets sub folder.

Plugins are loaded by gwd at launch time through the parameter -plugins (or -unsafe_plugins) pointing to the location of the plugins.

In addition, the user must specify in his .gwf parameter file those plugins he wants activated through a line such as:

plugins=pl1,pl2,pl3

where pli is the name of the desired plugin.

Existing plugins

Cgl

The cgl plugin is an example of plugin whose function is limited to a post processing of the data produced by GeneWeb, removing in this data stream all occurrences of href. This plugin supersedes the {{{1}}} command one can add to the URL to ask for suppression of href links.

V7

The v7 plugin regroups in a single place the traditional V7 behavior of GeneWeb (over time a V8 plugin may offer a new set of templates). All GUI related informations that were located in the hd repository folder are now located in plugins/v7/assets.