Difference between revisions of "Gramps XML"
(→Gramps XML Resources) |
m (→Parsing Gramps XML file) |
||
(36 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | {{languages| | + | {{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'''). |
− | The reason XML is not used by | + | 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/]. | + | 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/ 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:// | + | {| class="wikitable sortable" |
+ | !Gramps release | ||
+ | !XML version | ||
+ | !Imports XML version | ||
+ | !Example | ||
+ | !Changes/Note | ||
+ | |- | ||
+ | | Trunk | ||
+ | | Unreleased ''1.6''<br />[http://svn.code.sf.net/p/gramps/code/trunk/data/grampsxml.dtd grampsxml.dtd] | ||
+ | | Unreleased <br />''>= 1.0.0 - best 1.5.0'' | ||
+ | | Unreleased <br />[http://svn.code.sf.net/p/gramps/code/trunk/example/gramps/example.gramps 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.[http://sourceforge.net/mailarchive/message.php?msg_id=23262334] | ||
− | 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: 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 | ||
!Example | !Example | ||
+ | !Changes/Note | ||
+ | |- | ||
+ | |3.4.x | ||
+ | |1.5.0 | ||
+ | | >= 1.0.0 - best 1.4.0 | ||
+ | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34/example/gramps/example.gramps] | ||
+ | |Citations support<br /> | ||
+ | Gramps XML is now idempotent[http://en.wikipedia.org/wiki/Idempotence].{{bug|4365}}<br /> | ||
+ | Exporter does not change records order any more, making it easier to look at differences between versions/revisions. | ||
|- | |- | ||
|3.3.x | |3.3.x | ||
|1.4.0 | |1.4.0 | ||
| >= 1.0.0 - best 1.3.0 | | >= 1.0.0 - best 1.3.0 | ||
− | |[http:// | + | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps33/example/gramps/example.gramps] |
− | |- | + | |[http://www.gramps-project.org/wiki/index.php?title=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:// | + | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps31/example/gramps/example.gramps] |
+ | | | ||
|- | |- | ||
|3.0.x | |3.0.x | ||
|1.2.0 | |1.2.0 | ||
| >= 1.1.0 | | >= 1.1.0 | ||
− | |[http:// | + | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps30/example/gramps/example.gramps] |
+ | | | ||
|- | |- | ||
|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:// | + | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps22/example/gramps/data.gramps] |
+ | | | ||
|- | |- | ||
|2.0.x | |2.0.x | ||
|1.0.0 | |1.0.0 | ||
| >= 0.0.0 | | >= 0.0.0 | ||
− | |[http:// | + | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps20/gramps2/example/gramps/data.gramps] |
+ | | | ||
|- | |- | ||
|1.0.x | |1.0.x | ||
|no official version (0.0.0) | |no official version (0.0.0) | ||
| - | | - | ||
− | |[http:// | + | |[http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps10/example/gramps/data.gramps] |
+ | | | ||
|- | |- | ||
|0.0.x | |0.0.x | ||
Line 52: | Line 80: | ||
| Unsupported | | Unsupported | ||
| Unsupported | | Unsupported | ||
+ | | | ||
|} | |} | ||
+ | |||
+ | 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=== | ===DTD generation=== | ||
Tool like [http://xml2dtd.sourceforge.net/ 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. | Tool like [http://xml2dtd.sourceforge.net/ 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=== | ===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. | ||
Line 68: | Line 102: | ||
==Parsing Gramps XML file== | ==Parsing Gramps XML file== | ||
− | * [[Xsl|XSLT]] scripts: [http://www.gramps-project.org/grampsExhibit/0.0. | + | * [[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:// | + | * 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]] |
* 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 output to Gramps XML file | + | * [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. | ||
* ... | * ... | ||
Line 79: | Line 114: | ||
* [[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]] |
Revision as of 18:09, 1 November 2013
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.
Contents
Gramps XML Resources
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 | Example | Changes/Note |
---|---|---|---|---|
Trunk | Unreleased 1.6 grampsxml.dtd |
Unreleased >= 1.0.0 - best 1.5.0 |
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 | Example | Changes/Note |
---|---|---|---|---|
3.4.x | 1.5.0 | >= 1.0.0 - best 1.4.0 | [2] | Citations support Gramps XML is now idempotent[3].4365 |
3.3.x | 1.4.0 | >= 1.0.0 - best 1.3.0 | [4] | Changes |
3.1.x | 1.3.0 | >= 1.0.0 - best 1.1.0 | [5] | |
3.0.x | 1.2.0 | >= 1.1.0 | [6] | |
2.2.x | 1.1.0-1.1.4 | >= 0.0.0 | [7] | |
2.0.x | 1.0.0 | >= 0.0.0 | [8] | |
1.0.x | no official version (0.0.0) | - | [9] | |
0.0.x | beta software (0.0.0) | Unsupported | Unsupported |
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 (2010-09-19) 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
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
- XSLT scripts: gramps exhibit (Michiel Nauta), Ancestors.xsl, Birthday.xsl (Gramps 1.x), Tellico scripts, lxml gramplet, Print Notes, etc ... see XPaths.
- A sample of standalone script (Adam Sampson) which parses a Gramps XML file for drawing a family tree.
- Gramps-php-exporter
- A Joomla! component/module for uploading the Gramps XML database and for showing genealogical information and overviews.
- PhpGedView supports 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 partial support on version 4.3.0.
- Greasemonkey scripts (Michiel Nauta)
- GrampsXMLview is a number of PHP scripts in combination with a Gramps XML database.
- ...