Differences between revisions 6 and 14 (spanning 8 versions)
Revision 6 as of 2009-09-30 14:55:24
Size: 8389
Editor: qed777
Comment: Continued reorg.
Revision 14 as of 2009-09-30 18:57:37
Size: 9433
Editor: qed777
Comment: Link to R. Bradshaw's rietveld message, instead.
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
Source: [[SageUsability | Sage Usability Improvements List]].  TODO: Assign difficulties to individual tasks, if it's appropriate. Source: [[SageUsability | Sage Usability Improvements List]].

TODO:
 * Merge [[http://sage.math.washington.edu:8100/file/tip/sagenb/todo.txt | sagenb/todo.txt]].
 *
Assign difficulties to individual tasks, if it's appropriate, or just order or group by difficulty.
Line 23: Line 27:
== Development ==

 * [[http://groups.google.com/group/sage-devel/msg/fb95603488afd9de | 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)
Line 86: Line 99:
 * Math-enabled chat. [[http://qwebirc.org/ | qwebirc]] / [[http://webchat.freenode.net/ | Web IRC]].  * Chat - [[http://qwebirc.org/ | qwebirc]], [[http://webchat.freenode.net/ | Web IRC]].
   * Rich content, e.g., equations.
   * Sage compute bot.
   * Add to help page.
Line 94: Line 110:
 * Editor a la [[https://bespin.mozilla.com/ | BeSpin]]  * Code editor a la [[https://bespin.mozilla.com/ | BeSpin]]
Line 107: Line 123:
        * Search for commands
        * linking to similar and related commands
Line 110: Line 128:
   * Parens matching - [[http://trac.sagemath.org/sage_trac/ticket/3646 | #3646]].
Line 113: Line 130:
   * Typeset output default.
   * Implicit multiplication default.
   * Typeset output default setting.
   * Implicit multiplication default setting.
Line 121: Line 138:
   * Restart worksheet shortcut.
   * Splash-screen with common keys.
Line 122: Line 141:
   * Restart worksheet shortcut.
   * Custom shortcuts, e.g., ctrl-bksp to delete previous word, not join cells.
   * Use js-hotkeys.
   * Splash-screen with common keys.
   * 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]].
Line 132: Line 156:
 * Cells:  * Worksheets:
Line 134: Line 158:
   * 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.
   * Use notebook as IDE for running sage instance.
   * Always visible menubar at top of worksheet.
Line 139: Line 161:
   * 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]].
   * 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]].
Line 149: Line 171:
   * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e46f0a59d5cf70dc | Tags]].
Line 151: Line 174:
   * Automatically save / restore worksheet state. Pause / resume.
   * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e46f0a59d5cf70dc | Tags]].
Line 155: Line 176:
 * 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.
 * Fix !MoinMoin.
Line 172: Line 187:

 * Use Python's [[http://docs.python.org/library/logging.html | logging facility]].
Line 190: Line 207:
######################## NOTEBOOK: DEVELOPMENT ###########################

== Notebook: Development ==

 * Auto-reload selected files, e.g., modules, config (similar to `paster serve --reload` or !CherryPy's [[http://www.cherrypy.org/wiki/AutoReload | AutoReload]]).
Line 200: Line 223:
 * Sagelite for Windows.
Line 204: Line 229:
 * 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]].  * Notebook testing infrastructure: [[http://wwwsearch.sourceforge.net/mechanize/ | mechanize]], [[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:

  • Merge sagenb/todo.txt.

  • 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.
  • Use Python's logging facility.

  • 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

  • Auto-reload selected files, e.g., modules, config (similar to paster serve --reload or CherryPy's AutoReload).

10. Build / Test