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

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

From: Tandy, Jeremy <jeremy.tandy@metoffice.gov.uk>
Date: Tue, 17 Jun 2014 13:57:02 +0000
To: Jeni Tennison <jeni@jenitennison.com>, CSV on the Web Working Group <public-csv-wg@w3.org>, Yakov Shafranovich <yakov-ietf@shaftek.org>
Message-ID: <2624871D9A05174691BD59F8EFD68AE2088484D1@EXXCMPD1DAG3.cmpd1.metoffice.gov.uk>
Thanks for the confirmation Jeni.

This would also answer [Yakov's question][1] about titles not needing to be unique as the matching is based on the list order.

Have fixed my example to follow your suggestions (use of 'columns' and natural language JSON-LD).

Jeremy 


[1]: http://lists.w3.org/Archives/Public/public-csv-wg/2014Jun/0102.html 

> -----Original Message-----
> From: Jeni Tennison [mailto:jeni@jenitennison.com]
> Sent: 17 June 2014 09:59
> To: CSV on the Web Working Group; Tandy, Jeremy
> Subject: RE: Names & Titles (Was: Re: Attempted example CSV metadata
> document and template)
> 
> Jeremy,
> 
> As currently specced, the ‘columns’ array in the metadata document
> (‘fields’ is used in datapackage.json) is an ordered list and the
> columns are matched by position. See [1].
> 
> As currently specced, the ‘title’ property [2] is a natural language
> property [3] which means that you can use the JSON-LD pattern for
> @type: @language properties, like this:
> 
> "title": {
>   "en": "Date-time",
>   "fr": "Date et l’heure"
> }
> 
> Jeni
> 
> [1] http://w3c.github.io/csvw/metadata/#schema-columns

> [2] http://w3c.github.io/csvw/metadata/#column-title

> [3] http://w3c.github.io/csvw/metadata/#dfn-natural-language-property

> 
> ------------------------------------------------------
> From: Tandy, Jeremy jeremy.tandy@metoffice.gov.uk
> Reply: Tandy, Jeremy jeremy.tandy@metoffice.gov.uk
> Date: 16 June 2014 at 09:35:00
> To: Jeni Tennison jeni@jenitennison.com, CSV on the Web Working Group
> public-csv-wg@w3.org
> Subject:  RE: Names & Titles (Was: Re: Attempted example CSV metadata
> document and template)
> 
> > Hi Jeni -
> >
> > Thanks for the clarification; I've updated the example (see below)
> ...
> > and changed the filename to ".json".
> >
> > One question: is the "fields" array in the metadata document an
> > ordered list, or do we expect parsers to match against the titles?
> >
> > Regarding the updated example [1], I've been a bit provocative and
> > used JSON-LD syntax to provide the titles in both English and French.
> Presumably this is OK too?
> >
> >
> > "schema": {"fields": [
> > {
> > "name": "datetime",
> > "title": [
> > {"@value": "Date-time", "@language": "en"},
> > {"@value": "Date et l'heure", "@language": "fr"} ],
> > "description": "Date-time that the observation occurred.",
> > "type": "dateTime",
> > "format": "YYYY-MM-DDThh:mm:ssZ",
> > "constraints": {
> > "required": true
> > }
> > },
> > {
> > "name": "air-temp",
> > "title": [
> > {"@value": "Air temperature (Cel)", "@language": "en"},
> > {"@value": "La température d'air (C)", "@language": "fr"} ],
> > "description": "Air temperature quantity value expressed in
> Celsius.",
> > "type": "double",
> > "constraints": {"required": true}
> > },
> > {
> > "name": "dew-point-temp",
> > "title": [
> > {"@value": "Dew-point temperature (Cel)", "@language": "en"},
> > {"@value": "Température du point de rosée (C)", "@language": "fr"} ],
> > "description": "Dew-point temperature quantity value expressed in
> > Celsius.",
> > "type": "double",
> > "constraints": {"required": true}
> > }
> > ]}
> >
> > Jeremy
> >
> >
> > [1]:
> > https://github.com/w3c/csvw/blob/gh-pages/examples/csv-metadata-and-

> te
> > mplate-for-simple-weather-obs-example.md
> >
> > > -----Original Message-----
> > > From: Jeni Tennison [mailto:jeni@jenitennison.com]
> > > Sent: 15 June 2014 12:32
> > > To: CSV on the Web Working Group; Tandy, Jeremy
> > > Subject: Names & Titles (Was: Re: Attempted example CSV metadata
> > > document and template)
> > >
> > > 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-

> an
> > > > d-
> > > te
> > > > mplate-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-

> > > CellMicrosynta
> > > > x
> > > > [5]:
> > > > https://github.com/w3c/csvw/blob/gh-pages/examples/csv-metadata-

> an
> > > > d-
> > > te
> > > > mplate-for-simple-weather-obs-example.md#parsing-cell-microsyntax
> > > >
> > > >
> > > >
> > >
> > > --
> > > Jeni Tennison
> > > http://www.jenitennison.com/

> >
> 
> --
> Jeni Tennison
> http://www.jenitennison.com/

Received on Tuesday, 17 June 2014 13:57:32 UTC

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