Welcome. This developers guide is intended to help you get started using GEDCOM X in your development.
GEDCOM X is really just a set of specifications, so the first thing you have to do is identify which ones you care about. For the complete specification set, refer to Specifications, but here are some of the most relevant to developers:
- The GEDCOM X Conceptual Model specifies an abstract conceptual model for genealogical data, independent of any serialization format.
- The GEDCOM X XML Serialization Format specifies how to represent the conceptual model in XML.
- The GEDCOM X JSON Serialization Format specifies how to represent the conceptual model in JSON.
- The GEDCOM X File Format specifies how to bundle up genealogical data into a file.
The Conceptual Model
The first place you'll probably want to start is with an understanding of the GEDCOM X Conceptual Model, which defines the GEDCOM X data types (e.g. person, relationship, etc.) and how they relate to each other.
The following is a UML diagram of the data model. To see it closer, click on the image.
And this is a different visualization of the same data model.
The Media Types
GEDCOM X defines both an XML media type and a JSON media type for the conceptual model, and there may be definitions provided in the future for other media types. For the formal descriptions of these media types, see their respective specifications:
- The GEDCOM X XML Serialization Format (application/x-gedcom-v1+xml)
- The GEDCOM X JSON Serialization Format (application/x-gedcom-v1+json)
There is also some non-normative reference documentation provided.
There might be some code that you could use to start development. And as you develop, we'd love you to contribute your tools and libraries back to the community. Visit Code for more information.