Difference between revisions of "Gramps XML"

From Gramps
Jump to: navigation, search
m (Gramps (not sure if I should change the name from upper case of "GRAMPS XML"))
m (RELAX NG generation)
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{languages|GRAMPS_XML}}
+
{{languages|Gramps XML}}
'''GRAMPS XML''' is the 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.
  
 
==Gramps XML Resources==
 
==Gramps XML Resources==
Starting with XML 1.0, each revision of 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/ http://www.gramps-project.org/xml/].
+
{{man note|Starting with Gramps XML 1.0|Each revision of Gramps XML has its own resource page, with references to that version's [https://en.wikipedia.org/wiki/Document_type_definition DTD] and [https://en.wikipedia.org/wiki/RELAX_NG RELAX NG] schema.<br />The resource pages are listed at [http://www.gramps-project.org/xml/ http://www.gramps-project.org/xml/].}}
  
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]
+
{| class="wikitable sortable"
 +
!Gramps release
 +
!XML version
 +
!Imports XML version
 +
!Database
 +
!Example
 +
!Changes/Note
 +
|-
 +
| master
 +
| no change against 4.2 yet
 +
| >= 1.0.0 - best 1.7
 +
| 18
 +
| Unreleased <br />[{{Code Browser}}/tree/master/example/gramps/example.gramps example.gramps]
 +
| Unreleased
 +
|}
  
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.
+
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]
  
