IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation referring to the deprecated gnc:module wrapper

Browse Source
This commit is contained in:
Geert Janssens 2019-11-24 15:32:23 +01:00
parent b96dc6ff89
commit 95b81844ad
2 changed files with 14 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/examples/README_invoice
View File

@ -1,6 +1,4 @@
The Bill Invoice importer is an optional module and needs to enabled by editing the file $HOME/.gnucash/config.user, adding the line: Some notes on the bill and invoice importer:
(gnc:module-load "gnucash/plugins/bi_import" 0)
The example csv file must have the 22 elements for it to work. The example csv file must have the 22 elements for it to work.

30
libgnucash/gnc-module/doc/design.txt
View File

@ -68,27 +68,24 @@ gnc_module_description should return a newly-allocated 1-line
description of what the module does. This can be displayed by GUI description of what the module does. This can be displayed by GUI
elements to allow users to select modules to load. elements to allow users to select modules to load.
While the module system used to have wrappers for scheme access
this functionality is now deprecated. Scheme code should no longer
try to use any gnc-module functionality. All C code that is potentially
useful for scheme has been or can be wrapped using swig. That wrapped
code can be made available to scheme code using guile's load-extension
functionality. For convenience, most of this wrapped code is
accompanied by a scheme module that handles the load-extension part for you.
So in most cases simply calling (use-module (gnucash <module-name>)) will
do the trick.
Initializing the module system Initializing the module system
------------------------------ ------------------------------
Somewhere at program startup time, you need to call Somewhere at program startup time, you need to call
gnc_module_system_init from C (see below from Scheme). This scans the gnc_module_system_init from C. This scans the
directories in the GNC_MODULE_PATH and builds a database of the directories in the GNC_MODULE_PATH and builds a database of the
available modules. available modules.
In Scheme, you need to (use-modules (gnucash gnc-module)) and call
(gnc:module-system-init) if it was not called from C. You will need
to use-modules this module is you intend to use any module system
functions from Scheme.
On the Scheme side, gnc:module-system-init is not a g-wrapped
function. It uses Guile's dynamic-link to open the libgncmodule.la
library directly and call gnc_module_system_init. dynamic-link uses
lt_dlopen() under the hood, so you need to make sure that the
libgncmodule.la install directory is in your LD_LIBRARY_PATH or
LTDL_LIBRARY_PATH. The Gnucash app will set up this path by default.
You can rebuild the module database at any time (say, if you know a You can rebuild the module database at any time (say, if you know a
new module has been installed or the user has changed the module path new module has been installed or the user has changed the module path
via some in-program mechanism) by calling gnc_module_system_refresh. via some in-program mechanism) by calling gnc_module_system_refresh.
@ -96,10 +93,9 @@ via some in-program mechanism) by calling gnc_module_system_refresh.
Loading modules Loading modules
--------------- ---------------
From C call gnc_module_load(path, interface), or gnc:module-load from From C call gnc_module_load(path, interface). This returns a GNCModule
Scheme. This returns a GNCModule (<gnc:module>) if a qualifying if a qualifying module was successfully loaded, FALSE otherwise.
module was successfully loaded, #f / FALSE otherside. GNCModule is an GNCModule is an opaque type.
opaque type.
A qualifying module is any module whose gnc_module_path matches the A qualifying module is any module whose gnc_module_path matches the
path specification and for whom "interface" falls between path specification and for whom "interface" falls between