Changes between Initial Version and Version 5 of Ticket #26104


Ignore:
Timestamp:
Aug 22, 2018, 9:34:25 AM (4 years ago)
Author:
Erik Bray
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #26104 – Description

    initial v5  
    55This is easily fixed as demonstrated in the fix for #24784, but there are a few problems with the current HTML result formatting:
    66
    7 1. Most importantly, it produces URLs to search results that only work in the legacy notebook (which has its own URLs for hosting the Sage docs).  Instead, I would propose that it produce links to doc.sagemath.org by default, but also have an optional `offline=True` option to produce `file:///` URLs if the docs are available offline.  The reason for making `offline=False` by default is that when running the Jupyter Notebook in a cloud-based setting, such as mybinder.org, producing `file:///` links would not be useful.
     71. Most importantly, it produces URLs to search results that only work in the legacy notebook (which has its own URLs for hosting the Sage docs).  ~~Instead, I would propose that it produce links to doc.sagemath.org by default, but also have an optional `offline=True` option to produce `file:///` URLs if the docs are available offline.  The reason for making `offline=False` by default is that when running the Jupyter Notebook in a cloud-based setting, such as mybinder.org, producing `file:///` links would not be useful.~~ As mentioned below, we don't need this because we can serve the docs through `/kernelspec/sagemath/doc`.  However, this should probably still check that the docs are installed locally so that they can be served by Jupyter.  If not, it would still make sense to fall back on doc.sagemath.org.
    88
    992. The HTML that is currently output is very "web 1.0", using tags and features that are deprecated in HTML5.  The output could easily be updated to modern HTML5 + CSS.