{| {{prettytable}}
+
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"
 
!Gramps release
 
!Gramps release
 
!XML version  
 
!XML version  
 
!Imports XML version
 
!Imports XML version
 +
!Database
 
!Example
 
!Example
 
!Changes/Note
 
!Changes/Note
 +
|-
 +
| 4.2.x
 +
| 1.7.0
 +
| >= 1.0.0 - 1.7
 +
| 18
 +
|
 +
|added PlaceNames (with Date and Language) Place<br />
 +
|-
 +
| 4.1.x
 +
| 1.6.0
 +
| >= 1.0.0 - best 1.5.1
 +
| 17
 +
|[{{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 optional support for checksum on Media object<br />
 +
added PlaceRef and Place Hierarchies<br />
 +
|-
 +
|4.0.x
 +
|1.5.0 - 1.5.1
 +
| >= 1.0.0 - best 1.4.0
 +
|16
 +
|[{{Code Browser}}/tree/maintenance/gramps40/example/gramps/example.gramps]
 +
| -
 
|-
 
|-
 
|3.4.x
 
|3.4.x
|1.5.0
+
|1.5.0 - 1.5.1
 
| >= 1.0.0 - best 1.4.0
 
| >= 1.0.0 - best 1.4.0
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34/example/gramps/example.gramps]
+
|16
 +
|[{{Code Browser}}/tree/maintenance/gramps34/example/gramps/example.gramps]
 
|Citations support<br />
 
|Citations support<br />
 
Gramps XML is now idempotent[http://en.wikipedia.org/wiki/Idempotence].{{bug|4365}}<br />
 
Gramps XML is now idempotent[http://en.wikipedia.org/wiki/Idempotence].{{bug|4365}}<br />
Line 29: Line 71:
 
|1.4.0
 
|1.4.0
 
| >= 1.0.0 - best 1.3.0
 
| >= 1.0.0 - best 1.3.0
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps33/example/gramps/example.gramps]
+
|15
|[http://www.gramps-project.org/wiki/index.php?title=Gramps_3.3_Wiki_Manual_-_What%27s_new%3F#Database Changes]
+
|[{{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 />
 +
Replaced Markers with Tags ( marker removed from all / tags added to Person, Media, Family, and Notes)<br />
 +
Transaction<br />
 +
Merging<br />
 +
Improvements on Import/Export file formats (vcard, gedcom, xml)<br />
 +
[[Gramps_3.3_Wiki_Manual_-_What%27s_new%3F#Database Changes]]
 
|-
 
|-
 
|3.1.x
 
|3.1.x
 
|1.3.0
 
|1.3.0
 
| >= 1.0.0 - best 1.1.0
 
| >= 1.0.0 - best 1.1.0
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps31/example/gramps/example.gramps]
+
|15
|
+
|[{{Code Browser}}/tree/maintenance/gramps31/example/gramps/example.gramps]
 +
| Added lat/long to places
 
|-
 
|-
 
|3.0.x
 
|3.0.x
 
|1.2.0
 
|1.2.0
 
| >= 1.1.0
 
| >= 1.1.0
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps30/example/gramps/example.gramps]
+
|14
|
+
|[{{Code Browser}}/tree/maintenance/gramps30/example/gramps/example.gramps]
 +
| added newyear to Dates<br />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
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps22/example/gramps/data.gramps]
+
|
 +
|[{{Code Browser}}/tree/maintenance/gramps22/example/gramps/data.gramps]
 
|
 
|
 
|-
 
|-
Line 53: Line 105:
 
|1.0.0
 
|1.0.0
 
| >= 0.0.0
 
| >= 0.0.0
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps20/gramps2/example/gramps/data.gramps]
+
|13
|
+
|[{{Code Browser}}/tree/maintenance/gramps20/gramps2/example/gramps/data.gramps]
 +
| changed name formats
 
|-
 
|-
 
|1.0.x
 
|1.0.x
 
|no official version (0.0.0)
 
|no official version (0.0.0)
 
| -
 
| -
|[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps10/example/gramps/data.gramps]
+
|
 +
|[{{Code Browser}}/tree/maintenance/gramps10/example/gramps/data.gramps]
 
|
 
|
 
|-
 
|-
 
|0.0.x
 
|0.0.x
 
|beta software (0.0.0)
 
|beta software (0.0.0)
 +
| Unsupported
 
| Unsupported
 
| Unsupported
 
| Unsupported
 
| Unsupported
Line 69: Line 124:
 
|}
 
|}
  
You could use VirtualBox or Vmware and the old lgenealogy images from  
+
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/  
+
http://ftp.gwdg.de/pub/linux/gramps/
to convert the old XML.
+
  
 
===DTD generation===
 
===DTD generation===
Line 78: Line 132:
 
===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 85: Line 139:
 
  xmllint --noout filename.gramps
 
  xmllint --noout filename.gramps
  
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.
+
{{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==
Line 91: Line 145:
 
* [[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]], [[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.
* [http://www.gramps.van-staveren.net/ GrampsXMLview] is a number of PHP scripts in combination with a Gramps XML database.
+
* [[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://en.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.
 +
* [https://github.com/claws/gramps2gource gramps2gource] for blurring the line between Genealogy and Software Configuration Management visualisation.
 
* ...
 
* ...
  
Line 100: Line 156:
 
* [[Generate XML]]
 
* [[Generate XML]]
 
* [[GEDCOM]]
 
* [[GEDCOM]]
 +
* [[Gramps and GEDCOM]]
 +
* [[Database_Formats]]
 +
* [[Gramps Old database]]
  
 
[[Category:Developers/Reference]]
 
[[Category:Developers/Reference]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 02:04, 27 June 2015

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 version Imports XML version Database Example Changes/Note
master no change against 4.2 yet >= 1.0.0 - best 1.7 18 Unreleased
example.gramps
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.[1]

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.

Gramps release XML version Imports XML version Database Example Changes/Note
4.2.x 1.7.0 >= 1.0.0 - 1.7 18 added PlaceNames (with Date and Language) Place
4.1.x 1.6.0 >= 1.0.0 - best 1.5.1 17 [2] 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 [3] -
3.4.x 1.5.0 - 1.5.1 >= 1.0.0 - best 1.4.0 16 [4] Citations support

Gramps XML is now idempotent[5].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 [6] 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 [7] Added lat/long to places
3.0.x 1.2.0 >= 1.1.0 14 [8] added newyear to Dates
Replace plain text with StyledText in Notes
2.2.x 1.1.0-1.1.4 >= 0.0.0 [9]
2.0.x 1.0.0 >= 0.0.0 13 [10] changed name formats
1.0.x no official version (0.0.0) - [11]
0.0.x beta software (0.0.0) Unsupported Unsupported Unsupported

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