What format to use for the "sidecar" file?

[ChrisBarker-NOAA]

We talked about having a sidecar file with metadata about the example.

The idea is that we want to know various information about the example - what it's demonstrating, etc. and in a computer readable form so that we can use to generate a catalog.

WE did decide that we can figure out what to put in that sidecar file after we have a modest set of examples to study.

But what format should it be in?

Options:

• JSON
• YAML
• TOML
• INI
• XML

any other ideas?

My opinion -- it should be reasonably human readable / writable -- e.g. not XML.

[lhmarsden]

I personally prefer YAML.

• Easier for less technical people to read than JSON/XML
• Can add comments - which you can't do in JSON.

[sadielbartholomew]

I prefer (equally) YAML or JSON for their popularity, robustness and more intuitive format which means those new to the format shouldn't find it too taxing to pick up. But Luke's comment about comments is a good one and important given commenting would be very helpful for clarity for example datasets metadata - in which case YAML sounds like the best choice unless others have thoughts?

[agstephens]

I think YAML is great because it is more human-readable/writeable than JSON. I think these files should be both human and machine-readable.

[sadielbartholomew]

Nice, so YAML is emerging as the (justified) favourite - anyone with other preferences please speak ASAP!