Extend Standard with a JSON Encoding

tkw1536 commented 5 years ago

This PR proposes an extension of the OpenMath standard to endorse an OpenMath JSON Encoding. JSON is a lightweight data-interchange format used heavily in the Web Applications area. Adding a JSON Encoding thus contributes to making OpenMath web-interoperable. The source code for a validator of this proposed encoding, as well as a translator from/to the XML encoding can be found at [1]. It is also accessible via API at [2].

Me and @kohlhase presented this encoding during the OpenMath workshop at CICM 2018 (see [3] and [4]), however we were only able to make a concrete standard proposal until now. We are hoping to discuss this during the upcoming OpenMath workshop at CICM 2019 next week, however wanted to send out our proposal beforehand.

[1] https://github.com/tkw1536/OpenMath-JSON [2] https://omjson.openmath.org [3] http://ceur-ws.org/Vol-2307/paper53.pdf [4] https://www.cicm-conference.org/2018/slides/OpMa2.pdf

JamesHDavenport commented 5 years ago

Thanks for this. I see the new section 3.3. What else changed beyond this? I think we’ll need to hack the change marking!

From: Tom Wiesing [mailto:notifications@github.com] Sent: 05 July 2019 14:29 To: OpenMath/OMSTD OMSTD@noreply.github.com Cc: Subscribed subscribed@noreply.github.com Subject: [OpenMath/OMSTD] Extend Standard with a JSON Encoding (#69)

This PR proposes an extension of the OpenMath standard to endorse an OpenMath JSON Encoding. JSON is a lightweight data-interchange format used heavily in the Web Applications area. Adding a JSON Encoding thus contributes to making OpenMath web-interoperable. The source code for a validator of this proposed encoding, as well as a translator from/to the XML encoding can be found at [1]. It is also accessible via API at [2].

Me and @kohlhasehttps://github.com/kohlhase presented this encoding during the OpenMath workshop at CICM 2018 (see [3] and [4]), however we were only able to make a concrete standard proposal until now. We are hoping to discuss this during the upcoming OpenMath workshop at CICM 2019 next week, however wanted to send out our proposal beforehand.

[1] https://github.com/tkw1536/OpenMath-JSON [2] https://omjson.openmath.org [3] http://ceur-ws.org/Vol-2307/paper53.pdf [4] https://www.cicm-conference.org/2018/slides/OpMa2.pdf

You can view, comment on, or merge this pull request online at:

https://github.com/OpenMath/OMSTD/pull/69

Commit Summary

Add OMJSON first (rough) draft
OMJSON: Add changes based on current revision
Iterate on the OpenMath JSON changes
OMJSON: Describe changes and make more references.

File Changes

M omstd20.xmlhttps://github.com/OpenMath/OMSTD/pull/69/files#diff-0 (1067)
A openmath2.d.tshttps://github.com/OpenMath/OMSTD/pull/69/files#diff-1 (256)
A openmath2.jsonhttps://github.com/OpenMath/OMSTD/pull/69/files#diff-2 (750)
M runhttps://github.com/OpenMath/OMSTD/pull/69/files#diff-3 (5)
M xsl/omstd20.xslhttps://github.com/OpenMath/OMSTD/pull/69/files#diff-4 (3)

Patch Links:

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=ABV5VGOQZZZL4BLY3APIJVTP55EBBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4G5R3YDA, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ABV5VGIGD4PICZ4KTVRXNJTP55EBBANCNFSM4H6LKCTA.

kohlhase commented 5 years ago

@JamesHDavenport I am attaching a diff-marked PDF. You can see that apart from 3.3 there are a couple of mentions and the appendixes.

omstd20-diff.pdf

JamesHDavenport commented 5 years ago

Thanks – for some reason your diff looks better than the one I built. We should

a) Add Tom to authors

b) Retitle Appendix H (as now is).

c) Probably other things I can’t see at the moment. Will have another read.

