Difference between revisions of "Plugin:Citation Formatter"

From Gramps
m
 
(5 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
Citation formatters control the format that Bibliography objects use in reports.
 
Citation formatters control the format that Bibliography objects use in reports.
  
The [[Addon_list_legend#cite|CITE plugin]] replicating the default citation format based on the built-in citation system of Gramps 5.1.x and earlier. [[Gramps_5.2_Wiki_Manual_-_What's_new%3F#Under_the_hood_changes|{{new|5.2.0}}]]
+
The [[Addon_list_legend#cite|CITE plugin]] replicating the default citation format based on the builtin citation system of Gramps 5.1.x and earlier. [[Gramps_5.2_Wiki_Manual_-_What's_new%3F#Under_the_hood_changes|{{new|5.2.0}}]]
  
 
== Citation Formatter ==
 
== Citation Formatter ==
Line 9: Line 9:
 
=== Legacy ===
 
=== Legacy ===
  
The '''Legacy''' citation formatter plugin is a built-in [[Addon_list_legend#cite|CITE plugin]] replicating the default citation format based on the built-in citation system of Gramps 5.1.x and earlier.  
+
The '''Legacy''' citation formatter plugin is a builtin [[Addon_list_legend#cite|CITE plugin]] replicating the default citation format based on the builtin citation system of Gramps 5.1.x and earlier.  
 
 
  
 
* [https://github.com/gramps-project/gramps/tree/maintenance/gramps52/gramps/plugins/cite <code>gramps/plugins/cite</code>] core plugin source code on GitHub
 
* [https://github.com/gramps-project/gramps/tree/maintenance/gramps52/gramps/plugins/cite <code>gramps/plugins/cite</code>] core plugin source code on GitHub
Line 16: Line 15:
 
=== Enhanced ===
 
=== Enhanced ===
  
The '''Enhanced''' citation formatter is an example addon plugin to be used as reference for development.  It adds a Repository data (Name of the Repository and Call Number of the Source) to the standard functionality found in the built-in "Legacy" citation formatter.
+
The '''Enhanced''' citation formatter is an example addon plugin to be used as reference for development.  It adds Repository data (Name of the Repository and Call Number of the Source) to the standard functionality found in the builtin "Legacy" citation formatter.
  
 
* [https://github.com/gramps-project/addons-source/tree/maintenance/gramps52/CiteEnhanced <code>CiteEnhanced</code>] addon plugin source code on GitHub
 
* [https://github.com/gramps-project/addons-source/tree/maintenance/gramps52/CiteEnhanced <code>CiteEnhanced</code>] addon plugin source code on GitHub
 +
 +
== Reports ==
 +
 +
Only some Reports include Bibliographies. (Sometimes called "End Notes")
 +
 +
=== Builtins ===
 +
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_6#Detailed_Ancestral_Report|Detailed Ancestral Report]] text report  <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/textreport/detancestralreport.py#L63 source]</small>
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_6#Detailed_Descendant_Report|Detailed Descendant]] text report <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/textreport/detdescendantreport.py#L70 source]</small> 
 +
* Family Group web report <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/webreport/family.py#L53 source]</small> 
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_6#Complete_Individual_Report|Complete Individual]] text report <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/textreport/indivcomplete.py#L68 source]</small> 
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_7#Narrated_Web_Site|Narrated website]] web report: Person <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/webreport/person.py#L66 source]</small>, base page <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/webreport/basepage.py#L86 source]</small>, Place <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/webreport/place.py#L53 source]</small>, Media <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/webreport/media.py#L58 source]</small>, Statistics <small>[https://github.com/gramps-project/gramps/blob/6b758b8067dc47daa718e1ddf45da40578c54866/gramps/plugins/webreport/statistics.py#L52 source]</small> 
 +
 +
=== Addons ===
 +
* [[Addon:PersonEverything_Report|Person Everything]] Text Report <small>[https://github.com/gramps-project/addons-source/blob/ddb32eb151794e5b156aeace00a43bd9d6db57cc/PersonEverything/PersonEverything.py#L775 source]</small>
 +
* [[Addon:Detailed_Descendant_Report_With_All_Images|Detailed Descendant with Images]] Text Report <small>[https://github.com/gramps-project/addons-source/blob/ddb32eb151794e5b156aeace00a43bd9d6db57cc/DetDescendantReport-images/detdescendantreporti.py#L203 source]</small>
 +
* [[Addon:DynamicWeb_report|Dynamic Web]] Web Pages <small>[https://github.com/gramps-project/addons-source/blob/ddb32eb151794e5b156aeace00a43bd9d6db57cc/DynamicWeb/dynamicweb.py#L191 source]</small>
 +
* [[Addon:Descendant_and_Detailed_Descendant_Book_Reports|Detailed Descendant Book]] Text Report <small>[https://github.com/gramps-project/addons-source/blob/ddb32eb151794e5b156aeace00a43bd9d6db57cc/DescendantBooks/DetailedDescendantBookReport.py#L52 source]</small>
  
 
== See also ==
 
== See also ==
 
* [https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/report/_bibliography.py#L119 Bibliography objects]
 
* [https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/report/_bibliography.py#L119 Bibliography objects]
* Discourse discussion: [https://gramps.discourse.group/t/citation-formatter/3973 Citation Formatter] <small>Aug 2023</small>
+
* Gramps developer docs in Sphinx : [https://gramps-project.org/docs/gen/gen_plug.html?highlight=bibliography#module-gramps.gen.plug.report._bibliography module-gramps.gen.plug.report]
[[Category:Plugin]]
+
* Discourse discussion : [https://gramps.discourse.group/t/citation-formatter/3973 Citation Formatter] <small>Aug 2023</small>
 +
[[Category:Plugins]]

Latest revision as of 05:16, 15 July 2025

Overview

Citation formatters control the format that Bibliography objects use in reports.

The CITE plugin replicating the default citation format based on the builtin citation system of Gramps 5.1.x and earlier. — ⚡new for version 5.2.0

Citation Formatter

Legacy

The Legacy citation formatter plugin is a builtin CITE plugin replicating the default citation format based on the builtin citation system of Gramps 5.1.x and earlier.

Enhanced

The Enhanced citation formatter is an example addon plugin to be used as reference for development. It adds Repository data (Name of the Repository and Call Number of the Source) to the standard functionality found in the builtin "Legacy" citation formatter.

Reports

Only some Reports include Bibliographies. (Sometimes called "End Notes")

Builtins

Addons

See also