diff options
| author | Greg Roach <greg@subaqua.co.uk> | 2024-10-21 17:31:16 +0300 |
|---|---|---|
| committer | Greg Roach <greg@subaqua.co.uk> | 2024-10-21 17:31:16 +0300 |
| commit | cc04dc51ae2a42df30a0e03f276a9a5be730741e (patch) | |
| tree | 7c114d5b9a69c32419ec57184061408960ed2d85 /modules_v4 | |
| parent | 1270d2767576ed4a83917769b0ee3613e3b010bf (diff) | |
| download | webtrees-cc04dc51ae2a42df30a0e03f276a9a5be730741e.tar.gz webtrees-cc04dc51ae2a42df30a0e03f276a9a5be730741e.tar.bz2 webtrees-cc04dc51ae2a42df30a0e03f276a9a5be730741e.zip | |
Restore deleted file
Diffstat (limited to 'modules_v4')
| -rw-r--r-- | modules_v4/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/modules_v4/README.md b/modules_v4/README.md new file mode 100644 index 0000000000..131e3bea80 --- /dev/null +++ b/modules_v4/README.md @@ -0,0 +1,32 @@ +# THIRD-PARTY MODULES + +Many webtrees functions are provided by “modules”. +Modules allows you to add additional features to webtrees and modify existing features. + +## Installing and uninstalling modules + +A module is a folder containing a file called `module.php`. +There may be other files in the folder, such as CSS, JS, templates, +languages, data, etc. + +To install a module, copy its folder to `/modules_v4`. + +To uninstall it, delete its folder from `/modules_v4`. + +Note that module names (i.e. the folder names) must not contain +spaces or the characters `.`, `[` and `]`. It must also have a +maximum length of 30 characters. + +TIP: renaming a module from `<module>` to `<module.disable>` +is a quick way to hide it from webtrees. This works because +modules containing `.` are ignored. + +## Writing modules + +To write a module, you need to understand the PHP programming language. + +There are several example modules available at +https://github.com/webtrees + +The built-in modules can be found in `app/Module/`. +These contain lots of useful examples that you can copy/paste. |
