D4.3: Distributed, Collaborative, Versioned Editing of Active Documents in MathHub.info #92

Closed
minrk opened this Issue Sep 8, 2015 · 25 comments

Comments

Projects
None yet
5 participants
@minrk
Contributor

minrk commented Sep 8, 2015

  • WP4: User Interfaces
  • Lead Institution: Friedrich-Alexander Universität Erlangen/Nürnberg (FAU), formerly Jacobs Universität Bremen
  • Due: 2017-02-28 (Month 18)
  • Nature: Demonstrator
  • Task: T4.7 (#75): Active Documents Portal, T4.8 (#76): Visualisation system for 3D data in web-notebook
  • Proposal: p. 48
  • Final report

One of the most prominent features of a virtual research environment (VRE) is a unified user interface. The OpenDreamKit approach is to create a mathematical VRE by integrating various pre-existing mathematical software systems. There are two approaches that can serve as a basis for the OpenDreamKit UI: computational notebooks and active documents. The former allows for mathematical text around the computation cells of a real-eval-print loop of a mathematical software system and the latter makes semantically annotated documents active.

MathHub is a portal for active mathematical documents ranging from formal libraries of theorem provers to informal – but rigorous – mathematical documents lightly marked up by preserving LaTeX markup. In the OpenDreamKit project MathHub acts as:

  • A portal and management system for theory-graph structured active documents, i.e. documents that use the semantic structure of the document and the knowledge context it links to to render semantic services embedded in the document – it becomes active, i.e. interactive, reactive - see D4.2 (#91).

  • The repository for the Math-in-the-Middle (MitM) ontology, see D6.2 (#136). This ontology is used as a basis for interoperability of the mathematical software systems that make up the OpenDreamKit VRE toolkit, which is a crucial concern for work package WP6.

As the authoring, maintenance, and curation of theory-structured mathematical ontologies and the transfer of mathematical knowledge via active documents are an important part of the OpenDreamKit VRE toolkit, the editing facilities in MathHub play a great role for the project.

This report discusses the main design decisions of the editing facilities in MathHub; they can be assessed at http://mathhub.info.

@minrk minrk added this to the D4.3 milestone Sep 8, 2015

@minrk minrk self-assigned this Nov 3, 2015

@nthiery nthiery modified the milestones: Month 12: 2016-08-31, D4.3 Mar 22, 2016

@nthiery nthiery assigned kohlhase and unassigned minrk Mar 22, 2016

@kohlhase

This comment has been minimized.

Show comment
Hide comment
@kohlhase

kohlhase Jun 30, 2016

Member

We have done work on this, but that has been delayed by Constantin Jucovschi leaving. We could write up what we have, but I would like to see more work on this before we deliver.

Member

kohlhase commented Jun 30, 2016

We have done work on this, but that has been delayed by Constantin Jucovschi leaving. We could write up what we have, but I would like to see more work on this before we deliver.

@minrk

This comment has been minimized.

Show comment
Hide comment
@minrk

minrk Aug 4, 2016

Contributor

@kohlhase do you still want more time on this one? If so, we should probably do whatever we need to do formally for delaying a deliverable (@nthiery). Is there any help any of us can provide?

Contributor

minrk commented Aug 4, 2016

@kohlhase do you still want more time on this one? If so, we should probably do whatever we need to do formally for delaying a deliverable (@nthiery). Is there any help any of us can provide?

@bpilorget

This comment has been minimized.

Show comment
Hide comment
@bpilorget

bpilorget Aug 19, 2016

Contributor

@minrk We are working on the delay. It should not be a problem but we wait for the formal notice to change the due date here

Contributor

bpilorget commented Aug 19, 2016

@minrk We are working on the delay. It should not be a problem but we wait for the formal notice to change the due date here

@kohlhase

This comment has been minimized.

Show comment
Hide comment
@kohlhase

kohlhase Aug 21, 2016

Member

@kohlhase do you still want more time on this one?
@florian-rabe

Work on this deliverable (D4.3) has been delayed due to the somewhat unexpected uptake of the Math-in-the-Middle (MitM) architecture, which prompted us to re-allocate JacU resources to WP6 in the first year. We proppose to move the submission of this deliverable to month 18 (in time for the first project review, so that it can be presented there; after all it is a demonstrator). In this way, we can also include the MitM ontologies into the editing/display facilities of MathHub.info

@bpilorget is that the explanation you need?

Member

kohlhase commented Aug 21, 2016

@kohlhase do you still want more time on this one?
@florian-rabe

Work on this deliverable (D4.3) has been delayed due to the somewhat unexpected uptake of the Math-in-the-Middle (MitM) architecture, which prompted us to re-allocate JacU resources to WP6 in the first year. We proppose to move the submission of this deliverable to month 18 (in time for the first project review, so that it can be presented there; after all it is a demonstrator). In this way, we can also include the MitM ontologies into the editing/display facilities of MathHub.info

@bpilorget is that the explanation you need?

@bpilorget

This comment has been minimized.

Show comment
Hide comment
@bpilorget

bpilorget Aug 22, 2016

Contributor

@kohlhase Yes perfect, thank you.

Contributor

bpilorget commented Aug 22, 2016

@kohlhase Yes perfect, thank you.

@bpilorget

This comment has been minimized.

Show comment
Hide comment
@bpilorget

bpilorget Nov 21, 2016

Contributor

@minrk (WP leader) and @kohlhase (lead beneficiary)
This deliverable is due for February 2017

Contributor

bpilorget commented Nov 21, 2016

@minrk (WP leader) and @kohlhase (lead beneficiary)
This deliverable is due for February 2017

@minrk

This comment has been minimized.

Show comment
Hide comment
@minrk

minrk Dec 19, 2016

Contributor

@kohlhase what needs to be done to finish this deliverable for February?

Contributor

minrk commented Dec 19, 2016

@kohlhase what needs to be done to finish this deliverable for February?

@kohlhase

This comment has been minimized.

Show comment
Hide comment
@kohlhase

kohlhase Jan 9, 2017

Member

I will write up something; we already have done the work (mostly) and I can copy/paste a report.

Member

kohlhase commented Jan 9, 2017

I will write up something; we already have done the work (mostly) and I can copy/paste a report.

@kohlhase kohlhase referenced this issue Jan 16, 2017

Closed

Second grant agreement amendment #193

19 of 19 tasks complete
@nthiery

This comment has been minimized.

Show comment
Hide comment
@nthiery

nthiery Feb 6, 2017

Contributor

Dear M18 deliverable leaders,

Just a reminder that reports are due for mid-february, to buy us some time for proofreading, feedback, and final submission before February 28th. See our README for details on the process.

In practice, I'll be offline February 12-19, and the week right after will be pretty busy. Therefore, it would be helpful if a first draft could be available sometime this week, so that I can have a head start reviewing it.

Thanks in advance!

Contributor

nthiery commented Feb 6, 2017

Dear M18 deliverable leaders,

Just a reminder that reports are due for mid-february, to buy us some time for proofreading, feedback, and final submission before February 28th. See our README for details on the process.

In practice, I'll be offline February 12-19, and the week right after will be pretty busy. Therefore, it would be helpful if a first draft could be available sometime this week, so that I can have a head start reviewing it.

Thanks in advance!

@minrk

This comment has been minimized.

Show comment
Hide comment
@minrk

minrk Feb 9, 2017

Contributor

@kohlhase is there anything I can do to facilitate getting a draft of this report in soon?

Contributor

minrk commented Feb 9, 2017

@kohlhase is there anything I can do to facilitate getting a draft of this report in soon?

@kohlhase

This comment has been minimized.

Show comment
Hide comment
@kohlhase

kohlhase Feb 10, 2017

Member

no, not really. But I will have something at the end of the weekend.

Member

kohlhase commented Feb 10, 2017

no, not really. But I will have something at the end of the weekend.

@kohlhase

This comment has been minimized.

Show comment
Hide comment
@kohlhase

kohlhase Feb 16, 2017

Member

OK, I have completed the report document (it grew to 15 pages, since we had to describe the setup). This can be submitted from my PoV. It would be great, if someone could have a look at it soon, since I will be traveling from Saturday morning and probably offline until March 14.
If there is anything pressing to do, you can contact @tkw1536 or @Jazzpirate But I think that should be un-necessary.

Member

kohlhase commented Feb 16, 2017

OK, I have completed the report document (it grew to 15 pages, since we had to describe the setup). This can be submitted from my PoV. It would be great, if someone could have a look at it soon, since I will be traveling from Saturday morning and probably offline until March 14.
If there is anything pressing to do, you can contact @tkw1536 or @Jazzpirate But I think that should be un-necessary.

@minrk

This comment has been minimized.

Show comment
Hide comment
@minrk

minrk Feb 16, 2017

Contributor

Thanks!

Contributor

minrk commented Feb 16, 2017

Thanks!

@nthiery

This comment has been minimized.

Show comment
Hide comment
@nthiery

nthiery Feb 23, 2017

Contributor

Hi!
I have just been through the current report. Altogether it looks good. I just pushed a couple typo fixes and minor todo's. Here are some others todo's

  • Write an abstract to be put on the github issue description. The current introduction could basically serve as one. The only thing is to decide how to handle the one citation there; references to other deliverables can be achieved as usual with D4.2 (#91).

  • Figure 1: the layout could be optimized (more spacing between the nodes, ...) to improve readability.

  • The text needs line-by-line proofreading

  • The text could state early on, plausibly in the abstract, that the collaborative editing workflow is similar in nature to that of common website authoring systems (e.g. GitHub / gitlab pages, ...) which are based on distributed version controlled sources combined with a static website generator. One can then argue that this type of workflow is being massively used by a wide variety of users around the world and has proven to be practical, robust, and sound. Once this has been stated, one can highlight the specific challenges. E.g. the variety of documents, from informal to formal, which requires variants on the workflow, solid error reporting, ...

Cheers,

Contributor

nthiery commented Feb 23, 2017

Hi!
I have just been through the current report. Altogether it looks good. I just pushed a couple typo fixes and minor todo's. Here are some others todo's

  • Write an abstract to be put on the github issue description. The current introduction could basically serve as one. The only thing is to decide how to handle the one citation there; references to other deliverables can be achieved as usual with D4.2 (#91).

  • Figure 1: the layout could be optimized (more spacing between the nodes, ...) to improve readability.

  • The text needs line-by-line proofreading

  • The text could state early on, plausibly in the abstract, that the collaborative editing workflow is similar in nature to that of common website authoring systems (e.g. GitHub / gitlab pages, ...) which are based on distributed version controlled sources combined with a static website generator. One can then argue that this type of workflow is being massively used by a wide variety of users around the world and has proven to be practical, robust, and sound. Once this has been stated, one can highlight the specific challenges. E.g. the variety of documents, from informal to formal, which requires variants on the workflow, solid error reporting, ...

Cheers,

@bpilorget

This comment has been minimized.

Show comment
Hide comment
@bpilorget

bpilorget Feb 24, 2017

Contributor

@nthiery Will do the English line by line proofreading by tomorrow

Contributor

bpilorget commented Feb 24, 2017

@nthiery Will do the English line by line proofreading by tomorrow

@nthiery

This comment has been minimized.

Show comment
Hide comment
@nthiery

nthiery Feb 27, 2017

Contributor

@florian-rabe, @kohlhase: anybody available from Kwark to finalize the little points mentionned above?
@bpilorget: how far are you with the proofreading?

Thanks,

Contributor

nthiery commented Feb 27, 2017

@florian-rabe, @kohlhase: anybody available from Kwark to finalize the little points mentionned above?
@bpilorget: how far are you with the proofreading?

Thanks,

@tkw1536

This comment has been minimized.

Show comment
Hide comment
@tkw1536

tkw1536 Feb 27, 2017

Contributor

@kohlhase is currently on vacation (~ until end of March), I will have a look at the points above.

Contributor

tkw1536 commented Feb 27, 2017

@kohlhase is currently on vacation (~ until end of March), I will have a look at the points above.

@tkw1536

This comment has been minimized.

Show comment
Hide comment
@tkw1536

tkw1536 Feb 27, 2017

Contributor

@nthiery I have just committed and pushed:

  • Added an abstract in the github description: also pulled that into the report itself
  • I updated Figure 1 as much as I could, but I am not exactly a tikz expert. There is more spacing now, but some of the texts don't quite want to center

I will do some proof reading later on (also counting on @Jazzpirate s help for that).
I will also try to incorporate your last point, but with the amount of time left and all the other things that I need to finish until tomorrow, I am not sure if I will be able to commit anything

Contributor

tkw1536 commented Feb 27, 2017

@nthiery I have just committed and pushed:

  • Added an abstract in the github description: also pulled that into the report itself
  • I updated Figure 1 as much as I could, but I am not exactly a tikz expert. There is more spacing now, but some of the texts don't quite want to center

I will do some proof reading later on (also counting on @Jazzpirate s help for that).
I will also try to incorporate your last point, but with the amount of time left and all the other things that I need to finish until tomorrow, I am not sure if I will be able to commit anything

@nthiery

This comment has been minimized.

Show comment
Hide comment
@nthiery

nthiery Feb 27, 2017

Contributor

Thanks @tkw1536! Do whatever you can for the last point, and let me know when you have run out of time and we should just consider this as done.

Contributor

nthiery commented Feb 27, 2017

Thanks @tkw1536! Do whatever you can for the last point, and let me know when you have run out of time and we should just consider this as done.

@bpilorget

This comment has been minimized.

Show comment
Hide comment
@bpilorget

bpilorget Feb 27, 2017

Contributor

@nthiery @tkw1536 Corrected minor typos after line by line proofreading

Most of "TODOS" are gone in the latest version. But I noticed two flaws in "editing.tex":

  • paragraphe from lines 155 to 160 don't seem to make much sense (a lot of hyphens cutting the sentence)
  • Still one Todo line 162: must be erased or corrected
Contributor

bpilorget commented Feb 27, 2017

@nthiery @tkw1536 Corrected minor typos after line by line proofreading

Most of "TODOS" are gone in the latest version. But I noticed two flaws in "editing.tex":

  • paragraphe from lines 155 to 160 don't seem to make much sense (a lot of hyphens cutting the sentence)
  • Still one Todo line 162: must be erased or corrected
@bpilorget

This comment has been minimized.

Show comment
Hide comment
@bpilorget

bpilorget Feb 27, 2017

Contributor
  • updated the github issue
Contributor

bpilorget commented Feb 27, 2017

  • updated the github issue
@tkw1536

This comment has been minimized.

Show comment
Hide comment
@tkw1536

tkw1536 Feb 28, 2017

Contributor

I have just pushed some more edits, in particular I updated some of the screenshots and fixed a bunch of minor typos. I will do some more typo checking, but otherwise the report will have to stay as is from my side.
Concerning paragraph 155: I think it does make sense the way it is, one just needs to read the sentence a bit more carefully.

Contributor

tkw1536 commented Feb 28, 2017

I have just pushed some more edits, in particular I updated some of the screenshots and fixed a bunch of minor typos. I will do some more typo checking, but otherwise the report will have to stay as is from my side.
Concerning paragraph 155: I think it does make sense the way it is, one just needs to read the sentence a bit more carefully.

@nthiery

This comment has been minimized.

Show comment
Hide comment
@nthiery

nthiery Feb 28, 2017

Contributor

Ok, thanks. Let me know when you are done with the typo check, and I'll submit.

Contributor

nthiery commented Feb 28, 2017

Ok, thanks. Let me know when you are done with the typo check, and I'll submit.

@tkw1536

This comment has been minimized.

Show comment
Hide comment
@tkw1536

tkw1536 Feb 28, 2017

Contributor

@nthiery You can go ahead and submit now. I have read the report over once more and found no further typos.

Contributor

tkw1536 commented Feb 28, 2017

@nthiery You can go ahead and submit now. I have read the report over once more and found no further typos.

@nthiery

This comment has been minimized.

Show comment
Hide comment
@nthiery

nthiery Feb 28, 2017

Contributor

Submitted!
Thanks @tkw1536 and @kohlhase for pushing forward interfaces for collaborative edition of mathematical documents.
Thanks @minrk and @bpilorget for the help on the report.

Contributor

nthiery commented Feb 28, 2017

Submitted!
Thanks @tkw1536 and @kohlhase for pushing forward interfaces for collaborative edition of mathematical documents.
Thanks @minrk and @bpilorget for the help on the report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment