FamilySearch/gedcomx — Issue #133: A Tool to document the GEDCOMX Open Standard
Author: CMEliasz-Solomon
Created: 2012-02-09 09:22:32+00:00
State: open

As per Ryan Heaton's request to me, I am entering this issue [suggestion] so it can be tracked.

I propose this project use Graphic Syntax Diagrams to document and to communicate the GEDCOMX open standard.

For those not familiar, this was a technique used by Oracle to document their SQL standard including APIs. It can be found in Wikipedia at:

Syntax Diagram from Wiki:
http://en.wikipedia.org/wiki/Syntax_diagram

There is a free tool at Tucows repository that can draw Syntax Diagrams.
http://www.tucows.fi/preview/799942

Syntax diagrams are rooted in representing language grammars in Backus-Naur Form (or BNF). The above tool does Extended Backus-Naur Form (eBNF). The power of these diagrams to communicate has been shown via Oracle's use to its large community. It also is a format that parses easily and efficiently.