[CF-metadata] Proposals for Versioning CF Conventions and Standard Names on Github

From: Chris Barker <chris.barker>
Date: Mon, 22 Sep 2014 09:28:04 -0700

On Mon, Sep 22, 2014 at 8:24 AM, Christopher Duncombe Rae - NOAA Affiliate <
christopher.duncombe.rae at noaa.gov> wrote:

> Another point which you did not stress is that with a revision tracking
> system like git / github, the evolution of the document can be tracked and
> if necessary reverting to an earlier version is almost trivial.
>

Yes -- a great feature.

But it requires that you use a document format that is amenable to diff-ing
and merging. i.e a simple hard to break text format.

Structured text markup may be the best: ReStructured Text or Markdown
LaTeX is pretty good.
A general markup language like YAML or JSON could be good, too, if tehre is
a tool for making it into nice html/pdf, etc documents.
XML can be done, but is ugly and painful

MS-Word, OpenOffice, and the like make it pretty much impossible.

Was a format settled on in the last discussion about all this?

-Chris

-- 
Christopher Barker, Ph.D.
Oceanographer
Emergency Response Division
NOAA/NOS/OR&R            (206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115       (206) 526-6317   main reception
Chris.Barker at noaa.gov
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.cgd.ucar.edu/pipermail/cf-metadata/attachments/20140922/51b9947f/attachment.html>

Received on Mon Sep 22 2014 - 10:28:04 BST