Translations of this page:
  • Printable version
  • Tell by mail
  • Export to OpenOffice
  • Export to PDF
  • Export to csv
  • Export to Timeline
  • Add page to book
  • Tools:

FusionDirectory plugins organization

The directories in a FusionDirectory plugins are standardized, it looks like this :

drwxr-xr-x  3 benoit benoit  80 19 oct 18:56 addons
drwxr-xr-x  4 benoit benoit 104 19 oct 18:56 admin
drwxr-xr-x  2 benoit benoit  80 19 oct 18:56 config
drwxr-xr-x  2 benoit benoit  80 19 oct 18:56 contrib
drwxr-xr-x  3 benoit benoit 104 19 oct 18:56 html
drwxr-xr-x  3 benoit benoit 104 19 oct 18:56 ihtml
drwxr-xr-x 14 benoit benoit 368 19 oct 18:56 locale
drwxr-xr-x  3 benoit benoit  80 19 oct 18:56 personal
drwxr-xr-x  3 benoit benoit 104 19 oct 18:56 includes

addons = This dir is used if the plugin put things in the addons menu cateory

admin = This dir is the main dir for all plugins going into the admin menu cateory

config = This dir is the configuration dir, used if the plugin need to store option in ldap

contrib = This dir is used to put all the contributed files like schema, docs, manpages etc..

html = This dir is used to put all the images or other public files

ihtml = This dir is used to put all the smarty template files

locale = This dir is used for localization of the plugin

personal = This dir is used when plugin is to be used to manage user properties

include = This dir is used for files available for inclusion for other plugins

Subdirectories in each of the main directories

contrib :

opendlap = Schemas for the openldap server

docs = Documentation how to use the plugin

html :

at the root of this folder files that should be copied into the root of the <fd_dir>/html folder ex: collect.php from the fusioninventory plugin that sit in /fusioninventory/html/collect.php

plugins/<name_of_plugin>/images = images for plugin (Only if they are not icons)

themes/<fd_theme_name> = icons for plugin

Newer plugin adds their icons as part of the default theme to use the icon theme specification and allow themes to change these icons.

For instance themes/breezy/icons/48/apps/myapp.png for a 48×48 icon for your application.

ihtml :

themes/<fd_theme_name> = template for smarty in .tpl form for this plugin (<fd_theme_name> should be breezy which is the default theme)

locale :

en = iso code for language

en = directory where to put the message file

addons, admin, config, personal :

Should contain a subdirectory named as the plugin, or as an other plugin which we extend. For instance, argonaut plugin contains admin/systems/argonaut/class_argonautClient.inc

Installation of a plugin

For addons, admin, config, and personal folders, the content should go into <fd_dir>/plugins/<dir>/

For html, ihtml, include, the content should go into <fd_dir>/<dir>/

For contrib/openldap, the content should go into <ldap_schemas_dir>/fusiondirectory/

For contrib/etc, the content should go into /etc/fusiondirectory/<plugin_name>.

For contrib/doc, the content may go into <doc_dir>/fusiondirectory-plugin-<plugin_name>.

Special cases:

  • in html/themes/<theme_name>, svg folder may be ignored
  • content of locale goes into <fd_dir>/locale/plugins/<plugin_name>/locale/
en/documentation_dev/plugins_organization.txt · Last modified: 2017/07/24 09:36 by Côme Chilliet
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0