Differences between revisions 1 and 9 (spanning 8 versions)
Revision 1 as of 2009-09-28 20:20:57
Size: 353
Editor: qed777
Comment: New page.
Revision 9 as of 2009-09-30 16:39:59
Size: 8969
Editor: TimDumol
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
Source: [[SageUsability | Sage Usability Improvements List]]. This is an attempt to organize the desired changes into tasks of varying difficulty (e.g., easy, medium, hard). Source: [[SageUsability | Sage Usability Improvements List]]. TODO: Assign difficulties to individual tasks, if it's appropriate, or just order or group by difficulty.


############################## GENERAL ##############################
== General ==

 * Y. Aner's [[http://www.gingerlime.com/20090901_securing_sage_notebook.pdf | notebook threat model (PDF)]].

 * [[http://carsonified.com/blog/design/top-10-ux-myths/ | Keith Lang's Top 10 UI Myths]].

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/258c07ae672a3617 | Sage Forge]].
Line 7: Line 17:
 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/8fa0d854b6928f2b/dc4cfe0a941762aa#dc4cfe0a941762aa | Allow $ for reST math]] - [[http://trac.sagemath.org/sage_trac/ticket/6892 | #6892]].

 * Document:
   * [[http://groups.google.com/group/sage-devel/msg/35e97a1d1cedfdfd | pexpect interface for users]].
   * [[http://groups.google.com/group/sage-devel/browse_thread/thread/6d94c8655e41ba24# | notebook port forwarding]].

== Development ==

 * More convenient development workflow
   * Current workflow is:
     1. Change file
     2. Restart Sage Notebook
     3. Wash, rinse, repeat
   * Possible improvements:
     * Autoreload and autobuild mechanism (dev mode)

############################## NOTEBOOK: ADMIN ##############################
Line 10: Line 36:
 * 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:
   * [[http://recaptcha.net/ | reCAPTCHA]].
   * Challenge questions.
   * Admin approval.
   * Revokable custom tokens.

 * Users:
   * Groups.
   * Privileges.
   * Email address as username.
   * Use secure tokens to reset passwords.


######################### NOTEBOOK: INTROSPECTION #########################
== 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.

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


############################## NOTEBOOK: "MODES" ##############################
== Notebook: "Modes" ==

 * %timeit.

 * Graph editor - [[http://trac.sagemath.org/sage_trac/ticket/1321 | #1321]].

 * [[http://groups.google.com/group/sage-devel/msg/e86932eeadd88c6a | LaTeX doc mode]].

 * reST:
   * [[http://tinymce.moxiecode.com/examples/example_09.php# | TinyMCE-style editor]].
   * `%rest` cells (auto-hide, double-click to show) converted to HTML by Sphinx.

 * Preparse in the browser: implicit multiplication, less work for server.

 * Chat, plus math. [[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.

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

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/da578e3918f08709/da54258f1783b874?#da54258f1783b874 | Math input GUI plug-ins]].


######################### NOTEBOOK: USER INTERACTION #########################
Line 13: Line 114:
 * Help:
   * Reorganize help page.
        * Search for commands
        * linking to similar and related commands
   * 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.

 * Customization:
   * Typeset output default setting.
   * Implicit multiplication default setting.
   * 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
   * Restart worksheet shortcut.
   * Splash-screen with common keys.
   * Insert new cell after current cell shortcut.
   * Custom shortcuts, e.g., ctrl-bksp to delete previous word, not join cells - [[http://code.google.com/p/js-hotkeys/ | js-hotkeys]].

 * Cells:
   * 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.
   * 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]].

 * 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]].

 * Worksheets:
   * Slideshow mode.
   * Use notebook as IDE for running sage instance.
   * Always visible menubar at top of worksheet.
   * Toolbar with buttons to interrupt running code, save, attach files, etc.
   * Parens matching - [[http://trac.sagemath.org/sage_trac/ticket/3646 | #3646]].
   * 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]].

 * Published worksheets:
   * Delete them.
   * RSS feeds.
   * Live cells, e.g, interacts.
   * Only to selected users or groups.

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

 * Fix !MoinMoin.

 * Externally embed live cells / worksheets. Live published workseets. [[http://trac.sagemath.org/sage_trac/ticket/6855 | #6855]].


######################### NOTEBOOK: UNDER THE HOOD #########################
Line 16: Line 177:

== Build / Tests ==
 * Better handling of concurrent worksheet use.

 * Smartly manage Jmol applet count, or memory use.

 * [[http://bitbucket.org/brickenstein/rumcomponent/src/tip/rumcomponent/ | 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: [[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]].

######################## NOTEBOOK: DEVELOPMENT ###########################

== Notebook: Development ==

 * Auto-reloading (similar to `paster serve --reload` or CherryPy's AutoReload mechanism)


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

 * !VirtualBox Sage.

 * andLinux Sage.

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

 * Sagelite for Windows.

 * Windows build farm.

 * Windows port.

 * Notebook testing infrastructure: [[http://seleniumhq.org/ | Selenium]], [[http://testled.com/ | Testled]], [[http://code.google.com/p/webdriver/ | Webdriver]], [[http://pylonshq.com/docs/en/0.9.7/testing/ | WebTest]], [[http://www.getwindmill.com/ | Windmill]].

Sage Usability Tasks

Source: Sage Usability Improvements List. TODO: Assign difficulties to individual tasks, if it's appropriate, or just order or group by difficulty.

1. General

2. Documentation

3. Development

  • More convenient development workflow
    • Current workflow is:
      1. Change file
      2. Restart Sage Notebook
      3. Wash, rinse, repeat
    • Possible improvements:
      • Autoreload and autobuild mechanism (dev mode)

4. 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.

5. 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.

6. Notebook: "Modes"

7. Notebook: User Interaction

  • Help:
    • Reorganize help page.
      • Search for commands
      • linking to similar and related commands
    • 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.
  • Customization:
    • Typeset output default setting.
    • Implicit multiplication default setting.
    • 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
    • Restart worksheet shortcut.
    • Splash-screen with common keys.
    • Insert new cell after current cell shortcut.
    • Custom shortcuts, e.g., ctrl-bksp to delete previous word, not join cells - js-hotkeys.

  • Cells:
    • 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.
    • Select, delete, (un)group, move multiple cells.

    • Leading space input bug - #6729.

  • 2D / 3D plots:
  • Worksheets:
    • Slideshow mode.
    • Use notebook as IDE for running sage instance.
    • Always visible menubar at top of worksheet.
    • Toolbar with buttons to interrupt running code, save, attach files, etc.
    • Parens matching - #3646.

    • TinyMCE synchronization problem.

  • Published worksheets:
    • Delete them.
    • RSS feeds.
    • Live cells, e.g, interacts.
    • Only to selected users or groups.
  • Notebook:
    • Tags.

    • Suppress browser warning for Konquereor.
    • Unique cookies for logins from different browsers / computers.
    • Full-text search: SQLalchemy, Whoosh (codenode-devel).

  • Fix MoinMoin.

  • Externally embed live cells / worksheets. Live published workseets. #6855.

8. 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.:

9. Notebook: Development

10. Build / Test

  • VirtualBox Sage.

  • andLinux Sage.
  • Binary distibutions that don't use SSE3, etc.
  • Sagelite for Windows.
  • Windows build farm.
  • Windows port.
  • Notebook testing infrastructure: Selenium, Testled, Webdriver, WebTest, Windmill.