Differences between revisions 2 and 5 (spanning 3 versions)
⇤ ← Revision 2 as of 2009-09-30 13:05:57 →
Size: 3808
Editor: qed777
Comment: First import from SageUsability.
← Revision 5 as of 2009-09-30 14:18:27 → ⇥
Size: 7644
Editor: qed777
Comment: Continued import + reorg.
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).

== General Must-Read ==		 Source: [[SageUsability | Sage Usability Improvements List]]. TODO: Assign difficulties to individual tasks, if it's appropriate.

== General ==
Line 9: Line 9:
 * [[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 13: Line 17:
 * [[http://groups.google.com/group/sage-devel/msg/35e97a1d1cedfdfd | Document pexpect interface]].

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/6d94c8655e41ba24# | Document notebook port forwarding]].		  * 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]].
Line 19: Line 23:
 * Dashboard for server settings / status.  * Dashboard for server settings / status:
Line 21: Line 25:
   * Backup all critical data.    * Backups: all critical data, selective.
Line 26: Line 30:
 * Selective registration with [[http://recaptcha.net/ | reCAPTCHA]], challenge questions, admin approval, and/or revokable custom codes.

 * Custom authentication: LDAP, UNIX accounts, etc.

 * Recovery passwords.

 * Email address as username.

 * User groups.

 * Privileged users, e.g, admins.		  * Registration:
   * [[http://recaptcha.net/ | reCAPTCHA]].
   * Challenge questions.
   * Admin approval.
   * Revokable custom tokens.

 * Authentication:
   * LDAP.
   * UNIX accounts.

 * Users:
   * Groups.
   * Privileges.
   * Email address as username.
   * Use secure tokens to reset passwords.
Line 52: Line 60:
== Notebook: Special modes ==  * Completions link for mobiles.

 * Improve introspection / completion interface: floating div, RHS div.

== Notebook: "Modes" ==
Line 62: Line 74:
 * %timeit.

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

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

 * [[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]].
Line 74: Line 94:
 * Keys: intuitive, splash-screen.  * 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.
Line 90: Line 115:
 * Cells: Select, delete, (un)group, move [[http://boagworld.com/demos/sitemap/ | multiple cells]].

 * Slideshow mode.

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

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

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

 * 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.
Line 92: Line 174:
 * Better handling of concurrent worksheet use.
Line 98: Line 182:
 * Client-server synchronization: TinyMCE problem, fail-over servers.  * Client-server synchronization:
   * TinyMCE problem
   * Server-to-server sync for backups, possibly with authentication.

 * Track worksheets and user data with Mercurial.
Line 104: Line 192:
 *
  * 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]].
Line 108: Line 197:

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

 * 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

  • 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.
  • Authentication:
    • LDAP.
    • UNIX accounts.
  • Users:
    • Groups.
    • Privileges.
    • Email address as username.
    • Use secure tokens to reset passwords.

4. Notebook: Introspection

  • Use Sphinx for sagenb.org docstrings.
  • Live introspection cells.
  • Introspection cross-links.

  • 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.
  • Improve introspection / completion interface: floating div, RHS div.

5. Notebook: "Modes"

6. Notebook: User Interaction

  • 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.
  • 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.
  • Interactive 2D/3D plots

  • 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 multiple cells.

  • Slideshow mode.
  • Published worksheets:
    • Delete them.
    • RSS feeds.
    • Live cells, e.g, interacts.
    • Only to selected users or groups.
  • jsMath fonts:
    • Ship with Sage.
    • Clear install directions.

  • TinyMCE synchronization 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, Whoosh (codenode-devel).

  • Math-enabled chat. qwebirc / Web IRC.

  • Tags.

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

  • Prevent text movement by a pixel on cell frame focus.

  • Leading space input bug - #6729.

  • Python debugger a la Pylons.

  • Editor a la 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 - #3646.

  • Optional always visible menubar at top of worksheet.

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 sync for backups, possibly with authentication.
  • Track worksheets and user data with Mercurial.
  • Balance server pool loads.
  • Load JS / CSS components on demand.

  • Migrate to another server and/or framework: Django, Pylons, Pyjamas, Tornado, etc.

  • URL routes.

8. Build / Tests