From: Michael Kohlhase [mailto:notifications@github.com] Sent: 08 July 2019 06:47 To: OpenMath/OMSTD OMSTD@noreply.github.com Cc: James Davenport masjhd@bath.ac.uk; Mention mention@noreply.github.com Subject: Re: [OpenMath/OMSTD] Extend Standard with a JSON Encoding (#69)

@JamesHDavenporthttps://github.com/JamesHDavenport I am attaching a diff-marked PDF. You can see that apart from 3.3 there are a couple of mentions and the appendixes.

omstd20-diff.pdfhttps://github.com/OpenMath/OMSTD/files/3366808/omstd20-diff.pdf

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=ABV5VGJH7X27A3QEXRPPEJLP6LIFBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMA5KY#issuecomment-509087403, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ABV5VGNE73Q7V2DYHOS5DKTP6LIFBANCNFSM4H6LKCTA.

kohlhase commented 5 years ago

Dear James,

thanks for the comments,

On 08.07.19 07:58, James Davenport wrote:

Thanks – for some reason your diff looks better than the one I built. We should

a) Add Tom to authors seconded

b) Retitle Appendix H (as now is).

good catch, I had completely overlooked that.

c) Probably other things I can’t see at the moment. Will have another read.

yes please. The main open problem from my side is the licensing problem for the standard. Do you have any insight there?

Michael

From: Michael Kohlhase [mailto:notifications@github.com] Sent: 08 July 2019 06:47 To: OpenMath/OMSTD OMSTD@noreply.github.com Cc: James Davenport masjhd@bath.ac.uk; Mention mention@noreply.github.com Subject: Re: [OpenMath/OMSTD] Extend Standard with a JSON Encoding (#69)

@JamesHDavenporthttps://github.com/JamesHDavenport I am attaching a diff-marked PDF. You can see that apart from 3.3 there are a couple of mentions and the appendixes.

omstd20-diff.pdfhttps://github.com/OpenMath/OMSTD/files/3366808/omstd20-diff.pdf

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=ABV5VGJH7X27A3QEXRPPEJLP6LIFBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMA5KY#issuecomment-509087403, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ABV5VGNE73Q7V2DYHOS5DKTP6LIFBANCNFSM4H6LKCTA.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=AA6ZXIRRTODT6RCDEPANCRLP6LJPBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMBOGY#issuecomment-509089563, or mute the thread https://github.com/notifications/unsubscribe-auth/AA6ZXIXEQMSHPLJD3MEHSRDP6LJPBANCNFSM4H6LKCTA.

--

Prof. Dr. Michael Kohlhase, http://kwarc.info/kohlhase, skype: mibein42

Professur für Wissensrepräsentation & -verarbeitung Informatik, FAU Erlangen Nürnberg, Martensstr. 3, D-91058 Erlangen, Room 11.139, tel/fax: (49) 9131-85-64052/55, michael.kohlhase@fau.de

physikerwelt commented 5 years ago

Will the JSON standard forward the conversion between MathML and math.js https://github.com/josdejong/mathjs/issues/308?

kohlhase commented 5 years ago

I have added the requests from James, and fixed some problems (editorial) along the way.

kohlhase commented 5 years ago

Will the JSON standard forward the conversion between MathML and math.js josdejong/mathjs#308?

I do not think this applies. math.js seems to be about presentation MathML, OpenMath is equivalent ot content MathML and thus a very different thing.

physikerwelt commented 5 years ago

I think they really want to have content (see also the closed duplicate issue https://github.com/josdejong/mathjs/issues/566) While their content structure is different from content MathML, it still is content, cf. https://mathjs.org/docs/expressions/expression_trees.html

car222222 commented 5 years ago

Michael, James

I also noted some typos etc. in Appendix G, at the start:

. . . the the TypeScript definition file in Appendix G.

should probably be:

. . . the TypeScript definition file in Appendix F.

And at the end of Appendix D, the box containing the file does not seem to be (visually) closed.

Chris

On 8 Jul 2019, at 15:41, Michael Kohlhase notifications@github.com wrote:

Dear James,

thanks for the comments,

On 08.07.19 07:58, James Davenport wrote:

Thanks – for some reason your diff looks better than the one I built. We should

a) Add Tom to authors seconded

b) Retitle Appendix H (as now is).

