Differences between revisions 9 and 31 (spanning 22 versions)
⇤ ← Revision 9 as of 2009-09-04 05:27:39 →
Size: 4390
Editor: was
Comment:
← Revision 31 as of 2009-09-09 00:53:18 → ⇥
Size: 8884
Editor: was
Comment:
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/8fa0d854b6928f2b/dc4cfe0a941762aa#dc4cfe0a941762aa | reST back ticks versus $]] - Patch or extend Sphinx.  * [[http://groups.google.com/group/sage-devel/browse_thread/thread/8fa0d854b6928f2b/dc4cfe0a941762aa#dc4cfe0a941762aa | Use $ instead of back ticks for math in reST]] - [[http://trac.sagemath.org/sage_trac/ticket/6892 | #6892]].
Line 11: Line 11:
 * Fix sagenb.org so docstrings look right (Sphinx).  * Use Sphinx for sagenb.org docstrings
Line 13: Line 13:
 * ReST mode(s):
    1. replace tinymce by ReST editor?
      * You might be able to make TinyMCE *be* a ReST editor. See [[http://tinymce.moxiecode.com/examples/example_09.php#|this example]] of making TinyMCE into a BBCode editor.		      Depending on how much stress this puts on a server, we could use a less expensive hash function or hash only part of the incoming docstring. Better yet, pass the object's fully qualified name to `set_introspect_html()` and hash just that for introspection of read-only code.
Line 17: Line 15:
    2. %rest in cells, and get rest output.  * reST mode(s)
    1. replace tinymce by reST editor?
      * You might be able to make TinyMCE *be* a reST editor. See [[http://tinymce.moxiecode.com/examples/example_09.php#|this example]] of making TinyMCE into a BBCode editor.
      * reST's implicit closing tags may make this difficult.

    2. This is better: %rest in cells, and get reST output.

         Should this be HTML output from Sphinx? If so, perhaps we should put the Sphinx-ify code in its own module or a utility function. Note that it would be good to autohide and have doubleclick be show. Same with %html.
Line 20: Line 25:

 * Live introspection cells.

 * Introspection cross links.

 * Tear-out docstrings - [[http://trac.sagemath.org/sage_trac/ticket/6001 | #6001]].
Line 25: Line 36:
 * Fix the major bugs and issues with the current notebook that make it difficult to deploy (e.g., account management).  * Streamlined deployment - account management, fewer bugs, etc.
Line 27: Line 38:
 * Add a textcha question for notebook signup. How about [[http://recaptcha.net/ | reCAPTCHA]]?  * [[http://en.wikipedia.org/wiki/Captcha | Captcha]] for notebook sign-up - [[http://recaptcha.net/ | reCAPTCHA]]. This is *only* needed at registration.
Line 29: Line 40:
 * LDAP authentication. (tdumont)  * LDAP authentication. (tdumont) -- do this by refactoring auth code so that user/password is 100% separate from anything else in the notebook. Then LDAP or anything else is completely trivial.
Line 31: Line 42:
 * Guaranteed worksheet-server synchronization.  * Guaranteed worksheet-server synchronization:
      - at least have a timestamp on the server
      - TinyMCE never gets sent back somehow leading to corrupt worksheets.
      - maybe use the javascript ping function to push changes out.
Line 33: Line 47:
 * Reduce data loss possibilites. ([[http://sage.math.washington.edu/home/wstein/tmp/sageuse/dataloss.txt | dataloss.txt]])  * Reduce data loss possibilites. ([[http://sage.math.washington.edu/home/wstein/tmp/sageuse/dataloss.txt |dataloss.txt]]): easy backup of all critical data in a notebook server. Get via web interface as admin. Archives.
 
Line 41: Line 55:
 * User groups.

 * Security -- see http://www.gingerlime.com/20090901_securing_sage_notebook.pdf

 * Functions to delete `worksheets/USER/*/BLAH` where `BLAH` is cells, code, data, or snapshots? Does this affect the size of .sws files? Admin pane showing usage for various things, e.g., snapshots. Allow easy trimming of old snapshots, configuring how their kepts, etc.


 * Balancing server_pool:
{{{
I managed to do a little of this by exporting the directory that the
notebook is running in via NFS to the other machines and maintaining
the same permissions and file structure for everything else. However,
this raised another issue in that not all my machines are of
comparable power. How complicated would it be to add something that
allows you to balance how many processes go to each server? I'm
thinking something along the lines of distcc's host list.
}}}

 * Account approval: Possible solution -- just have an interface like Google groups where new users can be "moderated by default".
{{{
> We have a small server and would like provide SAGE (in form of the
> notebook) for the students. However, it maybe a bit
> "risky" (especially, we have no experts to manage it) to open it up to
> everyone. So we would like to have some kind of "account approval"
> procedure. Can that be done, if so how?
}}}
Line 42: Line 84:

 * See http://routes.groovie.org/ to handle URLS (which is basically all twist.py is doing a lot of).

 * Sage could (and should!) ship copies of the jsmath fonts, and explain clearly what to do to install them whenever they aren't already installed. The current system, which involves visiting the jsmath website in response to subtle hints is not very good.

 * Fix TinyMCE issues, as mentioned here: http://groups.google.com/group/sage-devel/browse_frm/thread/4cd1cc188470c723/c2477e1bdba68028?q=tinymce+bug+group:sage-devel#c2477e1bdba68028 and http://groups.google.com/group/sage-devel/msg/e2eb3f848a21faa3

 * Move preparsing to the worksheet (not server). This (1) solves implicit multiplication problem, and (2) fits well with the "notebook server computers the least possible" philosophy.

 * Trivial to set implicit multiplication option for the notebook. On a per worksheet basis with a user default. Same for typeset option.
Line 51: Line 103:
 * Whoosh full-text search (search in codenode archives for discussion).  * [[http://whoosh.ca/ | Whoosh]] full-text search ([[http://groups.google.com/group/codenode-devel/browse_thread/thread/d3ffefa3b09937b6/98bdf00f65441934?#98bdf00f65441934 | codenode-devel]]).
Line 55: Line 107:
 * Chat system for students/users.  Is there a Google gadget for this?  * Chat system for students/users - [[http://www.google.com/ig/directory?synd=open&q=chat | Google gadget]]?
Line 61: Line 113:
 * Embed interacts in other web pages.  * Embed cells, including interacts, in other web pages.
Line 63: Line 115:
 * There are things that I now don't like on the Sage notebook, like that if I click on a cell, the frame gets focused (that's ok), but the text moves by one pixel. I hate that. My javascript version doesn't do that, at least on firefox. In fact, it's just a CSS styles issue, so it's easy to fix -- but I wasn't sure if it's just on my firefox, or oeverywhere. (ONDREJ)  * Prevent text movement by a pixel on cell frame focus. (Ondrej)
Line 67: Line 119:
 * Notebook input bug [[http://trac.sagemath.org/sage_trac/ticket/6729 | #6729]].  * Notebook input bug - [[http://trac.sagemath.org/sage_trac/ticket/6729 | #6729]].
Line 69: Line 121:
 * Debugger in the notebook.  Python.  * Python debugger in the notebook.
Line 75: Line 127:
 * In-browser zoom-pan-annotate of Sage plots.  * Interactively zoom, pan, and annotate plots.
Line 77: Line 129:
 * What I mean is that the chance to access at the same time an history powered command line, and a powerful editor (with code completion, tabs, colors, etc.., which looks pretty standard - to not say minimal - in these modern times) looks pretty comfortable to me, but I'll be happy to listen to other comments. I've already heard talking about !BeSpin ( https://bespin.mozilla.com/ ) in this list, right? Can't we have something similar? :)  * Powerful editor with command-line history, syntax highlighting, context-sensitive completions, etc. - [[https://bespin.mozilla.com/ | BeSpin]].

 * Syntax highlighting for published worksheets - [[http://trac.sagemath.org/sage_trac/ticket/5653#comment:2 | pygmentize]].
Line 81: Line 135:
 * Publishing notebook pages to selected users or groups (to make this effective, groups of users probably needs to be implemented as well).  * Update some output cells ''after'' the new output arrives. For example, smoothly update Jmol via its JS interface.
Line 83: Line 137:
 * GUI plugins for inputing mathematics. See the thread http://article.gmane.org/gmane.comp.mathematics.sage.devel/27294/  * Publishing notebook pages to selected users or groups.
Line 85: Line 139:
 * SVG editing: http://code.google.com/p/svg-edit/  * [[http://groups.google.com/group/sage-devel/browse_thread/thread/da578e3918f08709/da54258f1783b874?#da54258f1783b874 | GUI plugins for math input]].

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/86429406fb3bba17/dd3163cb2a47fa38?#dd3163cb2a47fa38 | Vector graphics editing]] - [[http://code.google.com/p/svg-edit/ | SVG-edit]].

 * Account tokens:
{{{
A preliminary patch for this is available at
http://www.math.leidenuniv.nl/~wpalenst/sage/account_tokens.patch . It is a
patch against 4.1.1 with tickets 4552
('trac_4552-notebook_account_email.patch'), 6843, 6856 applied.

(TODO: add doctests, implement token-generation page to the interface added by
ticket 4135, allow enabling/disabling the token feature from that page too.)
}}}

 * The 'forgot password' feature (enabled by enabling the 'email' setting of the notebook) currently allows anyone to reset the password of anyone they know the email address of, since it currently directly resets the password and mails the new password to the email address associated with the account. It would probably be better to instead generate a second password for the account, that would only become permanent once it has been used once. Or, alternatively, to email a link with a secure token to a password-change-page.
Line 89: Line 159:
 * Implement a cross-browser web-application automated testing infrastructure based on webdriver http://code.google.com/p/webdriver/ for the notebook, focused on functionality, consistency, concurrency, and scalability. For example, execute 10 sessions of virtual calculus students in a loop.

 * http://testled.com/		  * Notebook testing infrastructure - automated, cross-browser and platform, focused on functionality, consistency, concurrency, and scalability - [[http://seleniumhq.org/ | Selenium]], [[http://testled.com/ | Testled]], [[http://code.google.com/p/webdriver/ | WebDriver]]. For example, execute 10 sessions of virtual calculus students in a loop.
Line 95: Line 163:
 * Windows server farm.  * Windows build farm.
Line 97: Line 165:
 * Sagelite - separate the current notebook from Sage and get it to run on Windows.  * Sagelite - separate the current notebook from Sage. Windows port.
Line 106: Line 174:

 * Upgrade Sage for 66-bit processors.

Sage Usability Improvements

This unofficial wish list is adapted from this repository. Please feel free to add or clarify ideas, link to trac tickets, make comments, reorganize items, point out useful links, etc.

Documentation

  • LaTeX doc mode.

  • Use $ instead of back ticks for math in reST - #6892.

  • Use Sphinx for sagenb.org docstrings

    • Depending on how much stress this puts on a server, we could use a less expensive hash function or hash only part of the incoming docstring. Better yet, pass the object's fully qualified name to set_introspect_html() and hash just that for introspection of read-only code.

  • reST mode(s)
    1. replace tinymce by reST editor?

      • You might be able to make TinyMCE *be* a reST editor. See this example of making TinyMCE into a BBCode editor.

      • reST's implicit closing tags may make this difficult.
    2. This is better: %rest in cells, and get reST output.
      • Should this be HTML output from Sphinx? If so, perhaps we should put the Sphinx-ify code in its own module or a utility function. Note that it would be good to autohide and have doubleclick be show. Same with %html.

  • Document pexpect interface for users.

  • Live introspection cells.
  • Introspection cross links.

  • Tear-out docstrings - #6001.

Notebook

Admin

  • Streamlined deployment - account management, fewer bugs, etc.

  • Captcha for notebook sign-up - reCAPTCHA. This is *only* needed at registration.

  • LDAP authentication. (tdumont) -- do this by refactoring auth code so that user/password is 100% separate from anything else in the notebook. Then LDAP or anything else is completely trivial.
  • Guaranteed worksheet-server synchronization:
    • - at least have a timestamp on the server - TinyMCE never gets sent back somehow leading to corrupt worksheets. - maybe use the javascript ping function to push changes out.

  • Reduce data loss possibilites. (dataloss.txt): easy backup of all critical data in a notebook server. Get via web interface as admin. Archives.

  • Recover passwords. (Byungchul Cha)
  • Email address as username.
  • Add users as admins. (fprimex)
  • User groups.

  • Security -- see http://www.gingerlime.com/20090901_securing_sage_notebook.pdf

  • Functions to delete worksheets/USER/*/BLAH where BLAH is cells, code, data, or snapshots? Does this affect the size of .sws files? Admin pane showing usage for various things, e.g., snapshots. Allow easy trimming of old snapshots, configuring how their kepts, etc.

  • Balancing server_pool: 

I managed to do a little of this by exporting the directory that the
notebook is running in via NFS to the other machines and maintaining
the same permissions and file structure for everything else.  However,
this raised another issue in that not all my machines are of
comparable power.  How complicated would it be to add something that
allows you to balance how many processes go to each server?  I'm
thinking something along the lines of distcc's host list.
  • Account approval: Possible solution -- just have an interface like Google groups where new users can be "moderated by default". 

> We have a small server and would like provide SAGE (in form of the
> notebook) for the students. However, it maybe a bit
> "risky" (especially, we have no experts to manage it) to open it up to
> everyone. So we would like to have some kind of "account approval"
> procedure. Can that be done, if so how?

Users

  • See http://routes.groovie.org/ to handle URLS (which is basically all twist.py is doing a lot of).

  • Sage could (and should!) ship copies of the jsmath fonts, and explain clearly what to do to install them whenever they aren't already installed. The current system, which involves visiting the jsmath website in response to subtle hints is not very good.

  • Fix TinyMCE issues, as mentioned here: http://groups.google.com/group/sage-devel/browse_frm/thread/4cd1cc188470c723/c2477e1bdba68028?q=tinymce+bug+group:sage-devel#c2477e1bdba68028 and http://groups.google.com/group/sage-devel/msg/e2eb3f848a21faa3

  • Move preparsing to the worksheet (not server). This (1) solves implicit multiplication problem, and (2) fits well with the "notebook server computers the least possible" philosophy.
  • Trivial to set implicit multiplication option for the notebook. On a per worksheet basis with a user default. Same for typeset option.
  • Reorganize the notebook help page.
  • Automatically have worksheets save their state and restore when started later.
  • Update the titlebar from the notebook.
  • Auto-updating interacts.

  • Whoosh full-text search (codenode-devel).

  • Keith Lang's Top 10 UI Myths.

  • Chat system for students/users - Google gadget?

  • Implement %timeit block in notebook.

  • Worksheet tags. (Brian Granger)

  • Embed cells, including interacts, in other web pages.
  • Prevent text movement by a pixel on cell frame focus. (Ondrej)
  • Completions link for iphone.

  • Notebook input bug - #6729.

  • Python debugger in the notebook.
  • Make it possible to delete published worksheets.
  • Slideshow mode.
  • Interactively zoom, pan, and annotate plots.

  • Powerful editor with command-line history, syntax highlighting, context-sensitive completions, etc. - BeSpin.

  • Syntax highlighting for published worksheets - pygmentize.

  • Fix MoinMoin.

  • Update some output cells after the new output arrives. For example, smoothly update Jmol via its JS interface.

  • Publishing notebook pages to selected users or groups.

  • GUI plugins for math input.

  • Vector graphics editing - SVG-edit.

  • Account tokens: 

A preliminary patch for this is available at
http://www.math.leidenuniv.nl/~wpalenst/sage/account_tokens.patch . It is a
patch against 4.1.1 with tickets 4552
('trac_4552-notebook_account_email.patch'), 6843, 6856 applied.

(TODO: add doctests, implement token-generation page to the interface added by
ticket 4135, allow enabling/disabling the token feature from that page too.)
  • The 'forgot password' feature (enabled by enabling the 'email' setting of the notebook) currently allows anyone to reset the password of anyone they know the email address of, since it currently directly resets the password and mails the new password to the email address associated with the account. It would probably be better to instead generate a second password for the account, that would only become permanent once it has been used once. Or, alternatively, to email a link with a secure token to a password-change-page.

Build / Test

  • Notebook testing infrastructure - automated, cross-browser and platform, focused on functionality, consistency, concurrency, and scalability - Selenium, Testled, WebDriver. For example, execute 10 sessions of virtual calculus students in a loop.

  • Make it so Sage binaries don't use SSE3, etc. -- make them FAT!
  • Windows build farm.
  • Sagelite - separate the current notebook from Sage. Windows port.
  • Windows port.

  • VirtualBox Sage.

  • andLinux Sage.
  • Improve documentation/testing and refactor code.
  • Upgrade Sage for 66-bit processors.