W3C home > Mailing lists > Public > public-csv-wg@w3.org > June 2014

Names & Titles (Was: Re: Attempted example CSV metadata document and template)

From: Jeni Tennison <jeni@jenitennison.com>
Date: Sun, 15 Jun 2014 12:32:22 +0100
To: CSV on the Web Working Group <public-csv-wg@w3.org>, Tandy, Jeremy <jeremy.tandy@metoffice.gov.uk>
Message-ID: <etPan.539d8446.327b23c6.155@jenit.local>
Jeremy, thanks for doing this. It’s always good to have a worked example.

Regarding names and titles (and ‘short names’ that you’ve introduced). The intention in the metadata document is for the `name` property to be the equivalent to the `short-name` in your example: the canonical, unique, column name that can be used as the basis for conversions. See [1].

The `title` property is for human-readable names. If there are several of these in a particular language then you can use an array. For example, you could have:

{
  "name": "dew-point-temp",
  "title": [
    "Dew-point temperature (Cel)",
    "Dew-point temperature (Celsius)"
   ],
   ...
}

to indicate that both "Dew-point temperature (Cel)" and "Dew-point temperature (Celsius)" are acceptable titles (to appear in the header line of a CSV file that adheres to the schema) but that the name `dew-point-temp` is the one to use in references to the column (eg within the metadata file), and in conversions into other formats.

Does that seem reasonable?

Cheers,

Jeni

[1] http://w3c.github.io/csvw/metadata/#column-name

------------------------------------------------------
From: Tandy, Jeremy jeremy.tandy@metoffice.gov.uk
Reply: Tandy, Jeremy jeremy.tandy@metoffice.gov.uk
Date: 12 June 2014 at 13:02:43
To: CSV on the Web Working Group public-csv-wg@w3.org
Subject:  Attempted example CSV metadata document and template

> All -
>  
> I've just uploaded to [GitHub][1] a rework of the "Simple Weather Observation" example.  
> I've tried to create a CSV metadata document following the rules in the [Metadata Vocabulary  
> for Tabular Data][2] and [Generating RDF from Tabular Data on the Web][3] documents.  
>  
> I would be particularly interested in:
>  
> - corrections to errors!
> - comments on additional proposed properties in the metadata document ("short-name",  
> "template", "microsyntax")
> - use of "hasFormat" to specify the Content-Type associated with a Template
> - use of a REGEXP within a URI Template to convert ISO 8601 syntax to a simplified form
> - thoughts about a way to describe that microsyntax format within the metadata document  
> (see CellMicrosyntax requirement][4]), e.g. to define the sub-elements within the  
> microsyntax that may be extracted for use later - see [Parsing cell microsyntax][5].  
>  
> Comments welcome.
>  
> Jeremy
>  
>  
> [1]: https://github.com/w3c/csvw/blob/gh-pages/examples/csv-metadata-and-template-for-simple-weather-obs-example.md  
> [2]: http://w3c.github.io/csvw/metadata/index.html
> [3]: http://w3c.github.io/csvw/csv2rdf/
> [4]: http://w3c.github.io/csvw/use-cases-and-requirements/#R-CellMicrosyntax  
> [5]: https://github.com/w3c/csvw/blob/gh-pages/examples/csv-metadata-and-template-for-simple-weather-obs-example.md#parsing-cell-microsyntax  
>  
>  
>  

--  
Jeni Tennison
http://www.jenitennison.com/
Received on Sunday, 15 June 2014 11:32:46 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 20:21:40 UTC