Difference between revisions of "Gramps XML"

From Gramps
Jump to: navigation, search
m (See also)
 
(25 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{languages|Gramps XML}}
 
{{languages|Gramps XML}}
'''Gramps XML''' is the '''Extensible Markup Language ''' [http://en.wikipedia.org/wiki/XML XML] format designed for storing Gramps data. The goal is to have a fully portable, human- and machine-readable XML format so that the data can be read and written without any loss. In addition, XML format allows for smaller files (if '''compressed''') and for using the version control system for tracking the changes (if '''uncompressed''').
+
'''Gramps XML''' is the '''Extensible Markup Language ''' ([http://en.wikipedia.org/wiki/XML XML]) format designed for storing Gramps data. The goal is to have a fully portable, human- and machine-readable XML format so that the data can be read and written without any loss. In addition, XML format allows for smaller files (if '''compressed''') and for using the version control system for tracking the changes (if '''uncompressed''').
  
 
The reason XML is not used by Gramps as the working database ("internal") format is performance, specifically memory considerations.
 
The reason XML is not used by Gramps as the working database ("internal") format is performance, specifically memory considerations.
Line 9: Line 9:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
!Gramps release
 
!Gramps release
!XML version
+
!XML schema
!Imports XML version
+
!Imports XML schema
 
!Database
 
!Database
 
!Example
 
!Example
Line 18: Line 18:
 
| no change against 4.2 yet
 
| no change against 4.2 yet
 
| >= 1.0.0 - best 1.7
 
| >= 1.0.0 - best 1.7
| 18
+
| 19
 
| Unreleased <br />[{{Code Browser}}/tree/master/example/gramps/example.gramps example.gramps]
 
| Unreleased <br />[{{Code Browser}}/tree/master/example/gramps/example.gramps example.gramps]
 
| Unreleased  
 
| Unreleased  
 
|}
 
|}
  
Note: Commencing with Gramps 3.1.2 all official versions of Gramps XML files can be imported. However, a warning will be given on import of 1.0.0 xml.[http://sourceforge.net/mailarchive/message.php?msg_id=23262334]
+
{{man note|Note|Commencing with Gramps 3.1.2 all official versions of Gramps XML files can be imported. However, a warning will be given on import of 1.0.0 XML.[http://sourceforge.net/p/gramps/mailman/message/23262334/]<br /><br />'''Note:''' For versions of Gramps earlier than 3.1.1 refer to and the consult the table below to decide which version to use to import a specific version of the XML.}}
 
 
Note: For versions of Gramps earlier than 3.1.1 refer to the table to decide which version to use to import a specific version of the xml, consult the table below.
 
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
!Gramps release
 
!Gramps release
!XML version
+
!XML schema
!Imports XML version
+
!Imports XML schema
 
!Database
 
!Database
 
!Example
 
!Example
 
!Changes/Note
 
!Changes/Note
 +
|-
 +
| 5.1.x
 +
| 1.7.0 - 1.7.1
 +
| >= 1.0.0 - 1.7
 +
| 19
 +
|[{{Code Browser}}/tree/maintenance/gramps51/example/gramps/example.gramps]
 +
|
 +
* DB-API (SQLite) is default backend
 +
* BSDDB is Legacy backend
 +
|-
 +
| 5.0.x
 +
| 1.7.0 - 1.7.1
 +
| >= 1.0.0 - 1.7
 +
| 19
 +
|[{{Code Browser}}/tree/maintenance/gramps50/example/gramps/example.gramps]
 +
|
 +
* Database backends become plugins
 +
* BSDDB is default, convert default handle (metadata) to str
 +
* DB-API (SQLite) is tested as viable replacement
 
|-
 
|-
 
| 4.2.x
 
| 4.2.x
| 1.7.0
+
| 1.7.0 - 1.7.1
 
| >= 1.0.0 - 1.7
 
| >= 1.0.0 - 1.7
 
| 18
 
| 18
 +
|[{{Code Browser}}/tree/maintenance/gramps42/example/gramps/example.gramps]
 
|
 
|
|added PlaceNames (with Date and Language) Place<br />
+
* Added PlaceNames (with Date and Language) Place
 
|-
 
|-
 
| 4.1.x
 
| 4.1.x
Line 47: Line 65:
 
| 17
 
| 17
 
|[{{Code Browser}}/tree/maintenance/gramps41/example/gramps/example.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps41/example/gramps/example.gramps]
|added Tags to Event, Place, Repository, Source, and Citation<br />
+
|
Source/Citation.data became SourceAttributes<br />
+
* added Tags to Event, Place, Repository, Source, and Citation
added optional support for checksum on Media object<br />
+
* Source/Citation.data became SourceAttributes
added PlaceRef and Place Hierarchies<br />
+
* added optional support for checksum on Media object
 +
* added PlaceRef and Place Hierarchies
 
|-
 
|-
 
|4.0.x
 
|4.0.x
Line 64: Line 83:
 
|16
 
|16
 
|[{{Code Browser}}/tree/maintenance/gramps34/example/gramps/example.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps34/example/gramps/example.gramps]
|Citations support<br />
+
|
Gramps XML is now idempotent[http://en.wikipedia.org/wiki/Idempotence].{{bug|4365}}<br />
+
* Citations support
Exporter does not change records order any more, making it easier to look at differences between versions/revisions.
+
* Gramps XML is now idempotent[http://en.wikipedia.org/wiki/Idempotence].{{bug|4365}}
 +
* Exporter does not change records order any more, making it easier to look at differences between versions/revisions.
 
|-
 
|-
 
|3.3.x
 
|3.3.x
Line 73: Line 93:
 
|15
 
|15
 
|[{{Code Browser}}/tree/maintenance/gramps33/example/gramps/example.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps33/example/gramps/example.gramps]
|Added new field "locality" to the Place schema<br />
+
|
Added surnames to the Name schema (surnames is a list of surnames / prefix and patronymic are moved to the surname)<br />
+
* Added new field "locality" to the Place schema
Replaced Markers with Tags ( marker removed from all / tags added to Person, Media, Family, and Notes)<br />
+
* Added surnames to the Name schema (surnames is a list of surnames / prefix and patronymic are moved to the surname)
Transaction<br />
+
* Replaced Markers with Tags ( marker removed from all / tags added to Person, Media, Family, and Notes)
Merging<br />
+
* Transaction
Improvements on Import/Export file formats (vcard, gedcom, xml)<br />
+
* Merging
[[Gramps_3.3_Wiki_Manual_-_What%27s_new%3F#Database Changes]]
+
* Improvements on Import/Export file formats (vcard, gedcom, xml)
 +
* [[Gramps_3.3_Wiki_Manual_-_What%27s_new%3F#Database Changes]]
 
|-
 
|-
 
|3.1.x
 
|3.1.x
Line 86: Line 107:
 
|15
 
|15
 
|[{{Code Browser}}/tree/maintenance/gramps31/example/gramps/example.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps31/example/gramps/example.gramps]
| Added lat/long to places
+
|
 +
* Added lat/long to places
 
|-
 
|-
 
|3.0.x
 
|3.0.x
Line 93: Line 115:
 
|14
 
|14
 
|[{{Code Browser}}/tree/maintenance/gramps30/example/gramps/example.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps30/example/gramps/example.gramps]
| added newyear to Dates<br />Replace plain text with StyledText in Notes
+
|  
 +
* added newyear to Dates
 +
* Replace plain text with StyledText in Notes
 
|-
 
|-
 
|2.2.x
 
|2.2.x
 
|1.1.0-1.1.4
 
|1.1.0-1.1.4
 
| >= 0.0.0
 
| >= 0.0.0
|
+
|13
 
|[{{Code Browser}}/tree/maintenance/gramps22/example/gramps/data.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps22/example/gramps/data.gramps]
 
|
 
|
Line 107: Line 131:
 
|13
 
|13
 
|[{{Code Browser}}/tree/maintenance/gramps20/gramps2/example/gramps/data.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps20/gramps2/example/gramps/data.gramps]
| changed name formats
+
|  
 +
* changed name formats
 
|-
 
|-
 
|1.0.x
 
|1.0.x
Line 114: Line 139:
 
|
 
|
 
|[{{Code Browser}}/tree/maintenance/gramps10/example/gramps/data.gramps]
 
|[{{Code Browser}}/tree/maintenance/gramps10/example/gramps/data.gramps]
|
+
|(Install [https://github.com/gramps-project/gramps/releases/tag/v2.2.10 Gramps 2.2.10] to import and convert old beta Gramps XML backups - see [[Gramps_Old_database]] & issue {{bug|6129}})
 
|-
 
|-
 
|0.0.x
 
|0.0.x
Line 124: Line 149:
 
|}
 
|}
  
Note: To convert an old Gramps XML file you could use VirtualBox or Vmware and the old lgenealogy images from:  
+
{{man note|Note:|To convert an old Gramps XML file you could use VirtualBox or Vmware and the old lgenealogy images from:<br><code>http://ftp.gwdg.de/pub/linux/gramps/</code>}}
http://ftp.gwdg.de/pub/linux/gramps/
 
  
 
===DTD generation===
 
===DTD generation===
Line 132: Line 156:
 
===RELAX NG generation===
 
===RELAX NG generation===
 
Tools like [http://code.google.com/p/jing-trang/ trang] or [http://people.apache.org/~andyc/neko/doc/dtd/index.html NekoDTD] could help to convert a Gramps DTD file to a RELAX NG file.
 
Tools like [http://code.google.com/p/jing-trang/ trang] or [http://people.apache.org/~andyc/neko/doc/dtd/index.html NekoDTD] could help to convert a Gramps DTD file to a RELAX NG file.
Some others tools and up-to-date informations (''2010-09-19'') are listed on this [http://www.relaxng.org/ page].
+
Some others tools and up-to-date informations are listed on this [http://www.relaxng.org/ page].
  
 
==Validating Gramps XML file==
 
==Validating Gramps XML file==
Line 139: Line 163:
 
  xmllint --noout filename.gramps
 
  xmllint --noout filename.gramps
  
{{man warn|If the Gramps XML file does not validate|, this indicates an error in either the DTD or the XML Writer.<br>'''Please file the bug report at http://bugs.gramps-project.org in that case.'''}}
+
{{man warn|If the Gramps XML file does not validate|this indicates an error in either the DTD or the XML Writer.<br>'''Please file the bug report at http://bugs.gramps-project.org in that case.'''}}
  
 
==Parsing Gramps XML file==
 
==Parsing Gramps XML file==
  
* [[Xsl|XSLT]] scripts: [http://www.gramps-project.org/grampsExhibit/0.0.2/grampsexhibit.xsl gramps exhibit] (Michiel Nauta), [[media:Ancestors.xsl.gz|Ancestors.xsl]], [[media:Birthday.xsl.gz|Birthday.xsl]] (Gramps 1.x), [[media:Tellico.tar.gz|Tellico scripts]], [[Lxml_Gramplet|lxml gramplet]], [http://sourceforge.net/mailarchive/message.php?msg_id=28108782 Print Notes], etc ... see [[media:Xpaths.gz|XPaths]].
+
* [[Xsl|XSLT]] scripts: [http://www.gramps-project.org/grampsExhibit/0.0.2/grampsexhibit.xsl gramps exhibit] (Michiel Nauta), [[media:Ancestors.xsl.gz|Ancestors.xsl]], [[media:Birthday.xsl.gz|Birthday.xsl]] (Gramps 1.x), [[media:Tellico.tar.gz|Tellico scripts]], [[Addon:Lxml Gramplet|lxml gramplet]], [http://sourceforge.net/mailarchive/message.php?msg_id=28108782 Print Notes], etc ... see [[media:Xpaths.gz|XPaths]].
 
* A [http://svn.code.sf.net/p/gramps-addons/code/trunk/contrib/DescendantsLines/ft.py sample of standalone script] (Adam Sampson) which parses a Gramps XML file for drawing a family tree.
 
* A [http://svn.code.sf.net/p/gramps-addons/code/trunk/contrib/DescendantsLines/ft.py sample of standalone script] (Adam Sampson) which parses a Gramps XML file for drawing a family tree.
 
* [[Other_genealogy_tools#Gramps-php-exporter|Gramps-php-exporter]]
 
* [[Other_genealogy_tools#Gramps-php-exporter|Gramps-php-exporter]]
 
* A [http://sourceforge.net/projects/joomlagen/ Joomla! component/module] for uploading the Gramps XML database and for showing genealogical information and overviews.
 
* A [http://sourceforge.net/projects/joomlagen/ Joomla! component/module] for uploading the Gramps XML database and for showing genealogical information and overviews.
 
* [http://www.phpgedview.net PhpGedView] supports [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/phpGedView/includes/classes/class_grampsexport.php simple output to Gramps XML file format] for the Clippings Cart and has an option to download entire Gedcom in Gramps XML form as well as being able to retrieve raw data from the SOAP web service in Gramps XML format. Still a [http://sourceforge.net/projects/phpgedview/forums/forum/185166/topic/5177979 partial support on version 4.3.0].
 
* [http://www.phpgedview.net PhpGedView] supports [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/phpGedView/includes/classes/class_grampsexport.php simple output to Gramps XML file format] for the Clippings Cart and has an option to download entire Gedcom in Gramps XML form as well as being able to retrieve raw data from the SOAP web service in Gramps XML format. Still a [http://sourceforge.net/projects/phpgedview/forums/forum/185166/topic/5177979 partial support on version 4.3.0].
* [http://en.wikipedia.org/wiki/Greasemonkey Greasemonkey] scripts (Michiel Nauta)
+
* [http://wikipedia.org/wiki/Greasemonkey Greasemonkey] scripts (Michiel Nauta)
* [http://www.gramps.van-staveren.net/ GrampsXMLview] is a number of PHP scripts in combination with a Gramps XML database.
+
* GrampsXMLview was a number of PHP scripts in combination with a Gramps XML database (Sjoerd van Staveren). [https://web.archive.org/web/20120220103003/http://www.gramps.van-staveren.net/ 2012 www.gramps.van-staveren.net Internet Archive]
 
* [https://github.com/claws/gramps2gource gramps2gource] for blurring the line between Genealogy and Software Configuration Management visualisation.
 
* [https://github.com/claws/gramps2gource gramps2gource] for blurring the line between Genealogy and Software Configuration Management visualisation.
 
* ...
 
* ...
  
 
==See also==
 
==See also==
 +
* [https://gramps.discourse.group/t/auxiliary-xml-format-documentation/2800 Auxiliary XML files in Gramps]:
 +
** filters: custom_filters.xml
 +
** report settings: report_options.xml
 +
** Books: books.xml
 +
** holiday sets or country calendars: [[Calendar_tools_holidays#format_of_holidays.xml|holidays.xml]]
 
* [[Generate XML]]
 
* [[Generate XML]]
 +
* Tutorial: [[Customize_reports_with_XML_tool|Customize reports with XML tool]]
 
* [[GEDCOM]]
 
* [[GEDCOM]]
 
* [[Gramps and GEDCOM]]
 
* [[Gramps and GEDCOM]]
 
* [[Database_Formats]]
 
* [[Database_Formats]]
 
* [[Gramps Old database]]
 
* [[Gramps Old database]]
 +
* [[Previous releases of Gramps]]
  
 
[[Category:Developers/Reference]]
 
[[Category:Developers/Reference]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 17:52, 22 September 2022

Gramps XML is the Extensible Markup Language (XML) format designed for storing Gramps data. The goal is to have a fully portable, human- and machine-readable XML format so that the data can be read and written without any loss. In addition, XML format allows for smaller files (if compressed) and for using the version control system for tracking the changes (if uncompressed).

The reason XML is not used by Gramps as the working database ("internal") format is performance, specifically memory considerations.

Gramps XML Resources

Gramps-notes.png
Starting with Gramps XML 1.0

Each revision of Gramps XML has its own resource page, with references to that version's DTD and RELAX NG schema.
The resource pages are listed at http://www.gramps-project.org/xml/.

Gramps release XML schema Imports XML schema Database Example Changes/Note
master no change against 4.2 yet >= 1.0.0 - best 1.7 19 Unreleased
example.gramps
Unreleased
Gramps-notes.png
Note

Commencing with Gramps 3.1.2 all official versions of Gramps XML files can be imported. However, a warning will be given on import of 1.0.0 XML.[1]

Note: For versions of Gramps earlier than 3.1.1 refer to and the consult the table below to decide which version to use to import a specific version of the XML.

Gramps release XML schema Imports XML schema Database Example Changes/Note
5.1.x 1.7.0 - 1.7.1 >= 1.0.0 - 1.7 19 [2]
  • DB-API (SQLite) is default backend
  • BSDDB is Legacy backend
5.0.x 1.7.0 - 1.7.1 >= 1.0.0 - 1.7 19 [3]
  • Database backends become plugins
  • BSDDB is default, convert default handle (metadata) to str
  • DB-API (SQLite) is tested as viable replacement
4.2.x 1.7.0 - 1.7.1 >= 1.0.0 - 1.7 18 [4]
  • Added PlaceNames (with Date and Language) Place
4.1.x 1.6.0 >= 1.0.0 - best 1.5.1 17 [5]
  • added Tags to Event, Place, Repository, Source, and Citation
  • Source/Citation.data became SourceAttributes
  • added optional support for checksum on Media object
  • added PlaceRef and Place Hierarchies
4.0.x 1.5.0 - 1.5.1 >= 1.0.0 - best 1.4.0 16 [6] -
3.4.x 1.5.0 - 1.5.1 >= 1.0.0 - best 1.4.0 16 [7]
  • Citations support
  • Gramps XML is now idempotent[8].4365
  • Exporter does not change records order any more, making it easier to look at differences between versions/revisions.
3.3.x 1.4.0 >= 1.0.0 - best 1.3.0 15 [9]
  • Added new field "locality" to the Place schema
  • Added surnames to the Name schema (surnames is a list of surnames / prefix and patronymic are moved to the surname)
  • Replaced Markers with Tags ( marker removed from all / tags added to Person, Media, Family, and Notes)
  • Transaction
  • Merging
  • Improvements on Import/Export file formats (vcard, gedcom, xml)
  • Gramps_3.3_Wiki_Manual_-_What's_new?#Database Changes
3.1.x 1.3.0 >= 1.0.0 - best 1.1.0 15 [10]
  • Added lat/long to places
3.0.x 1.2.0 >= 1.1.0 14 [11]
  • added newyear to Dates
  • Replace plain text with StyledText in Notes
2.2.x 1.1.0-1.1.4 >= 0.0.0 13 [12]
2.0.x 1.0.0 >= 0.0.0 13 [13]
  • changed name formats
1.0.x no official version (0.0.0) - [14] (Install Gramps 2.2.10 to import and convert old beta Gramps XML backups - see Gramps_Old_database & issue 6129)
0.0.x beta software (0.0.0) Unsupported Unsupported Unsupported
Gramps-notes.png
Note:

To convert an old Gramps XML file you could use VirtualBox or Vmware and the old lgenealogy images from:
http://ftp.gwdg.de/pub/linux/gramps/

DTD generation

Tool like xml2dtd could help people not familiar with DTD grammar by generating a DTD file from a XML file. New content on Gramps XML could be tested with the tool and be merged on current Gramps DTD.

RELAX NG generation

Tools like trang or NekoDTD could help to convert a Gramps DTD file to a RELAX NG file. Some others tools and up-to-date informations are listed on this page.

Validating Gramps XML file

To validate the Gramps XML file against its DTD, use xmllint program (comes with the libxml2-utils package):

xmllint --noout filename.gramps
Gnome-important.png
If the Gramps XML file does not validate

this indicates an error in either the DTD or the XML Writer.
Please file the bug report at http://bugs.gramps-project.org in that case.

Parsing Gramps XML file

See also