Add document_info to schema #46

captainsafia · 2016-09-09T03:56:42Z

This adds a document_info object to the schema to hold the title and author of the document.

rgbkrk · 2016-09-09T04:09:20Z

nbformat/tests/test4docinfo.ipynb

+ "metadata": {},
+ "nbformat": 4,
+ "nbformat_minor": 0,
+ "document_info": {


I think we likely want title and author directly in the metadata section instead of a new top level key.

"metadata": { "author": "Jean Tester", "title": "Test Notebook" }

rgbkrk · 2016-09-09T04:09:50Z

Thanks for taking the lead on this!

westurner · 2016-09-09T06:34:52Z

Users can specify multiple authors as structured values
For schema.org, "title" is name http://schema.org/name

Expressing multiple authors with schema.org JSONLD:

{"@context": ["http://schema.org/", {"jupyter": "https://jupyter.org/ns/#" }],
 "@type": ["CreativeWork", "jupyter:JupyterNotebook"],
 "metadata": {
   "name": "Jupyter Notebook Title",
   "author": [
       {"@type": "Person",
         "name": "Author 1"},
       {"@type": "Person", 
         "familyName": "lastname",
         "givenName": "firstname",
         "worksFor": {"@type": "Organization", "name": "UniversityXYZ"},
         "affiliation": {"...":"..."},
         "url": "..."}
    ],
    "funder": [{"name": "UniversityXYZ"],
    "license": "https://creativecommons.org/licenses/by-sa/4.0/",
    "license": {"@type": "CreativeWork",
          "name": "CC by-SA 4.0",
          "url": "https://creativecommons.org/licenses/by-sa/4.0/"},
}

See also:

Add JSONLD @context to the top level .ipynb node #44 "Add JSONLD @context to the top level .ipynb node"
Fields for author/creator and title #45 "Fields for author/creator and title"

minrk · 2016-09-09T08:24:28Z

Thanks, @captainsafia! I agree with @rgbkrk's comment (also see discussion in #45) that I'd prefer this to add a definition for metadata fields: authors and title, rather than new fields in the schema, which has more complex spec-change implications.

captainsafia · 2016-09-09T16:25:31Z

Updated.

westurner · 2016-09-09T17:48:07Z

Could we please do name instead of 'title'?

Search engine compatibility
- http://schema.org/name

On Friday, September 9, 2016, Safia Abdalla notifications@github.com
wrote:

Updated.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#46 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AADGy_XLsRMn83SXSJDk9bN8b85BDSnOks5qoYh7gaJpZM4J4raO
.

captainsafia · 2016-09-09T18:00:35Z

Could we please do name instead of 'title'?

Search engine compatibility

http://schema.org/name

I'm hesitant to use name instead of title as it's fairly ambiguous, especially now that this document-specific info is stored in the metadata object. The benefits of aligning with the spec in my mind do not outweigh the confusion some users and devs might experience with the ambiguous naming.

westurner · 2016-09-09T18:42:19Z

I'm hesitant to use name instead of title as it's fairly ambiguous, especially now that this document-specific info is stored in the metadata object. The benefits of aligning with the spec in my mind do not outweigh the confusion some users and devs might experience with the ambiguous naming.

Search engines pick up <title> and http://schema.org/name
To make it possible for search engines to index notebook metadata later would require (impossible) migration; so it makes sense to fully specify with a web standard schema now.

Here's this, which is forked from your pull:

"SCH: name, author, license metadata properties (and @context for JSONLD)"
westurner@c298b08

minrk · 2016-09-12T08:37:08Z

I think title is a better choice for the title of a document. name is ambiguous, because it is easily confused with the filename, etc, and we intend to use this field specifically for title purposes. If the document went on nbviewer, etc. this is the string that would go in <title>, so title makes sense to me as the field name.

cc @ellisonbg and @fperez who have expressed interest in title/author metadata

minrk · 2016-09-12T08:38:30Z

nbformat/v4/nbformat.v4.schema.json

+                    "description": "The title of the notebook document",
+                    "type": "string"
+                },
+                "author": {


author probably needs to be a list of authors with a few fields, as described in #45 (comment)

westurner · 2016-09-12T18:48:02Z

I disagree. I think that, if the objective is to store metadata that will
be indexed by search engines (and EAV metadata repositories like (RDF)
triplestores), then it makes sense to use attributes/properties which are
indexed by search engines (e.g. schema:name).

On Monday, September 12, 2016, Min RK notifications@github.com wrote:

I think title is a better choice for the title of a document. name is
ambiguous, because it is easily confused with the filename, etc, and we
intend to use this field specifically for title purposes. If the
document went on nbviewer, etc. this is the string that would go in
<title>, so title makes sense to me as the field name.
cc @ellisonbg https://github.com/ellisonbg and @fperez
https://github.com/fperez who have expressed interest in title/author
metadata

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#46 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AADGy5MVYyIBBkdYohguaWnm46rR5sWUks5qpQ80gaJpZM4J4raO
.

westurner · 2016-09-12T18:49:08Z

<title>{{obj.name}}</title>

On Monday, September 12, 2016, Wes Turner wes.turner@gmail.com wrote:

I disagree. I think that, if the objective is to store metadata that will
be indexed by search engines (and EAV metadata repositories like (RDF)
triplestores), then it makes sense to use attributes/properties which are
indexed by search engines (e.g. schema:name).

On Monday, September 12, 2016, Min RK <notifications@github.com
javascript:_e(%7B%7D,'cvml','notifications@github.com');> wrote:

I think title is a better choice for the title of a document. name is
ambiguous, because it is easily confused with the filename, etc, and we
intend to use this field specifically for title purposes. If the
document went on nbviewer, etc. this is the string that would go in
<title>, so title makes sense to me as the field name.
cc @ellisonbg https://github.com/ellisonbg and @fperez
https://github.com/fperez who have expressed interest in title/author
metadata

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#46 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AADGy5MVYyIBBkdYohguaWnm46rR5sWUks5qpQ80gaJpZM4J4raO
.

ellisonbg · 2016-09-27T17:02:32Z

I agree with @minrk that "title" is a much better way of spelling this out. Also authors should be a list. Fully in favor of this though!

rgbkrk · 2016-09-27T17:51:06Z

nbformat/v4/nbformat.v4.schema.json

+                },
+                "author": {
+                    "description": "The author(s) of the notebook document",
+                    "type": "string"


@minrk @ellisonbg does it need to be a literal list or can a string suffice?

Especially if we are tackling Latex Export, I think it should be a list of object. Authors can have emails, phones affiliations, and be corresponding authors. Making it objects, leave it flexible.

List<Object> then?

From #46 (comment):

This makes author a list edit: (and adds a few properties which could be used for author metadata form generation): westurner/nbformat@c298b08

westurner · 2016-09-28T00:00:57Z

I agree with @minrk that "title" is a much better way of spelling this out.

http://schema.org/title (e.g. "Job Title")
http://schema.org/name (e.g. "name" of the document)

Also authors should be a list.

I agree.

This makes author a list (and adds a few properties): westurner@c298b08

captainsafia · 2016-09-28T00:19:23Z

Welp! Sorry for the delay. Updates are now present in PR. The only piece of data required for author is the name so we don't place too many requirements on users off the bat.

rgbkrk · 2016-09-28T00:20:32Z

nbformat/v4/nbformat.v4.schema.json

+                          "type": "string"
+                        }
+                      },
+                      "additionalProperties": true


Great, this gives us the flexibility to provide other fields later.

Perfect, thanks!

rgbkrk · 2016-10-07T12:10:12Z

Woo!

westurner · 2017-03-31T18:33:49Z

#91 "Store notebook title/name in metadata"

Add document_info to schema

5f8629f

rgbkrk reviewed Sep 9, 2016
View reviewed changes

westurner mentioned this pull request Sep 9, 2016

Fields for author/creator and title #45

Closed

3 tasks

Move title/author info to metadata object

e72f0c4

minrk reviewed Sep 12, 2016
View reviewed changes

rgbkrk reviewed Sep 27, 2016

View reviewed changes

Store author data in list

0a1efb9

rgbkrk reviewed Sep 28, 2016

View reviewed changes

rgbkrk approved these changes Sep 28, 2016

View reviewed changes

Carreau approved these changes Sep 29, 2016

View reviewed changes

minrk added this to the 4.2 milestone Oct 7, 2016

minrk merged commit f406b86 into jupyter:master Oct 7, 2016

minrk mentioned this pull request Oct 7, 2016

make authors plural #53

Merged

westurner mentioned this pull request Jan 29, 2017

Add JSONLD @context to the top level .ipynb node #44

Closed

7 tasks

westurner mentioned this pull request Feb 9, 2017

provide path for to_json/from_json of units for front-end astrofrog/numtraits#12

Open

mpacer mentioned this pull request Mar 30, 2017

Store notebook title/name in metadata #91

Closed

westurner mentioned this pull request Jan 24, 2019

NBViewer missing page title / meta description jupyter/nbviewer#164

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add document_info to schema #46

Add document_info to schema #46

captainsafia commented Sep 9, 2016

rgbkrk Sep 9, 2016 •

edited

Loading

rgbkrk commented Sep 9, 2016

westurner commented Sep 9, 2016 •

edited

Loading

minrk commented Sep 9, 2016

captainsafia commented Sep 9, 2016

westurner commented Sep 9, 2016

captainsafia commented Sep 9, 2016

westurner commented Sep 9, 2016

minrk commented Sep 12, 2016

minrk Sep 12, 2016

westurner commented Sep 12, 2016

westurner commented Sep 12, 2016

ellisonbg commented Sep 27, 2016

rgbkrk Sep 27, 2016

Carreau Sep 27, 2016

rgbkrk Sep 28, 2016

westurner Sep 28, 2016 •

edited

Loading

westurner commented Sep 28, 2016

captainsafia commented Sep 28, 2016 •

edited

Loading

rgbkrk Sep 28, 2016

minrk Sep 28, 2016

rgbkrk commented Oct 7, 2016

westurner commented Mar 31, 2017 •

edited

Loading

Add document_info to schema #46

Add document_info to schema #46

Conversation

captainsafia commented Sep 9, 2016

rgbkrk Sep 9, 2016 • edited Loading

Choose a reason for hiding this comment

rgbkrk commented Sep 9, 2016

westurner commented Sep 9, 2016 • edited Loading

minrk commented Sep 9, 2016

captainsafia commented Sep 9, 2016

westurner commented Sep 9, 2016

captainsafia commented Sep 9, 2016

westurner commented Sep 9, 2016

minrk commented Sep 12, 2016

minrk Sep 12, 2016

Choose a reason for hiding this comment

westurner commented Sep 12, 2016

westurner commented Sep 12, 2016

ellisonbg commented Sep 27, 2016

rgbkrk Sep 27, 2016

Choose a reason for hiding this comment

Carreau Sep 27, 2016

Choose a reason for hiding this comment

rgbkrk Sep 28, 2016

Choose a reason for hiding this comment

westurner Sep 28, 2016 • edited Loading

Choose a reason for hiding this comment

westurner commented Sep 28, 2016

captainsafia commented Sep 28, 2016 • edited Loading

rgbkrk Sep 28, 2016

Choose a reason for hiding this comment

minrk Sep 28, 2016

Choose a reason for hiding this comment

rgbkrk commented Oct 7, 2016

westurner commented Mar 31, 2017 • edited Loading

rgbkrk Sep 9, 2016 •

edited

Loading

westurner commented Sep 9, 2016 •

edited

Loading

westurner Sep 28, 2016 •

edited

Loading

captainsafia commented Sep 28, 2016 •

edited

Loading

westurner commented Mar 31, 2017 •

edited

Loading