Difference between revisions of "Addon:MediaReport"

From Gramps
m (add lang box)
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Third-party plugin}}
+
{{languages|Addon:MediaReport}}
 
+
{{Third-party addon}}
 
[[File:Media Report Example.png|thumb|right|450px|Media Report - example output]]
 
[[File:Media Report Example.png|thumb|right|450px|Media Report - example output]]
 +
The {{man label|Media Report}} is a text report for an image. The report allows custom headings and custom notes as well as the image data like notes, citations, tags, attributes and people references and image map reference regions.
  
The {{man label|Media Report}} is a text report for images. The report allows custom headings and custom notes as well as the image data like notes, citations, tags, attributes and people references.
+
This report is especially useful in displaying image map reference regions for a photo eg: a Family reunion photo as each persons face can be identified.
 +
__TOC__
 +
==Usage==
 +
[[File:MediaReport-dialog-addon-ReportOptions-tab-defaults-60.png|thumb|right|450px|Media Report - Report Option dialog -  defaults]]
  
{{-}}
 
==Usage==
 
Once this addon has been installed:
 
 
* Select Menu {{man menu|Reports > Text Reports -> Media Report...}}
 
* Select Menu {{man menu|Reports > Text Reports -> Media Report...}}
 +
** You will be shown the {{man label|Undo history warning}} dialog  where you can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
  
{{man warn|Undo history warning|Proceeding with this tool will erase the undo history for this session. In particular, you will not be able to revert the changes made by this tool or any changes made prior to it. If you think you may want to revert running this tool, please stop here and [[How_to_make_a_backup|backup]] your database.}}
+
* The {{man label|Report Options}} tab is displayed with the following:
 +
** {{man label|Heading:}} The heading for the report.
 +
** {{man label|Media:}} The media/image file for the report.
 +
** {{man label|Custom Note:}} A custom note selector for this report.
 +
** {{man label|[ ] Include custom note:}} If checked the selected custom note will be added.
 +
** {{man label|[ ] Include referenced people:}} If checked people referenced on the image will be added to the report.
 +
** {{man label|[ ] Include media data:}} If checked the media data (attributes, tags, citations) will be added to the report.
  
* From the '''Undo history warning''' dialogue you can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
+
Once you have made your choices,  you can either choose {{man button|Close}} or {{man button|Ok}} to apply the report generation.
  
[[File:MediaReport_dialog.png|thumb|right|450px|Media Report - Option dialog]]
+
{{-}}
  
* The '''Options''' tab is displayed with the following:
+
==Issues==
** Heading: The heading for the report.
+
* {{bug|11492}} Media Report reduces image quality
** Media: The media/image file for the report.
 
** Custom Note: A custom note selector for this report.
 
** Include custom note: If checked the selected custom note will be added.
 
** Include referenced people: If checked people referenced on the image will be added to the report.
 
** Include media data: If checked the media data (attributes, tags, citations) will be added to the report.
 
  
Once you have made your choices,  you can either choose {{man button|Close}} or {{man button|Execute}} to apply the report generation.
+
== See also ==
 +
* [[Addon:Photo_Tagging_Gramplet|Photo Tagging Gramplet]] addon
 +
* [[How to create image reference regions]]
  
 +
[[Category:Addons]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Tools]]
 
[[Category:Tools]]
 +
[[Category:Media]]

Latest revision as of 12:54, 19 January 2026

Gramps-notes.png
This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager.

Please use carefully on data that is backed up, and help make it better by reporting any 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.

Media Report - example output

The Media Report is a text report for an image. The report allows custom headings and custom notes as well as the image data like notes, citations, tags, attributes and people references and image map reference regions.

This report is especially useful in displaying image map reference regions for a photo eg: a Family reunion photo as each persons face can be identified.

Usage

Media Report - Report Option dialog - defaults
  • Select Menu Reports > Text Reports -> Media Report...
    • You will be shown the Undo history warning dialog where you can choose Stop or Proceed with the tool.
  • The Report Options tab is displayed with the following:
    • Heading: The heading for the report.
    • Media: The media/image file for the report.
    • Custom Note: A custom note selector for this report.
    • [ ] Include custom note: If checked the selected custom note will be added.
    • [ ] Include referenced people: If checked people referenced on the image will be added to the report.
    • [ ] Include media data: If checked the media data (attributes, tags, citations) will be added to the report.

Once you have made your choices, you can either choose Close or Ok to apply the report generation.


Issues

  • 11492 Media Report reduces image quality

See also