Difference between revisions of "Media Management"

From Gramps
Jump to: navigation, search
(Gioto moved page Media Management to Media Management in Gramps: bring in line with other pages eg https://gramps-project.org/wiki/index.php/Places_in_Gramps)
(Tag: New redirect)
 
m (Media Objects in Gramps are not the actual Media Files)
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
#REDIRECT [[Media Management in Gramps]]
+
<!-- Gramps webmaster has instructed us to not include a Language bar until at least 1 translation exists.
 +
{{Languages|Media Management}}
 +
-->
 +
This page is intended to be a discussion of improving the management of a collection of supporting documents related to a genealogy Tree.  Since Gramps has limited built-in facilities related to managing external files, the techniques will focus on workarounds and using external tools in concert with Gramps.
 +
 
 +
A good discussion will need contributions from many perspectives. Please jump in and widen its currently narrow perspective. But multiple simultaneous WikiContributors can step on each other's edits in MediaWiki pages. To avoid this, edit individual sections instead of the entire page.  To add new content, start by [https://wikibooks.org/wiki/MediaWiki_User_Guide/Sections_and_Headings adding a Section Heading] (subtitle) at the bottom of the section above and save the Edit. Then click the '''''&#91;edit]''''' hotlink beside your newly created section's subtitle.
 +
 
 +
{{stub}}
 +
[[File:Gramps-media.png|left]]A [[Gramps_Glossary#media|Media]] Object describes an external file that holds media data, such as a scanned page, audio recording or a video recording. Media files can also be in document formats, such as a text file (<code>[https://wikipedia.org/wiki/TXT .txt]</code>), portable document file (<code>[https://wikipedia.org/wiki/PDF .pdf]</code>), word processing document (<code>[https://wikipedia.org/wiki/DOC .doc]</code>), a web page (<code>[https://wikipedia.org/wiki/HTML .html]</code>, <code>[https://wikipedia.org/wiki/MHTML .mthml]</code>), as well as any number of other file formats.
 +
 
 +
The “content” of the Media Object element is not the object itself but merely information about the object. The external file that contains the object is named by the xlink:href attribute.
 +
== Media Objects in Gramps are not the actual Media Files ==
 +
Gramps does not manage {{icon|medi}} Media files.  Instead, it is more similar to a [https://wikipedia.org/wiki/Metadata metadata] manager. That means that Media object actions of: moving to another Gallery tab, duplicating, deleting, or merging; will do nothing to the actual Media file. They simply rearrange the pointers to those files. 
 +
 
 +
There are exceptions. The creation and restoring of backup archives includes the option to include file copies of Media objects. And some Media related addons recognize paths with internet URLs and have the option to automatically download and shelve copies somewhere on local storage devices. Gramps also manages thumbnails and downloaded map tiles in the [[Gramps_{{man version}}_Wiki_Manual_-_User_Directory|User Directory]].
 +
 
 +
[[File:Broken_Media_Path.png|thumb|right|283px|The Media Object Editor with an invalid file path.]]However, the majority of the tasks managing of Media Objects must be performed outside of Gramps. You can just toss objects into a directory and link to them.  But this will contrive a disorganized mess that will quickly become a maintenance nightmare. If the files have to be reorganized, Gramps will lose track of those files until you correct the paths. In the meantime the links will have a 'broken' indicator.
 +
{{-}}
 +
 
 +
== Select an Organizational System ==
 +
There are groups of genealogist who share organizational system ideas for genealogical resources.  And many feel most comfortable extending the metaphor for those systems for their digital resources too. So if their home library is organized with color-coding, labeling patterns and file boxes; they try to replicate the system with their digital resources too.
 +
 
 +
Before computerization, the metadata system used by libraries consisted of 3 duplicate index card catalog sets... sorted by: Title, Author & Subject. Maintaining an effective index required carefully sequencing the reference materials on the shelves sorted by a 4th addressing system. (Such as the Dewey Decimal system.)
 +
 
 +
=== Manual Approach ===
 +
* [[Organise_your_records]]
 +
** [[Organise_your_files|Examples of how Gramps Users have organized digital files]]
 +
** [[Portable_Filenames|Portable filenames]]
 +
** [[Meaningful_filenames|Meaningful filenames]]
 +
=== Document Management Systems ===
 +
https://medium.com/@MarktrHimanshu/top-10-free-and-open-source-document-management-system-ddd4265adf5e
 +
 
 +
== Relative Media filepaths ==
 +
 
 +
Unlike most Preferences items, the Base path for relative media paths is stored in the Tree data.  For the '''Extensible Markup Language ''' [http://wikipedia.org/wiki/XML XML] archival <code>[[Gramps_XML|.gramps]]</code> format, there is a <code><mediapath></code> element in the Header chunk. This means that a different media path may be set for each separate Tree.
 +
 
 +
Here is the XML pseudo code sample:
 +
  <header>
 +
    <created date="2020-11-01" version="GrampsAIO64-5.1.3-2"/>
 +
    <researcher>
 +
    </researcher>
 +
    <mediapath>C:\Users\<user_name>\Pictures</mediapath>
 +
  </header>
 +
 
 +
== See also==
 +
* [[Organise_your_records]]
 +
** [[Organise_your_files|Examples of how Gramps Users have organized digital files]]
 +
** [[Portable_Filenames|Portable filenames]]
 +
** [[Meaningful_filenames|Meaningful filenames]]
 +
 
 +
* Discourse Forum: [https://gramps.discourse.group/t/import-sources-in-bulk/860/4 bulk import of Sources and Media]
 +
* Discourse Forum: [https://gramps.discourse.group/t/working-with-media-files/872 Working with Media Files]
 +
* Discourse Forum: [https://gramps.discourse.group/t/default-media-path-storage/79 Default Media Path Storage]
 +
* Discourse Forum: [https://gramps.discourse.group/t/wrong-thumbnails-after-changing-image/156/2 Wrong Thumbnails After Changing Image]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Categories#Media_Category|Media Category]]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_brief#Adding_photos_and_other_media_objects|Adding photos and other media objects]]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Editing_information_about_media_objects|Editing information about media objects]]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Editing_media_object_references|Editing media object references]]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gallery|Gallery tab]] and [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Gallery|Gallery Gramplet]]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_3#Merge_Media_Objects|Merge Media Objects]]
 +
 
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Settings#General_Gramps_settings|{{man label|Base path for relative media paths:}}]] where you can fill in a base path for the media objects. Selecting the {{man button|Directory}} button gives you a {{man label|Select media directory}} editor where you can fill in the required path.
 +
 
 +
* Built-in: [[Gramps_{{man version}}_Wiki_Manual_-_Tools#Media_Manager|Media Manager]] tool on [https://github.com/gramps-project/gramps/blob/master/gramps/plugins/tool/mediamanager.py GitHub]
 +
* Add-on: [[Addon:MediaBrowserGramplet|MediaBrowser]] Gramplet on [https://github.com/gramps-project/addons-source/tree/master/MediaBrowser GitHub]
 +
* Add-on: [[Addon:DownloadMedia|Download Media]] on [https://github.com/gramps-project/addons-source/tree/master/DownloadMedia GitHub]
 +
* Add-on: [[Addon:MediaMerge|Media Merge]] on [https://github.com/gramps-project/addons-source/tree/master/MediaMerge GitHub]
 +
* Add-on: [[Addon:MediaReport|Media Report]] on [https://github.com/gramps-project/addons-source/tree/master/MediaReport GitHub]
 +
* Add-on: [[Media_Verify_Tool|Media Verify]] on [https://github.com/gramps-project/addons-source/tree/master/MediaVerify GitHub]
 +
The Third-party Addon
 +
* Add-on: [[Photo_Tagging_Gramplet|Photo Tagging]] Gramplet on [https://github.com/gramps-project/addons-source/tree/master/PhotoTaggingGramplet GitHub]
 +
* Add-on: [[Addon:ThumbnailGenerator|Thumbnail generator]] on [https://github.com/gramps-project/addons-source/tree/master/ThumbnailGenerator GitHub]
 +
* Add-on: [[Addon:AvatarGenerator|Avatar Generator]] on [https://github.com/gramps-project/addons-source/tree/master/AvatarGenerator GitHub]
 +
 
 +
* 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|Media Merge]]}} that searches your database for media file entries that are pointing to the same actual file and when found, they can be merged together.
 +
 +
* The Third-party Addon {{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.
 +
 
 +
 
 +
 
 +
 
 +
{{DEFAULTSORT:How do I...new category location|noreplace}}
 +
[[Category:Tutorials]]
 +
[[Category:WikiContributors]]
 +
[[Category:How do I...]]
 +
 
 +
<!--
 +
<div style="background:lightcyan">
 +
 
 +
 
 +
Paste the raw '''[[:Category:Tutorials|Tutorials]]''' outline for the '''[[:Category:How_do_I...|How Do I...]]''' article above the '''See also''' section. This might start with pasting in a copy of a useful thread from one of the Gramps maillists.
 +
 
 +
 
 +
Saving this file as a 'work in progress' will insert the code behind this reference template. (Preview only show the results, not the markup formatting control.) You can use the appended special formatting example template to pre-populate a virtual Copy&amp;Paste clipboard.  Snip pieces to paste special formatting to enhance the outline.
 +
 
 +
----
 +
 
 +
Adding a ''feature documentation'' link pointing to the introduction of the interface element in the wiki will relieve you of the burden explaining how to find the feature.
 +
 
 +
Finding a ''[[Gramps_Glossary|Gramps Glossary]] term'' to link may be easier than choosing the best introductory section in the wiki.
 +
  <small>&#91;&#91;Gramps_Glossary#active_person|Active Person]]
 +
  &#91;&#91;Gramps_Glossary#P|Primary Object]]</small>
 +
Glossary terms (like [[Gramps_Glossary#active_person|Active Person]] above) are normally lowercase and use an underscore between words. They have a brief description and may already have the introductory text and practical tutorial linked. You can fall back to the Letter index (like using '[[Gramps_Glossary#P|P]]' with [[Gramps_Glossary#P|Primary Object]] above) if you don't know the exact entry.
 +
 
 +
Since most of these ''How do I...'' tutorials are likely to have been prompted by a MailList discussion, a set of example 'See also' link are included for reference.
 +
 
 +
Pointing the ''maillist archived thread'' link to the original message that inspired the tutorial give proper credit for the idea &amp; reveals the background discussion.
 +
 
 +
Pointing another link to a good search phrase for the archive allows similar discussions to be explored.
 +
 
 +
----
 +
 
 +
Once the tutorial Preview is satisfactory, save a revision of the document. Then clean out the virtual Copy&amp;Paste clipboard cluttering up your tutorial and save a final revision.
 +
 
 +
 
 +
To remove the virtual Copy&amp;Paste clipboard, simply delete everything from the beginning of this section to the bottom of the document. It is all disposable.
 +
 
 +
If the Copy&amp;Paste clipboard is needed again, simply paste the following line at the end of the Edit box, Save a revision, &amp; edit again.(Previewing isn't enough... a revision must be saved.)
 +
<pre>  {{subst:Template:How_do_I}}</pre>
 +
Other wiki [[:Category:Templates|Templates]] can be used as virtual Copy&amp;Paste clipboards in the same way.
 +
 
 +
 
 +
</div>
 +
[[Write_a_%22How_Do_I...%22_Article|Writing a 'How do I...' article.]]
 +
<pre>
 +
{{subst:Gramps_{{man version}}_Wiki_Manual_-_Preface}}
 +
{{subst:WikiContributorRecruiting}
 +
</pre>
 +
----
 +
 
 +
== (Section) ==
 +
Stub, english (''default'')
 +
{{Stub}}
 +
 
 +
{{Stub|fr}}
 +
Stub, french
 +
 
 +
=== Embeddable Snippets (Subsection) ===
 +
Icons
 +
: {{icon|gram}} Dashboard
 +
: {{icon|peop}} People
 +
: {{icon|rela}} Relationships
 +
: {{icon|fami}} Family Families
 +
: {{icon|ance}} Charts
 +
: {{icon|even}} Events
 +
: {{icon|plac}} Places
 +
: {{icon|geog}} Geography
 +
: {{icon|sour34}} Sources
 +
: {{icon|cite}} Citations
 +
: {{icon|repo}} Repositories
 +
: {{icon|medi}} Media
 +
: {{icon|note}} Notes
 +
:[[Template:Icon/doc|more of the standard icons]]
 +
 
 +
<small>
 +
{|
 +
|+ List object tools
 +
|-
 +
! style="width: 70px"|
 +
! style="width: 70px"|
 +
! style="width: 70px"|
 +
! style="width: 70px"|
 +
! style="width: 70px"|
 +
! style="width: 70px"|
 +
|-
 +
!{{icon|stock_add}}
 +
!{{icon|share}}
 +
!{{icon|stock_edit}}
 +
!{{icon|stock_remove}}
 +
!{{icon|up}}
 +
!{{icon|down}}
 +
|-
 +
! Add
 +
! Share
 +
! Edit
 +
! Remove
 +
! <small>Move<br /></small>Upwards
 +
! Move<br />Downwards
 +
|}
 +
</small>
 +
 
 +
==== [[Help:Formatting|Text formatting]] (Level 2 Subsection) ====
 +
''italic'', '''bold''', '''''bold & italic'''''
 +
===== [[Help:Images|Images]] (Level 3 Subsection) =====
 +
[[File:ChartsCategory-desendantfan-fullcircle-9gen-default-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} A screenshot caption]]
 +
[[Image:Gramps-logo.png|Logo]]
 +
 
 +
*[[Screenshots|Screenshots]]
 +
*[[Special:PrefixIndex|Templates]]
 +
====== Annotations of User Activities  (Level 4 Subsection) ======
 +
 
 +
*<pre>Commands you type at the command line</pre>
 +
 
 +
*''Filenames'' or <code>Filenames</code>
 +
 
 +
*<tt>''Replaceable text''</tt>
 +
 
 +
*{{man label|Labels}} for buttons and other portions of the graphical interface
 +
 
 +
*{{man tooltip|hint text}} for roll-over tooltip hints that identify elements of the graphical interface
 +
 
 +
*Menu selections look like this: {{Man menu|Menu &#x27a1; Submenu &#x25B6; Menu Item}} (always pad unicode symbols like these arrows with spaces so that robot translators see recognizable words)
 +
* Pop-up menu down {{man button|&#x25BC;}} arrowhead, (triangle) button
 +
 
 +
*{{man button|Buttons}}  you can click
 +
 
 +
*{{Man key press|CTRL|D}} see [[Gramps_{{man version}}_Wiki_Manual_-_Keybindings|Keybindings]] for a list of keyboard combinations used in Gramps.
 +
 
 +
*<tt>Anything you type in</tt>
 +
 
 +
*{{checkbox|1|Checked}} - [[Template:Checkbox|Selected Checkbox]] &#x2611; template
 +
*{{checkbox|0|Unchecked}} - Checkbox that is &#x274f; unselected
 +
 
 +
== Boxed annotations ==
 +
{{man tip| 1=Title of Tip |2=Tips text.}}
 +
{{man note|Example Note |Notes text.}}
 +
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
 +
 
 +
-->

Latest revision as of 13:31, 8 September 2021

This page is intended to be a discussion of improving the management of a collection of supporting documents related to a genealogy Tree. Since Gramps has limited built-in facilities related to managing external files, the techniques will focus on workarounds and using external tools in concert with Gramps.

A good discussion will need contributions from many perspectives. Please jump in and widen its currently narrow perspective. But multiple simultaneous WikiContributors can step on each other's edits in MediaWiki pages. To avoid this, edit individual sections instead of the entire page. To add new content, start by adding a Section Heading (subtitle) at the bottom of the section above and save the Edit. Then click the [edit] hotlink beside your newly created section's subtitle.

Gramps-notes.png

Please update or expand this section.


Gramps-media.png

A Media Object describes an external file that holds media data, such as a scanned page, audio recording or a video recording. Media files can also be in document formats, such as a text file (.txt), portable document file (.pdf), word processing document (.doc), a web page (.html, .mthml), as well as any number of other file formats.

The “content” of the Media Object element is not the object itself but merely information about the object. The external file that contains the object is named by the xlink:href attribute.

Media Objects in Gramps are not the actual Media Files

Gramps does not manage Media Media files. Instead, it is more similar to a metadata manager. That means that Media object actions of: moving to another Gallery tab, duplicating, deleting, or merging; will do nothing to the actual Media file. They simply rearrange the pointers to those files.

There are exceptions. The creation and restoring of backup archives includes the option to include file copies of Media objects. And some Media related addons recognize paths with internet URLs and have the option to automatically download and shelve copies somewhere on local storage devices. Gramps also manages thumbnails and downloaded map tiles in the User Directory.

The Media Object Editor with an invalid file path.

However, the majority of the tasks managing of Media Objects must be performed outside of Gramps. You can just toss objects into a directory and link to them. But this will contrive a disorganized mess that will quickly become a maintenance nightmare. If the files have to be reorganized, Gramps will lose track of those files until you correct the paths. In the meantime the links will have a 'broken' indicator.


Select an Organizational System

There are groups of genealogist who share organizational system ideas for genealogical resources. And many feel most comfortable extending the metaphor for those systems for their digital resources too. So if their home library is organized with color-coding, labeling patterns and file boxes; they try to replicate the system with their digital resources too.

Before computerization, the metadata system used by libraries consisted of 3 duplicate index card catalog sets... sorted by: Title, Author & Subject. Maintaining an effective index required carefully sequencing the reference materials on the shelves sorted by a 4th addressing system. (Such as the Dewey Decimal system.)

Manual Approach

Document Management Systems

https://medium.com/@MarktrHimanshu/top-10-free-and-open-source-document-management-system-ddd4265adf5e

Relative Media filepaths

Unlike most Preferences items, the Base path for relative media paths is stored in the Tree data. For the Extensible Markup Language XML archival .gramps format, there is a <mediapath> element in the Header chunk. This means that a different media path may be set for each separate Tree.

Here is the XML pseudo code sample:

 <header>
   <created date="2020-11-01" version="GrampsAIO64-5.1.3-2"/>
   <researcher>
   </researcher>
   <mediapath>C:\Users\<user_name>\Pictures</mediapath>
 </header>

See also

  • Base path for relative media paths: where you can fill in a base path for the media objects. Selecting the Directory button gives you a Select media directory editor where you can fill in the required path.

The Third-party Addon

  • The Third-party Addon Media Merge that searches your database for media file entries that are pointing to the same actual file and when found, they can be merged together.
  • The Third-party Addon 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.