good catch, I had completely overlooked that.

c) Probably other things I can’t see at the moment. Will have another read.

yes please. The main open problem from my side is the licensing problem for the standard. Do you have any insight there?

Michael

From: Michael Kohlhase [mailto:notifications@github.com] Sent: 08 July 2019 06:47 To: OpenMath/OMSTD OMSTD@noreply.github.com Cc: James Davenport masjhd@bath.ac.uk; Mention mention@noreply.github.com Subject: Re: [OpenMath/OMSTD] Extend Standard with a JSON Encoding (#69)

@JamesHDavenporthttps://github.com/JamesHDavenport I am attaching a diff-marked PDF. You can see that apart from 3.3 there are a couple of mentions and the appendixes.

omstd20-diff.pdfhttps://github.com/OpenMath/OMSTD/files/3366808/omstd20-diff.pdf

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=ABV5VGJH7X27A3QEXRPPEJLP6LIFBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMA5KY#issuecomment-509087403, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ABV5VGNE73Q7V2DYHOS5DKTP6LIFBANCNFSM4H6LKCTA.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=AA6ZXIRRTODT6RCDEPANCRLP6LJPBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMBOGY#issuecomment-509089563, or mute the thread https://github.com/notifications/unsubscribe-auth/AA6ZXIXEQMSHPLJD3MEHSRDP6LJPBANCNFSM4H6LKCTA.

--

Prof. Dr. Michael Kohlhase, http://kwarc.info/kohlhase, skype: mibein42

Professur für Wissensrepräsentation & -verarbeitung Informatik, FAU Erlangen Nürnberg, Martensstr. 3, D-91058 Erlangen, Room 11.139, tel/fax: (49) 9131-85-64052/55, michael.kohlhase@fau.de

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

car222222 commented 5 years ago

Dear Chris,

thanks for the reading.

On 08.07.19 17:51, Christopher Rowley wrote:

Michael, James

I also noted some typos etc. in Appendix G, at the start:

. . . the the TypeScript definition file in Appendix G.

should probably be:

. . . the TypeScript definition file in Appendix F. I have corrected this.

And at the end of Appendix D, the box containing the file does not seem to be (visually) closed.

hmmm, in the html version it is. I am not sure what to do about the generated TeX.

Michael

Chris

On 8 Jul 2019, at 15:41, Michael Kohlhase <notifications@github.com mailto:notifications@github.com> wrote:

Dear James,

thanks for the comments,

On 08.07.19 07:58, James Davenport wrote:

Thanks – for some reason your diff looks better than the one I built. We should

a) Add Tom to authors seconded

b) Retitle Appendix H (as now is).

good catch, I had completely overlooked that.

c) Probably other things I can’t see at the moment. Will have another read.

yes please. The main open problem from my side is the licensing problem for the standard. Do you have any insight there?

Michael

