Difference between revisions of "Addon:Media Verify Tool"

From Gramps
Jump to: navigation, search
(Usage)
(Usage)
Line 20: Line 20:
 
* The {{man button|[[Media_Verify_Tool#Verify|Verify]]}} button  
 
* The {{man button|[[Media_Verify_Tool#Verify|Verify]]}} button  
 
* The {{man button|[[Media_Verify_Tool#Export|Export]]}} button when selected will export the report as a text file.
 
* The {{man button|[[Media_Verify_Tool#Export|Export]]}} button when selected will export the report as a text file.
* The {{man button|[[Media_Verify_Tool#Fix|Fix]]}} button will fix the paths in the media objects to match the new paths listed in the {{man button|Verify)) - {{man label|[[Media_Verify_Tool#Moved.2FRenamed_Files|Moved/Renamed Files]]}} section tab.
+
* The {{man button|[[Media_Verify_Tool#Fix|Fix]]}} button will fix the paths in the media objects to match the new paths listed in the {{man button|Verify}} - {{man label|[[Media_Verify_Tool#Moved.2FRenamed_Files|Moved/Renamed Files]]}} section tab.
  
 
{{-}}
 
{{-}}

Revision as of 22:24, 19 May 2020

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager.

Media Verify Tool - dialog - default

The Media Verify Tool is used verify a one-to-one relationship between media objects and files in the media directory. The main purpose of the tool is to locate files that have been moved and fix the paths.

Purpose

This tool uses MD5 checksums to verify the integrity of files under the media directory. It also allows users to use a file manager of their choice to manage media objects.

Preparation

This tool assumes that you store all your media files under a media directory. You can specify this directory by setting the Base path for relative media paths in the General tab, under the Edit->Preferences menu option.

Usage

Media Verify Tool - dialog - default

You can access the tool from the Tools > Utilities > Media Verify... menu.

The Media Verify Tool dialog is display with the following choices:

  • The Close button when selected will exit the tool.
  • The Generate button
  • The Verify button
  • The Export button when selected will export the report as a text file.
  • The Fix button will fix the paths in the media objects to match the new paths listed in the Verify - Moved/Renamed Files section tab.


Generate

Results-from-generate-media-verify-tool.png

Clicking the Generate button will generate MD5 checksums for all media objects. You should run this after you have added or changed any media files. Media objects without MD5 checksums will be listed as part of the media verification.

Verify

Clicking the Verify button will perform various checks against your media objects in Gramps and media files under your media directory.

Moved/Renamed Files

MediaVerifyTool1.png

Files that have moved or renamed are listed in the Moved/Renamed Files tab. Where there are multiple files with the same checksum under the media directory, the first one listed with the same name as the original will be displayed.

Double clicking on a row will edit the associated media object.

Missing Files

MediaVerifyTool2.png

Media objects are listed in the Missing Files tab, when there is no file found with a matching checksum.

Double clicking on a row will edit the associated media object.

Duplicate Files

MediaVerifyTool3.png

Files with duplicate checksums are listed in the Duplicate Files tab.

Double clicking on a row will display the image in the default viewer.

Extra Files Files

MediaVerifyTool4.png

Files that are under the media directory, but not yet in Gramps are listed in the Extra Files tab.

Double clicking on a row will display the image in the default viewer.

No MD5 Generated

MediaVerifyTool5.png

Media objects with no checksum are listed in the No MD5 Generated tab.

Double clicking on a row will edit the associated media object.

Export

Clicking the Export button will export the report as a text file.

Fix

Clicking the Fix button will fix the paths in the media objects to match the new paths listed in the Moved/Renamed Files section.

Issues

  • 7144 Media Verify: wrong handling of non-ascii characters
  • 6744 Add Merge for Media Verify Plugin

Possible future enhancements

This tool could be enhanced to perform other tasks, such as:

  • Merging media objects with duplicate files.
  • Updating the checksum for modified files.
  • Removing unused duplicate files.
  • Creating media objects for unused files.
  • Add a help button pointing here