#10652: Add support for uploading static html doc page as a worksheet in the
notebook
--------------------------------------+-------------------------------------
   Reporter:  nthiery                 |       Owner:  nthiery                   
                       
       Type:  enhancement             |      Status:  needs_review              
                       
   Priority:  critical                |   Milestone:  sage-4.7                  
                       
  Component:  notebook                |    Keywords:  days28, Sphinx, upload, 
static html documentation
     Author:  Nicolas M. ThiƩry, ...  |    Upstream:  N/A                       
                       
   Reviewer:                          |      Merged:                            
                       
Work_issues:                          |  
--------------------------------------+-------------------------------------
Description changed by nthiery:

Old description:

> 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

New description:

 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!!!

 Apply: trac_10652-upload-static-documentation-as-worksheet-nt.patch in the
 sagenb repository
                                         Nicolas

--

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10652#comment:18>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to