Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FamilySearch/gedcom5-conversion

Utilities for GEDCOM 5.5 to GEDCOM X Conversion
https://github.com/FamilySearch/gedcom5-conversion

Last synced: about 1 month ago
JSON representation

Utilities for GEDCOM 5.5 to GEDCOM X Conversion

Awesome Lists containing this project

README

        

GEDCOM 5.5 to GEDCOM X Converter
================================

This utility converts a [GEDCOM 5.5 file](http://www.gedcomx.org/GEDCOM-5.5.1.pdf) to a
[GEDCOM X file](https://github.com/FamilySearch/gedcomx/blob/master/specifications/file-format-specification.md).
The utility leverages the [GEDCOM 5.5 parsing library](https://github.com/FamilySearch/gedcom5-java)
contributed by Dallan Quass and the [GEDCOM X file format writer](https://github.com/FamilySearch/gedcomx-fileformat-java)
contributed by FamilySearch. This converter follows the [Legacy GEDCOM Migration Path](http://www.gedcomx.org/Legacy-GEDCOM-Migration-Path.html)
as detailed by the [GEDCOM X project](http://www.gedcomx.org).

## Usage

Someday, [we may get a GUI for this utility](https://github.com/FamilySearch/gedcom5-conversion/issues/1).
But for now, you're going to have to run it from the command line:

1. [Install the Java Runtime Environment](http://java.com/en/download/index.jsp).
2. [Download the latest version of the utility](https://repo1.maven.org/maven2/org/gedcomx/gedcom5-conversion/) (e.g. `gedcom5-conversion-1.13.0-full.jar`) and save it on your filesystem (e.g. `/tmp/gedcom-converter.jar`). (Be sure to download the "full" jar, otherwise you'll get a "no main manifest attribute" error message.)
3. Go find a GEDCOM file and put it on your filesystem (e.g. `/tmp/my.ged`).
4. Run the command:

```
$ java -jar /tmp/gedcom-converter.jar -i /tmp/my.ged -o /tmp/my.gedx
```

Assuming the above command is successful, the GEDCOM X file will be written to `/tmp/my.gedx`. Since the file
is based on the ZIP file format, you can open it up with your favorite unzip program to see the contents.

## Developers

This library is a [Maven](http://maven.apache.org/)-based project. Here are the maven coordinates:

```xml

org.gedcomx
gedcom5-conversion
${gedcom5-conversion.version}

```

## Building From Source

1. Clone the repo.
2. `mvn clean install`

## Status

There are still some things to be done. Here are some high-level notes on the status of this conversion tool.

### All Records

The following are not currently converted on all types of records:

* Notes (NOTE tag)
* Multimedia (OBJE tag)
* LDS Ordinances
* ID's such as RIN, RFN, REFN and AFN tags
* RESN tag
* AGE tag is not supported on the event structures
* Generic events (EVEN tag)

### Individual

The following are not currently converted on an individual records:

* Tags: ALIA ASSO
* Generic facts (FACT tag)

### Family

Families are converted into binary relationships (couple and parent-child). All tags are supported except the tags not supported on all records.

### Contributor

All tags are supported except the tags not supported on all records.

### Source

The following are not currently converted on an individual records:

* Tags: TEXT

### Repository

All tags are supported except the tags not supported on all records.