Opened 11 years ago

Last modified 11 years ago

#10652 closed enhancement

Add support for uploading static html doc page as a worksheet in the notebook — at Version 7

Reported by: nthiery Owned by: nthiery
Priority: critical Milestone: sage-4.7
Component: notebook Keywords: days28, Sphinx, upload, static html documentation
Cc: jason, hivert, slabbe Merged in:
Authors: Nicolas M. Thiéry, ... Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by nthiery)

This patch adds (experimental) support for uploading a static html doc page as a worksheet in the notebook. As a side effect, it:

  • allows for uploading a .txt file from a URL (was broken)
  • allows for uploading a zip file containing .txt and .html files

This little feature would give a very simple workflow for distributing tutorial worksheets during our Sage(-Combinat) workshops, saving a lot of hassle and time to both us and the participants (more detail upon request). It would be great if this feature could be in the sage stable release by early May for the next Sage-Combinat workshop in Acadia.

I wrote the attached small patch as a proof of concept; however this is the first time I am touching the notebook code and I am not planning to invest in this direction in the short term. So I would be extremely glad if some notebook expert could take over this patch, clean it up (look for TODO/FIXME), and rebase it upon #10521 with whom it probably conflicts lightly (this should be a breeze).

Little issues:

  • url's ending with something like #blah are not supported, whereas our current setup creates links with such. Maybe the #blah part could be stripped out. Or we should fix our setup :-)
  • The produced worksheet does not look as nice as a usual worksheet or the live documentation (in particular, there are some useless navigation links on top). That's probably a question of style file. Or maybe the navigation links should be stripped out.

Future extensions:

  • Add support for attachements, non text outputs, etc (they are currently lost during the upload)

Related tickets:

  • #4825: Uploading a pdf which contains an attached .sws will extract the .sws
  • #7441: notebook: make it possible to upload from the url of a published worksheet
  • #9875: Can't upload from a notebook link, only from a .sws file
  • #10521: notebook upload of zipped worksheets can't deal with multiple worksheets with the same name

Thanks so much in advance!!!

Nicolas

Change History (7)

comment:1 Changed 11 years ago by nthiery

  • Description modified (diff)
  • Status changed from new to needs_review

comment:2 Changed 11 years ago by jason

  • Cc jason added

comment:3 Changed 11 years ago by jason

  • Description modified (diff)

Added #4825 to the list of related tickets. That ticket proposes that uploading pdf files with attached .sws files would extract the .sws file and put it in the users list of worksheets. I could see this also being useful for tutorials, books, articles, etc.

comment:4 follow-up: Changed 11 years ago by jason

This little feature would give a very simple workflow for distributing tutorial worksheets during our Sage(-Combinat) workshops, saving a lot of hassle and time to both us and the participants (more detail upon request).

I'm curious about how you plan on using this. I'd love an easy way to distribute lots of tutorials.

comment:5 Changed 11 years ago by hivert

  • Cc hivert added

+1 !!! We badly need it !!!

Florent

comment:6 in reply to: ↑ 4 Changed 11 years ago by nthiery

  • Owner changed from jason, mpatel, was to nthiery

Hi Jason!

I'm curious about how you plan on using this. I'd love an easy way to distribute lots of tutorials.

So much for being lazy :-) Here it is!

We write our tutorials as rst files in the reference manual (exact location under discussion), and share them using our Sage-Combinat patch server ([1]). On any server, we compile the html documentation, and make it available to the participants ([2]).

Finaly, we point the participants to [3]. They can then click on any of the static tutorials; if they like it, they can just copy paste the url [4] from their brower into the "Upload" field of their notebook.

Note: in case the server runs a notebook server, or if one has the sage-combinat patches installed, then one can directly use the live documentation.

Cheers,

Nicolas

[1] http://combinat.sagemath.org/hgwebdir.cgi/patches/file/tip/sage-demos-and-tutorials-nt.patch [2] http://combinat.sagemath.org/doc/reference/demos/ [3] http://combinat.sagemath.org/doc/reference/demos/2011-01-17-SageDays28.html [4] http://combinat.sagemath.org/doc/reference/demos/demo-algebraic-combinatorics-short.html

comment:7 Changed 11 years ago by nthiery

  • Description modified (diff)
Note: See TracTickets for help on using tickets.