⇐ ⇒

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

From: John Graybeal <jbgraybeal>
Date: Mon, 22 Sep 2014 12:52:58 -0700

On Sep 22, 2014, at 12:35, Signell, Richard <rsignell at usgs.gov> wrote:
> Does this mean the current CF source is docbook xml?
> https://github.com/cf-convention/repository-cf/tree/master/cf-conventions/trunk/docbooksrc

Sorry, correct -- the site is markup (see https://github.com/cf-convention/cf-convention.github.io), the conventions are built up out of docbook xml (https://github.com/cf-convention/cf-convention.github.io/tree/master/Data/cf-conventions); looks like the XML is local to cf-convention.github.io in version 1.7, but in the remote repository in version 1.6.

As Rich's first example pointed out, having the XML for the standard names in a repository is easy and useful, per that example.

John



On Sep 22, 2014, at 12:35, Signell, Richard <rsignell at usgs.gov> wrote:

> Does this mean the current CF source is docbook xml?
>
> https://github.com/cf-convention/repository-cf/tree/master/cf-conventions/trunk/docbooksrc
>
> On Mon, Sep 22, 2014 at 3:22 PM, Chris Barker <chris.barker at noaa.gov> wrote:
>>
>>
>> On Mon, Sep 22, 2014 at 9:45 AM, Christopher Duncombe Rae - NOAA Affiliate
>> <christopher.duncombe.rae at noaa.gov> wrote:
>>>
>>> LaTeX would get my vote every time.
>>
>>
>> The "problem" with LaTeX is that is it both:
>>
>> A little to "document" oriented - i.e. not really a data structure
>> and
>> Really a language, so anything can be re-defined, making it next to
>> impossible to translate in the general case.
>>
>> That being said, if you're disciplined about how you use it it can be a fine
>> option.
>>
>>>
>>> RST
>>
>>
>> RST, anyway, allows application-specific directives, to could be used pretty
>> well for a situation like this.
>>
>> Also, we could use different things for the main standards doc and the
>> standard name list, - -the latter being more structured data than a
>> document.
>>
>> -CHB
>>
>>
>>>
>>> or Markdown are a little too simple for a complicated document ultimately
>>> destined for hard copy publication. I would definitely stay well clear of
>>> `binary coded' formats like Word or OpenOffice. Although they have
>>> versioning features built in, these are not amenable to distributed
>>> collaboration in the way that git repositories makes possible. I do not know
>>> enough about YAML or JSON to comment, never having used them in documents.
>>>
>>> On Mon, Sep 22, 2014 at 12:28 PM, Chris Barker <chris.barker at noaa.gov>
>>> wrote:
>>>>
>>>> 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
>>>
>>>
>>>
>>>
>>> --
>>> --
>>> --
>>> =======================================================================
>>> Dr. Christopher M. Duncombe Rae christopher.duncombe.rae at noaa.gov
>>> Oceanographer / Data Scientist
>>> IOOS/NOAA, Suite 1225, 1100 Wayne Avenue, Silver Spring, MD 20910, USA
>>> Tel: +1-301-427-2450 Fax: +1-301-427-2073
>>
>>
>>
>>
>> --
>>
>> 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
>
>
>
> --
> Dr. Richard P. Signell (508) 457-2229
> USGS, 384 Woods Hole Rd.
> Woods Hole, MA 02543-1598
> _______________________________________________
> CF-metadata mailing list
> CF-metadata at cgd.ucar.edu
> http://mailman.cgd.ucar.edu/mailman/listinfo/cf-metadata

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.cgd.ucar.edu/pipermail/cf-metadata/attachments/20140922/26521d92/attachment-0001.html>
Received on Mon Sep 22 2014 - 13:52:58 BST

This archive was generated by hypermail 2.3.0 : Tue Sep 13 2022 - 23:02:42 BST

⇐ ⇒