From: Michael Kohlhase [mailto:notifications@github.com] Sent: 08 July 2019 06:47 To: OpenMath/OMSTD <OMSTD@noreply.github.com mailto:OMSTD@noreply.github.com> Cc: James Davenport <masjhd@bath.ac.uk mailto:masjhd@bath.ac.uk>; Mention <mention@noreply.github.com mailto:mention@noreply.github.com> Subject: Re: [OpenMath/OMSTD] Extend Standard with a JSON Encoding (#69)

@JamesHDavenporthttps://github.com/JamesHDavenport I am attaching a diff-marked PDF. You can see that apart from 3.3 there are a couple of mentions and the appendixes.

omstd20-diff.pdfhttps://github.com/OpenMath/OMSTD/files/3366808/omstd20-diff.pdf

— You are receiving this because you were mentioned. Reply to this email directly, view it on

GitHubhttps://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=ABV5VGJH7X27A3QEXRPPEJLP6LIFBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMA5KY#issuecomment-509087403, or mute the

threadhttps://github.com/notifications/unsubscribe-auth/ABV5VGNE73Q7V2DYHOS5DKTP6LIFBANCNFSM4H6LKCTA.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub

https://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=AA6ZXIRRTODT6RCDEPANCRLP6LJPBA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMBOGY#issuecomment-509089563, or mute the thread

https://github.com/notifications/unsubscribe-auth/AA6ZXIXEQMSHPLJD3MEHSRDP6LJPBANCNFSM4H6LKCTA.

--

Prof. Dr. Michael Kohlhase, http://kwarc.info/kohlhase, skype: mibein42

Professur für Wissensrepräsentation & -verarbeitung Informatik, FAU Erlangen Nürnberg, Martensstr. 3, D-91058 Erlangen, Room 11.139, tel/fax: (49) 9131-85-64052/55, michael.kohlhase@fau.de mailto:michael.kohlhase@fau.de

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=AFBL5E5LE6KYPX7SXTGAPN3P6L4STA5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZMMQWI#issuecomment-509134937, or mute the thread https://github.com/notifications/unsubscribe-auth/AFBL5EYOV2ENURYMHLUUC33P6L4STANCNFSM4H6LKCTA.

--

Prof. Dr. Michael Kohlhase, http://kwarc.info/kohlhase, skype: mibein42

Professur für Wissensrepräsentation & -verarbeitung Informatik, FAU Erlangen Nürnberg, Martensstr. 3, D-91058 Erlangen, Room 11.139, tel/fax: (49) 9131-85-64052/55, michael.kohlhase@fau.de

car222222 commented 5 years ago

Maybe just an artefact of my browser then.

Chris

On 9 Jul 2019, at 15:44, Michael Kohlhase michael.kohlhase@fau.de wrote:

hmmm, in the html version it is.

tkw1536 commented 5 years ago

@car222222 I realized that the .json and .d.ts don't show up in the PDF because we haven't updated omstd20tex.xsl. I tried this locally, but any change I make seems to break the TeX (looked like a bunch of catcode magic not working as intended). @davidcarlisle can you maybe help with this?

davidcarlisle commented 5 years ago

I'll look, possibly not today though

davidcarlisle commented 5 years ago

A meta question is whether we need the PDF version (I plan to do MathML as HTML only) multiple formats is sort of interesting to do but puts extra resources on maintaining the build process.....

JamesHDavenport commented 5 years ago

I personally prefer the PDF, but that’s not a strong reason.

From: David Carlisle [mailto:notifications@github.com] Sent: 09 July 2019 16:55 To: OpenMath/OMSTD OMSTD@noreply.github.com Cc: James Davenport masjhd@bath.ac.uk; Mention mention@noreply.github.com Subject: Re: [OpenMath/OMSTD] Extend Standard with a JSON Encoding (#69)

A meta question is whether we need the PDF version (I plan to do MathML as HTML only) multiple formats is sort of interesting to do but puts extra resources on maintaining the build process.....

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/OpenMath/OMSTD/pull/69?email_source=notifications&email_token=ABV5VGJ5IALWNFVW7HMHGDLP6SYG5A5CNFSM4H6LKCTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZQW2JI#issuecomment-509701413, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ABV5VGLUAVB4VUX7AKZZ2FDP6SYG5ANCNFSM4H6LKCTA.

kohlhase commented 5 years ago

I have merged Lars' foreign object clarification on the master branch and in this fork.

The text is complete now, I think we can merge the pull request now, and then deal with the fixup of the PDF later.

OpenMath / OMSTD