Skip to content

GENEALOGIX Examples

Examples StatusValidationCoverage

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
    • Foundation concepts
  2. Basic Family - Simple nuclear family

    • Core relationships
    • Minimal evidence requirements
    • Easy to understand
  3. Complete FamilyRecommended

    • All 9 entity types demonstrated
    • Complete evidence chains
    • Real-world family structure
    • Best practices shown

Advanced Concepts

  1. Single-File - Single-file archives

    • All entities in one file
    • Portable format
    • Simple backup/sharing
  2. Temporal Properties - Time-changing values

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

    • Assertion-based participant roles
    • Conflicting evidence about participants
    • Evidence for relationships

Example Descriptions

ExampleFocusEntity TypesUse Case
MinimalEssentialsPersonSmallest valid archive
Basic FamilyRelationshipsPerson, RelationshipNuclear family structure
Complete FamilyAll featuresAll 9 typesComprehensive demonstration
Single-FilePortabilityAll in one fileSimple sharing/backup
Temporal PropertiesTime-changing dataPerson with temporal valuesChanging occupations/names
Participant AssertionsEvent participationAssertion-based rolesEvidence-based participants

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