Skip to content

huhwt/huhwt-cce

Repository files navigation

webtrees module huhwt-clippings_cart_enhanced

License: GPL v3 webtrees major version

Latest Release Downloads

This webtrees custom module replaces the original 'Clippings Cart' module. It offers additional possibilities to add records to the clippings cart and owns beside the possibility to export GEDCOM information for visualizing the records in the clippings cart using a diagram.

This custom module is mainly based on the hh_clippings_cart_enhanced by Hermann Hartenthaler (https://github.com/hartenthaler/hh_clippings_cart_enhanced) and is only executable with webtrees-2.1. For webtrees-2.0 use huhwt-cce20.

For features and background of this module please have a look at the above given link.

Attention:

  This module requires to be operated in a PHP 8.2-onward system 
  environment due to some features not have been available before.

  Systems with PHP 8.1 environment have to use Release 2.1.17.0.

Contents

This Readme contains the following main sections

Description

Functions and actions for records are described in detail in the Hartenthaler module description.

This module covers all clipping actions covered in the Webtrees standard. In addition, records from 'Family List' and 'Individual List' as well as persons and families from the 'Shared Notes List' can also be taken over. huhwt-xtv (tree view extended) and huhwt-mtv (multi-tree view for admin Action “Check duplicates”) can now also transfer to the clippings cart.

The clipping actions carried out are displayed as an additional overview. Each clipping action done by CCE will be identified (example: INDI~I1 -> Individual I1 Action:'Only this record' - INDI_ANCESTOR_FAMILIES~I1 Action: 'This Person, his ancestors and their families'). You can filter the collected entries according to these actions. Each of these actions can be undone individually.

The cart's content can be stored as files on Server-Side (file location is defined by Tree-Name and User-ID, you may choose your own name). Saved files may be reloaded and added to the actual cart's content.

An action initiated by the user then takes place on the records in the clippings cart, such as

  • the export to a GEDCOM zip file, as in the actual clippings cart module
  • the export to file in plain textual GEDCOM
  • the display of the objects in list form with the possibility of sorting and filtering this list (tbd)
  • the executed collection actions are displayed in a supplementary overview and can be selectively undone - 'Undo' option. However, there is no 'Redo' option (yet).
  • the transfer of the records in the clippings cart to new functions that visualize this data or analyze it statistically. Such a function could be for example a link-node-diagram like TAM (Topographic Attribute Map) or Lineage.

The [TAM] and [Lineage] functions are provided as their own independent modules.

This module can be operated in addition to the other 'Clippings Cart' functions or replace them completely.

CAVEAT: Clippings of other 'Clippings Cart' functions can't be precisely identified because of missing references, they will get a generic identifier.

Note: Since webtrees-2.1.18 the Family-/IndividualListModule are working properly again. Nevertheless there is a recommended modification in webtrees core module 'app/Module/IndividualListModule.php'. It's reasoned by a hard-coded overdefinition for the 'lists/surnames-table' in a vesta-Module ...

line 397 - old:

echo view('lists/surnames-table', [

line 397 - new ( this mod will give you an information on the count of names in the table in the table's header )

echo view('lists/surnames-tableCCE', [

Requirements

This module requires PHP 8.2 at least. This module requires webtrees version 2.1.18 at least. This module has the same general requirements as webtrees#system-requirements.

Installation

This section documents installation instructions for this module.

  1. Download the latest release. (By now: pre-release!).
  2. Unzip the package into your webtrees/modules_v4 directory of your web server.
  3. Occasionally rename the folder to huhwt-cce. It's recommended to remove the respective directory if it already exists.

Upgrade

To update simply replace the huhwt-cce files with the new ones from the latest release.

Translation

You can help to translate this module. It uses the po/mo system. You can contribute via a pull request (if you know how) or by e-mail. Updated translations will be included in the next release of this module.

There are now translations in English, German, Netherlands, Catalan, Spanish and Russian available.

  • Netherlands - many thanks to TheDutchJewel
  • Catalan, Spanish - many thanks to BernatBanyuls
  • Russian - many thanks to ol810

Support

Issues: you can report errors raising an issue in this GitHub repository.

Forum: general webtrees support can be found at the webtrees forum

Thank you

Special thanks to hartenthaler for providing this valuable module.

License

This module was originally derived from the Vesta clippings cart module.

  • Copyright (C) 2022/2023 huhwt - EW.H
  • Copyright (C) 2021 Hermann Hartenthaler
  • Copyright (C) 2021 Richard Cissée. All rights reserved.
  • Derived from webtrees - Copyright 2022 webtrees 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.

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.

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