Skip to content

GENEALOGIX Examples

This directory contains complete, working GENEALOGIX archives demonstrating various features and use cases. Each example is designed to teach specific concepts and provide practical templates for real genealogy research.

Learning Path

For Beginners

  1. Minimal - Start with the basics

    • Smallest valid archive
    • Required fields only
  2. Basic Family - Simple nuclear family

    • Core relationships
    • Easy to understand
  3. Complete Family - Recommended starting point

    • Most entity types demonstrated
    • Complete evidence chains
    • Real-world family structure

Real-World Scale

  1. Westeros: A Song of Ice and Fire - Large-scale archive
    • 790+ persons across 70+ houses
    • Full evidence chains with 1,800+ assertions
    • 200+ custom vocabulary types
    • Demonstrates every GLX feature at scale

Advanced Concepts

  1. Single-File - Single-file archives

    • All entities in one file
    • Portable format
  2. Assertion Workflow - Evidence documentation

    • Direct properties vs assertion-backed properties
    • Complete evidence chain pattern
    • Iterative research workflow
  3. Temporal Properties - Time-changing values

    • Properties that change over time
    • Occupations, residences, names
    • Date-stamped values
  4. Participant Assertions - Event participants

    • Assertion-based participant roles
    • Evidence for event participation

Example Descriptions

ExampleFocusUse Case
MinimalEssentialsSmallest valid archive
Basic FamilyRelationshipsNuclear family structure
Complete FamilyAll featuresComprehensive demonstration
Single-FilePortabilitySimple sharing/backup
Assertion WorkflowEvidence chainsDirect vs assertion-backed properties
Temporal PropertiesTime-changing dataChanging occupations/names
Participant AssertionsEvent participationEvidence-based participants
WesterosScale & custom vocabularies790+ persons, 200+ custom types, full evidence chains

Validation

bash
glx validate examples/complete-family/
# All examples pass validation

Contributing

To add new examples, see the Contributing Guide.

References

Licensed under Apache License 2.0