jon48/webtrees-lib

Library to extend webtrees core capabilities

, _(*1)

webtrees-lib

Library to extend webtrees core capabilities, _(*2)

Contents

• License
• Introduction
• List of MyArtJaub modules
• General notes
• System requirements
• Installation / Upgrading
• Issues / Security
• Contacts

License

• webtrees-lib: MyArtJaub library for webtrees
• Copyright (C) 2009 to 2022 Jonathan Jaubart.
• Derived from webtrees - Copyright (C) 2010 to 2022 webtrees development team.
• Derived from PhpGedView - Copyright (C) 2002 to 2010 PGV Development Team.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version., _(*3)

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details., _(*4)

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/., _(*5)

Introduction

Initially user of PhpGedView, I started developing some customisations and personal modules in 2009 in order either to fill some gaps in features or to adapt the software to my liking. This is when the Rural theme was first created for instance., _(*6)

When the main PGV developers moved to create webtrees, I slowly migrated my code to the new platform, taking advantage of the evolved architecture to refactor some of the modules., _(*7)

Following the further code evolutions in the version 1.7.0 of webtrees, I decided to split the library part of my code from the main webtrees-geneajaubart package, as well as renaming the modules from the too generic Perso prefix, to a more branded name: MyArtJaub (a rather bad pun on my surname...)., _(*8)

The major upgrade of webtrees from version 1 to version 2 at the end of 2019 meant that most of the code base was not compatible any longer, and required a nearly complete restructuring and rewrite of the library. It has provided the opportunity to refactor some features for better maintainability or flexibility, and the updated library can be used with webtrees 2.1.0 onwards., _(*9)

My personal and professional constraints have not allowed me to provide the same level of support as I used to, nevertheless I have always wished to share my changes with the general webtrees audience. I was maintaining an SVN repository on Assembla, but since the migration of webtrees to Github, I have as well created the current Git repositories., _(*10)

Please read carefully the instructions below, as some modules may require changes in the core code to enable all their features, hence cannot be just added to a standard webtrees installation., _(*11)

Jonathan Jaubart, _(*12)

List of MyArtJaub modules

• MyArtJaub Administrative Tasks (myartjaub_admintasks)
  • Runs administrative tasks on a scheduled manner.
• MyArtJaub Certificates (myartjaub_certificates)
  • Alternative management of certificates supporting sources.
• MyArtJaub Geographical Dispersion (myartjaub_geodispersion)
  • Provide geographical dispersion analysis on Sosa ancestors.
• MyArtJaub Hooks (myartjaub_hooks)
  • Allows hooking MyArtJaub modules in core code more easily.
• MyArtJaub Miscellaneous Extensions (myartjaub_misc)
  • Placeholder module for miscellaneous extensions.
• MyArtJaub Patronymic Lineage (myartjaub_patronymiclineage)
  • Alternative to Branches page (created before the latter).
• MyArtJaub Sosa (myartjaub_sosa)
  • Module to manage Sosa ancestors, and provide statistics.
• MyArtJaub Sources (myartjaub_issourced)
  • Provides information about the level and quality of sourced for records.
• MyArtJaub Welcome Block (myartjaub_welcome_block)
  • Merge of standard welcome and login blocks, with display of Piwik statistics

General notes

Please note that the modules are not translated directly in this library. Translations would be managed through the related module structure in the webtrees-geneajaubart project., _(*13)

System requirements

It is required to run PHP 7.4 to be able to run the webtrees-lib library. Except the above, webtrees-lib shares the same requirements and system configuration as a standard webtrees installation., _(*14)

Installation / Upgrading

The webtrees-lib needs to be integrated to a container project, as a library, and cannot be run as a standalone application., _(*15)

You can use the webtrees-geneajaubart project as a example of container project., _(*16)

webtrees-lib can be installed and updated with the composer tool., _(*17)

To install the library, run the command:, _(*18)

composer require jon48/webtrees-lib

You can as well add the following to your composer.json file:, _(*19)

json { "require": { "jon48/webtrees-lib": "*" } }, _(*20)

Then run the command:, _(*21)

composer install

In order to update the package, run the command:, _(*22)

composer update

Issues / Security

Issues should be raised in the GitHub repository for jon48/webtrees-lib., _(*23)

A security policy document has been issued for this repository., _(*24)

Contacts

General questions on the standard webtrees software should be addressed to the official forum, _(*25)

You can contact the author (Jonathan Jaubart) of the webtrees-lib and webtrees-geneajaubart projects through his personal GeneaJaubart website (link at the bottom of the page)., _(*26)