Changes

Jump to: navigation, search

Generate XML

No change in size, 01:05, 12 February 2013
m
Gramps
{{languages}}
== GRAMPS Gramps and XML ==
GRAMPS Gramps is capable of importing and exporting an [[Gramps XML|XML file]] that contains all the information in the database. This file is useful for transferring data from one machine to another or for XML processing.
=== Generating XML ===
The easiest way to generate an XML file is to export the data. This can be done from the menu: {{man menu|Family Trees->Export }} or {{man menu|Family Trees->Backup...}}. This will generate a file with a <code>.gramps</code> extension. This file is usually a gzip'd XML file (depending on some system settings, sometimes this will be an uncompressed XML file).
GRAMPS Gramps compresses the file because XML files can become rather large. For large databases, this file could grow to 10s to 100s of megabytes in size. Fortunately, XML files compress nicely, usually producing a fairly small size.
=== How do I tell if the XML file is compressed? ===
./gramps2xml filename.gramps filename.xml
== Why doesn't GRAMPS Gramps just use a .gz extension? ==
GRAMPS Gramps uses the [http://freedesktop.org/wiki/Software/shared-mime-info Shared Mime System] defined by [http://freedesktop.org Free Desktop] project, and used by all major desktops, including KDE and GNOME. GRAMPS Gramps relies on the MIME type identified by the Shared Mime System to determine the file type of the file.
The Share Mime System allows you to identify a file's type by either using a file extension or by looking at the contents of a small section of the file. The first problem is, usually the filename or extension pattern has the higher priority compared to the contents: if the file is named <code>something.jpg</code> then it is likely to be JPEG image, not text. So if the Gramps XML file had added <code>.gz</code> extension to the name, the Shared Mime system would tell us that the file's type is <code>application/x-gzip</code> instead of the expected <code>application/x-gramps-xml</code>. Unfortunately, it cannot tell us that it is a gzip'd Gramps XML file.
The second problem is, if we looked at the contents, we would not be able to tell the difference between a gzip'd Gramps XML file or any other gzip'd file. If we looked at uncompressed data, we would not be able to tell the difference between a Gramps XML file and other XML files. So again, the Shared Mime system could not tell us that it is a gzip'd Gramps XML file.
For these reasons, we must rely on the <code>.gramps</code> extension. If we don't, we would not be able to tell if this was a valid file. Even worse, the mime type of <code>application/x-gzip</code> would be associated with another application (such as File Roller or Ark) instead of GRAMPSGramps. The mime type of <code>application/xml</code> may be associated with XML editors (Bluefish, Conglomerate, Emacs, etc). In that situation, the user double-clicking on the file in the file manager (or performing the default action for the type by any other means) will never launch GRAMPS Gramps with this data,
GRAMPS Gramps is not unique in this problem. For example, the OpenDocument format used by [http://www.documentfoundation.org/download/ LibreOffice], OpenOffice, StarOffice, [http://www.calligra-suite.org/ Calligra] and AbiWord is actually a collection of files in a <code>zip</code> archive. If you run <code>unzip</code> on a OpenDocument file, you will see something like:
$ unzip test.odt

Navigation menu