Differences between revisions 5 and 6
Revision 5 as of 2009-09-30 14:18:27
Size: 7644
Editor: qed777
Comment: Continued import + reorg.
Revision 6 as of 2009-09-30 14:55:24
Size: 8389
Editor: qed777
Comment: Continued reorg.
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:

############################## GENERAL ##############################
Line 21: Line 23:

############################## NOTEBOOK: ADMIN ##############################
Line 22: Line 26:

 * Authentication:
   * LDAP.
   * UNIX accounts.
Line 36: Line 44:
 * Authentication:
   * LDAP.
   * UNIX accounts.
Line 46: Line 50:

######################### NOTEBOOK: INTROSPECTION #########################
Line 50: Line 56:
 * Matrix `B` mentioned twice in `B.solve_left?`: `B.solve_left(B, ...)`.

 * Better error detection, e.g., for Maxima command completion.

 * Completions link for mobiles.
Line 54: Line 66:
 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e9d0fc2c75ec6354/2634152df8f85f59?#2634152df8f85f59 | New documentation browser]]. Send docstrings to this browser.

 * Better error detection, e.g., for Maxima command completion.

 * Matrix `B` mentioned twice in `B.solve_left?`: `B.solve_left(B, ...)`.

 * Completions link for mobiles.
Line 64: Line 68:
 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e9d0fc2c75ec6354/2634152df8f85f59?#2634152df8f85f59 | New documentation browser]]. Send worksheet docstrings to this browser.


############################## NOTEBOOK: "MODES" ##############################
Line 66: Line 74:
 * %timeit.
Line 70: Line 80:
 * reST editing.  * reST:
Line 72: Line 82:
   * `%rest` cells (auto-hide, double-click to show) sent to Sphinx on-the-fly.

 * %timeit.
   * `%rest` cells (auto-hide, double-click to show) converted to HTML by Sphinx.
