Difference between revisions of "Addon:RepositoriesReport"

From Gramps
Jump to: navigation, search
(Repositories Report)
m
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Third-party plugin}}
 
{{Third-party plugin}}
[[File:RepositoriesReport.png|thumb|right|450px]]
+
[[File:RepositoriesReport.png|thumb|right|450px|Example output from the ''Repositories Report'']]
 
+
This is a set of Text reports to list repositories and their related sources information, such as the call number or the type. Repositories stores sources. These reports are useful for displaying some sources information before going to a repository (like an archive).
This is a set of reports to list repositories and their related sources information, such as the call number or the type. Repositories stores sources. These reports are useful for displaying some sources information before going to a repository (like an archive).
+
* {{man label|[[Addon:RepositoriesReport#Repositories_Report|Repositories Report]]}}
* {{man label|Repositories Report}}
+
* {{man label|[[Addon:RepositoriesReport#Repositories_Report_Options|Repositories Report Options]]}}
* {{man label|Repositories Report Options}}
 
  
 
== Repositories Report ==
 
== Repositories Report ==
 
Once installed, you can access this report via menu {{man menu|Reports > Text Reports > Repositories Report...}}
 
Once installed, you can access this report via menu {{man menu|Reports > Text Reports > Repositories Report...}}
 +
 +
See also [[Gramps_{{man version}}_Wiki_Manual_-_Reports - part 6#Common options|common options]]
 
{{-}}
 
{{-}}
  
 
== Repositories Report Options ==
 
== Repositories Report Options ==
  
[[File:RepositoriesReportAlt.png|thumb|right|400px]]
+
[[File:RepositoriesReportAlt.png|thumb|right|450px|Example output from the ''Repositories Report Options'']]
  
There is an additional experimental ''RepositoriesReport'', which tries to provide user-options for additional source information (''author, publication information, abbreviation, data''), preformatted notes for source or repository, primary media on source, also allows to hide private records (''repository, source, note, media'') and supports multi-language.
+
Once installed, you can access this report via menu {{man menu|Reports > Text Reports > Repositories Report Options...}}
 +
 
 +
See also [[Gramps_{{man version}}_Wiki_Manual_-_Reports - part 6#Common options|common options]]
 +
 
 +
This report extends the ''Repositories Report'', and provides user-options for additional source information (''author, publication information, abbreviation, data''), pre-formatted notes for source or repository, primary media on source, also allows to hide private records (''repository, source, note, media'') and supports multi-language.
  
 
{{-}}
 
{{-}}
 +
 
=Development=
 
=Development=
 
== Limitations ==
 
== Limitations ==
Line 24: Line 30:
 
* RepositoriesReport.py (3.1.x) was inspired by [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_6#Place_Report|Place Report]].
 
* RepositoriesReport.py (3.1.x) was inspired by [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_6#Place_Report|Place Report]].
  
There is a [[Quick_Views|quick view]] on 3.1, which does the same thing on active repository. Thanks to ''Alex Roitman'', who generated the "technical part" of the code ...
+
See also the [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_8#Repository_References|Repository References]] [[Quick_Views|quick view]], which does the same thing on active repository called. Thanks to ''Alex Roitman'', who generated the "technical part" of the code ...
  
 
== Generated with :==
 
== Generated with :==
  
 
Coding way is not very quick or standard but is easy to understand and plugin does the job.  
 
Coding way is not very quick or standard but is easy to understand and plugin does the job.  
* It has been generated under [http://www.geany.org/ Geany]  
+
* It has been generated under [https://www.geany.org/ Geany]  
* and checked with [http://www.logilab.org/projects/pylint pylint].
+
* and checked with [https://www.pylint.org/ Pylint].
 
   
 
   
 
Feel free to improve it for your own need !
 
Feel free to improve it for your own need !

Latest revision as of 22:09, 5 January 2022

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

Example output from the Repositories Report

This is a set of Text reports to list repositories and their related sources information, such as the call number or the type. Repositories stores sources. These reports are useful for displaying some sources information before going to a repository (like an archive).

Repositories Report

Once installed, you can access this report via menu Reports > Text Reports > Repositories Report...

See also common options

Repositories Report Options

Example output from the Repositories Report Options

Once installed, you can access this report via menu Reports > Text Reports > Repositories Report Options...

See also common options

This report extends the Repositories Report, and provides user-options for additional source information (author, publication information, abbreviation, data), pre-formatted notes for source or repository, primary media on source, also allows to hide private records (repository, source, note, media) and supports multi-language.


Development

Limitations

  • As this is a textual report, there is no changes on database. It just retrieves information from database. No need to make a backup before using this report.
  • As code is not very complex, it should not introduce mistakes on output. If there is an error, then there is a valid email address at the end of the plugin.

See also the Repository References quick view, which does the same thing on active repository called. Thanks to Alex Roitman, who generated the "technical part" of the code ...

Generated with :

Coding way is not very quick or standard but is easy to understand and plugin does the job.

  • It has been generated under Geany
  • and checked with Pylint.

Feel free to improve it for your own need !