Changes

Jump to: navigation, search

Addon:Media Verify Tool

2,347 bytes added, 31 January
m
no edit summary
{{Third-party plugin}}
[[File:MediaVerifyTool-default-51.png|thumb|right|450px|Media Verify Tool - dialog - default]]
The {{man label|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 ==The main purpose of the tool is to locate files that have been moved and fix the paths.
This tool uses [https://en.wikipedia.org/wiki/MD5 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 ==
[[File:EditPreferences-General-tab-example-51.png|Right|thumb|450px|Preferences - General tab showing the "Base path for relative media paths" setting ]]
This The {{man label|Media Verify Tool}} tool assumes that you store all your media files under a media directory. You can specify this directory by setting the {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Settings#General|Base path for relative media paths]]}} in the {{man label|General}} tab, under the {{man menu|Edit->Preferences}} menu option.{{-}}
== Usage ==
The {{man label|Media Verify Tool}} dialog is display with the following choices:
* The {{man button|Close}} button when selected will exit the tool.
* The {{man button|[[Media_Verify_ToolAddon:Media Verify Tool#Generate|Generate]]}} button will generate MD5 checksums for all media objects.* The {{man button|[[Media_Verify_ToolAddon:Media Verify Tool#Verify|Verify]]}} button will perform various checks against your media objects in Gramps and media files under your media directory. * The {{man button|[[Media_Verify_ToolAddon:Media Verify Tool#Export|Export]]}} button when selected will export the report as a text file.* The {{man button|[[Media_Verify_ToolAddon: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_ToolAddon:Media Verify Tool#Moved.2FRenamed_Files|Moved/Renamed Files]]}} section tab.
{{-}}
=== Generate ===
[[File:Results-from-generate-media-verify-tool.png|leftright|thumb|550px]]Clicking the {{man button|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. Resulting {{man label|Errors}} will be displayed in the tab if any.
{{-}}
=== Verify ===
Clicking the {{man button|Verify}} button will perform various checks against your media objects in Gramps and media files under your media directory and display the following section tabs only if that type of issue is present eg:
* {{man label|[[Addon:Media Verify Tool#Moved.2FRenamed_Files|Moved/Renamed Files]]}} -
* {{man label|[[Addon:Media Verify Tool#Missing_Files|Missing Files]]}} -
* {{man label|[[Addon:Media Verify Tool#Duplicate_Files|Duplicate Files]]}} -
* {{man label|[[Addon:Media_Verify_Tool#Extra_Files|Extra Files Files]]}} -
* {{man label|[[Addon:Media Verify Tool#No_MD5_Generated|No MD5 Generated]]}} -
Clicking the {{man button|Verify-}} button will perform various checks against your media objects in Gramps and media files under your media directory. 
==== Moved/Renamed Files ====
 [[ImageFile:MediaVerifyTool1.png|thumb|right|550px|]]
Files that have moved or renamed are listed in the {{man label|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 ====
 [[ImageFile:MediaVerifyTool2.png|thumb|right|550px|]]
Media objects are listed in the {{man label|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 ====
 [[ImageFile:MediaVerifyTool3.png|thumb|right|550px|]]
Files with duplicate checksums are listed in the {{man label|Duplicate Files}} tab.
Double clicking on a row will display the image in the default viewer.
{{-}}==== Extra Files Files ==== [[ImageFile:MediaVerifyTool4.png|thumb|right|550px|]]
Files that are under the media directory, but not yet in Gramps are listed in the {{man label|Extra Files}} tab.
Double clicking on a row will display the image in the default viewer.
{{-}}
==== No MD5 Generated ====
 [[ImageFile:MediaVerifyTool5.png|thumb|right|550px|]]
Media objects with no checksum are listed in the {{man label|No MD5 Generated}} tab.
Double clicking on a row will edit the associated media object.
{{-}}
=== Export ===
Clicking the {{man button|Export}} button will export show the {{man label|Export results to a text file}} dialog so you can save the report as a . ==== Example results text file ====The results text filewhen viewed will show each type of issue displayed in its own section. <pre>Missing Files 1897_expeditionsmannschaft_rio_a.jpg Gunnlaugur_Larusson_-_Yawn.jpg 654px-Aksel_Andersson.jpg Alimehemet.jpg E_W_Dahlgren.jpg AntoineClaudet.png scanned_microfilm.png</pre>
=== Fix ===
Clicking the {{man button|Fix}} button will fix the paths in the media objects to match the new paths listed in the listed in the {{man button|Verify}} - {{man label|[[Media_Verify_ToolAddon:Media Verify Tool#Moved.2FRenamed_Files|Moved/Renamed Files]]}} section tab. == See also==* The builtin {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Tools#Media_Manager|Media Manager]]}} which is group of four separate tools that allows you to do the following:** {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Tools#Replace_substrings_in_the_path|Replace substrings in the path]]}}** {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Tools#Convert_paths_from_relative_to_absolute|Convert paths from relative to absolute]]}}** {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Tools#Convert_paths_from_absolute_to_relative|Convert paths from absolute to relative]]}}** {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Tools#Add_images_not_included_in_database|Add images not included in database]]}} * The Third-party Addon {{man label|[[Addon:MediaMerge|Merge Media]]}} that searches your database for media file entries that are pointing to the same actual file and when found, they can be merged together. * [[Media Management]]
== Issues ==
* Add a help button pointing here
* {{bug|7144}} Media Verify: wrong handling of non-ascii characters
* {{bug|6744}} Add Merge for Media Verify Plugin
* Removing unused duplicate files.
* Creating media objects for unused files.
* Add a help button pointing here
 
[[Category:Plugins]]
[[Category:Developers/General]]
[[Category:Media]]

Navigation menu