Line 78: Line 86:
 * Math-enabled chat. [[http://qwebirc.org/ | qwebirc]] / [[http://webchat.freenode.net/ | Web IRC]].

 * Python debugger a la [[https://developer.mozilla.org/En/Pylons | Pylons]].

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/86429406fb3bba17/dd3163cb2a47fa38?#dd3163cb2a47fa38 | Vector graphics]] - [[http://trac.sagemath.org/sage_trac/ticket/6973 | #6973]].
   * Draw - [[http://code.google.com/p/svg-edit/ | SVG-edit]].
   * Annotate output from matplotlib's SVG backend.

 * Editor a la [[https://bespin.mozilla.com/ | BeSpin]]
   * Command-line history.
   * Syntax highlighting.
   * Context-sensitive completion.
Line 80: Line 101:
 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/86429406fb3bba17/dd3163cb2a47fa38?#dd3163cb2a47fa38 | Vector graphics editor]] - [[http://code.google.com/p/svg-edit/ | SVG-edit]].

######################### NOTEBOOK: USER INTERACTION #########################
Line 84: Line 105:
 * Automatic tips for keyboard shortcuts, editing features, etc. Opt out.

 * Friendly bug buddy that emails reports, bundles session history, etc.

 * Easy backups of own work, with or w/o data, output, snapshots, etc.

 * Toolbar with buttons to interrupt running code, save, get key help, etc.

 * Easily identify idle, queued, and running cells.
 * Help:
   * Reorganize help page.
   * Easy set up of shipped jsMath fonts.
   * Automatic tips for keyboard shortcuts, editing features, etc. Opt out.
   * Friendly bug buddy that emails reports, bundles session history, etc.
   * Parens matching - [[http://trac.sagemath.org/sage_trac/ticket/3646 | #3646]].

 * Customization:
   * Typeset output default.
   * Implicit multiplication default.
   * Custom window close callback.
   * Function to update worksheet titlebar.
   * Easy backups of own work, with or w/o data, output, snapshots, etc.
   * Download zip files of multiple worksheets, even if `accounts=True`.
Line 101: Line 127:
 * Interactive 2D/3D plots
   * [[http://groups.google.com/group/sage-support/browse_thread/thread/c29abdaaa4f0ee13 | coordinates]], zoom, pan, annotate
   * [[http://sourceforge.net/mailarchive/forum.php?thread_name=6e8d907b0909012053s19e7c5fl29cdcd0e1fab1d50%40mail.gmail.com&forum_name=matplotlib-devel | matplotlib]], canvas, SVG, [[http://code.google.com/p/flot/ | Flot]], [[http://teethgrinder.co.uk/open-flash-chart-2/ | Open Flash Chart]].

 * Animated 2D/3D plots using only !JavaScript.

 * Always show long output links, regardless of interrupt or length.

 * Custom window close callback.

 * Suppress browser warning for Konquereor.

 * Unique cookie for each login.

 * Cells: Select, delete, (un)group, move [[http://boagworld.com/demos/sitemap/ | multiple cells]].

 * Slideshow mode.
 * 2D / 3D plots:
   * !JavaScript animations.
   * Mouse-over for [[http://groups.google.com/group/sage-support/browse_thread/thread/c29abdaaa4f0ee13 | coordinates]] - [[http://sourceforge.net/mailarchive/forum.php?thread_name=6e8d907b0909012053s19e7c5fl29cdcd0e1fab1d50%40mail.gmail.com&forum_name=matplotlib-devel | matplotlib]].
   * Interactively zoom, pan, annotate - canvas, SVG, [[http://code.google.com/p/flot/ | Flot]], [[http://teethgrinder.co.uk/open-flash-chart-2/ | Open Flash Chart]].

 * Cells:
   * Slideshow mode.
   * Auto-updating cells, e.g., interacts.
   * Prevent text movement by a pixel on cell frame focus.
   * Always show links for long output cells, regardless of length or interruption.
   * Easily identify idle, queued, and running cells.
   * Toolbar with buttons to interrupt running code, save, attach files, etc.
   * Select, delete, (un)group, move [[http://boagworld.com/demos/sitemap/ | multiple cells]].
   * Leading space input bug - [[http://trac.sagemath.org/sage_trac/ticket/6729 | #6729]].
Line 125: Line 148:
 * jsMath fonts:
   * Ship with Sage.
   * Clear install directions.

 * TinyMCE [[http://groups.google.com/group/sage-devel/msg/e2eb3f848a21faa3 | synchronization]] [[http://groups.google.com/group/sage-devel/browse_frm/thread/4cd1cc188470c723/c2477e1bdba68028?q=tinymce+bug+group:sage-devel#c2477e1bdba68028 | problem]].

 * Default options:
   * Implicit multiplication.
   * Typeset output.

 * Reorganize help page.

 * Automatically save / restore worksheet state. Pause / resume.

 * Function to update worksheet titlebar.

 * Auto-update cells, e.g., interacts.

 * Full-text search: SQLalchemy, [[http://whoosh.ca/ | Whoosh]] ([[http://groups.google.com/group/codenode-devel/browse_thread/thread/d3ffefa3b09937b6/98bdf00f65441934?#98bdf00f65441934 | codenode-devel]]).

 * Math-enabled chat. [[http://qwebirc.org/ | qwebirc]] / [[http://webchat.freenode.net/ | Web IRC]].

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e46f0a59d5cf70dc | Tags]].
 * Notebook:
   * Suppress browser warning for Konquereor.
   * Unique cookies for logins from different browsers / computers.
   * Automatically save / restore worksheet state. Pause / resume.
   * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e46f0a59d5cf70dc | Tags]].
   * Full-text search: SQLalchemy, [[http://whoosh.ca/ | Whoosh]] ([[http://groups.google.com/group/codenode-devel/browse_thread/thread/d3ffefa3b09937b6/98bdf00f65441934?#98bdf00f65441934 | codenode-devel]]).

 * Worksheets:
   * Optional always visible menubar at top of worksheet.
   * TinyMCE [[http://groups.google.com/group/sage-devel/msg/e2eb3f848a21faa3 | synchronization]] [[http://groups.google.com/group/sage-devel/browse_frm/thread/4cd1cc188470c723/c2477e1bdba68028?q=tinymce+bug+group:sage-devel#c2477e1bdba68028 | problem]].

 * Fix MoinMoin.

 * Use notebook as IDE for running sage instance.
Line 151: Line 165:
 * Prevent text movement by a pixel on cell frame focus.

 * Leading space input bug - [[http://trac.sagemath.org/sage_trac/ticket/6729 | #6729]].

 * Python debugger a la [[https://developer.mozilla.org/En/Pylons | Pylons]].

 * Editor a la [[https://bespin.mozilla.com/ | BeSpin]]
   * Command-line history.
   * Syntax highlighting.
   * Context-sensitive completion.

 * Fix MoinMoin.

 * Use notebook as IDE for running sage instance.

 * Download zip files of multiple worksheets, even if `accounts=True`.

 * Parens matching - [[http://trac.sagemath.org/sage_trac/ticket/3646 | #3646]].

 * Optional always visible menubar at top of worksheet.

######################### NOTEBOOK: UNDER THE HOOD #########################
Line 183: Line 178:
   * TinyMCE problem
   * Server-to-server sync for backups, possibly with authentication.
   * TinyMCE problem.
   * Server-to-server for backups, possibly with authentication.
Line 192: Line 187:
 * Migrate to another server and/or framework: [[http://docs.djangoproject.com/en/dev/ | Django]], [[http://pylonshq.com/ | Pylons]], [[http://pyjs.org/ | Pyjamas]], [[http://www.tornadoweb.org/ | Tornado]], etc.

* [[http://routes.groovie.org/ | URL routes]].

== Build / Tests ==
 * Migrate to server / framework: [[http://docs.djangoproject.com/en/dev/ | Django]], [[http://pylonshq.com/ | Pylons]], [[http://pyjs.org/ | Pyjamas]], [[http://www.tornadoweb.org/ | Tornado]], etc.:
 
* [[http://routes.groovie.org/ | URL routes]].


############################## BUILD / TEST ##############################
== Build / Test ==

 * !VirtualBox Sage.

 * andLinux Sage.

 * Binary distibutions that don't use SSE3, etc.

 * Windows build farm.

 * Windows port.
Line 199: Line 205:

 * Binary distibutions that don't use SSE3, etc.

 * Windows port.

 * Windows build farm.

 * !VirtualBox Sage.

 * andLinux Sage.

Sage Usability Tasks

Source: Sage Usability Improvements List. TODO: Assign difficulties to individual tasks, if it's appropriate.

1. General

2. Documentation

3. Notebook: Admin

  • Authentication:
    • LDAP.
    • UNIX accounts.
  • Dashboard for server settings / status:
    • View logged-in users, load, processes, etc.
    • Backups: all critical data, selective.
    • Configure thresholds, alerts, snapshot behavior.
    • Manage user accounts, groups, privileges.
    • Restricted version for users.
  • Registration:
    • reCAPTCHA.

    • Challenge questions.
    • Admin approval.
    • Revokable custom tokens.
  • Users:
    • Groups.
    • Privileges.
    • Email address as username.
    • Use secure tokens to reset passwords.

4. Notebook: Introspection

  • Use Sphinx for sagenb.org docstrings.
  • Matrix B mentioned twice in B.solve_left?: B.solve_left(B, ...).

  • Better error detection, e.g., for Maxima command completion.
  • Completions link for mobiles.
  • Live introspection cells.
  • Introspection cross-links.
  • Improve introspection / completion interface: floating div, RHS div.
  • New documentation browser. Send worksheet docstrings to this browser.

5. Notebook: "Modes"

6. Notebook: User Interaction

  • Help:
    • Reorganize help page.
    • Easy set up of shipped jsMath fonts.
    • Automatic tips for keyboard shortcuts, editing features, etc. Opt out.
    • Friendly bug buddy that emails reports, bundles session history, etc.
    • Parens matching - #3646.

  • Customization:
    • Typeset output default.
    • Implicit multiplication default.
    • Custom window close callback.
    • Function to update worksheet titlebar.
    • Easy backups of own work, with or w/o data, output, snapshots, etc.
    • Download zip files of multiple worksheets, even if accounts=True.

  • Keys
    • Insert new cell after current cell shortcut.
    • Restart worksheet shortcut.
    • Custom shortcuts, e.g., ctrl-bksp to delete previous word, not join cells.
    • Use js-hotkeys.
    • Splash-screen with common keys.
  • 2D / 3D plots:
  • Cells:
    • Slideshow mode.
    • Auto-updating cells, e.g., interacts.
    • Prevent text movement by a pixel on cell frame focus.
    • Always show links for long output cells, regardless of length or interruption.
    • Easily identify idle, queued, and running cells.
    • Toolbar with buttons to interrupt running code, save, attach files, etc.
    • Select, delete, (un)group, move multiple cells.

    • Leading space input bug - #6729.

  • Published worksheets:
    • Delete them.
    • RSS feeds.
    • Live cells, e.g, interacts.
    • Only to selected users or groups.
  • Notebook:
    • Suppress browser warning for Konquereor.
    • Unique cookies for logins from different browsers / computers.
    • Automatically save / restore worksheet state. Pause / resume.
    • Tags.

    • Full-text search: SQLalchemy, Whoosh (codenode-devel).

  • Worksheets:
  • Fix MoinMoin.

  • Use notebook as IDE for running sage instance.
  • Externally embed live cells / worksheets. Live published workseets. #6855.

7. Notebook: Under the hood

  • Better handling of concurrent worksheet use.
  • Smartly manage Jmol applet count, or memory use.
  • Component architecture.

  • Cythonize pexpect.
  • Client-server synchronization:
    • TinyMCE problem.
    • Server-to-server for backups, possibly with authentication.
  • Track worksheets and user data with Mercurial.
  • Balance server pool loads.
  • Load JS / CSS components on demand.
  • Migrate to server / framework: Django, Pylons, Pyjamas, Tornado, etc.:

8. Build / Test