Differences between revisions 36 and 54 (spanning 18 versions)
⇤ ← Revision 36 as of 2009-11-27 14:52:02 →
Size: 14142
Editor: qed777
Comment: Succinctness plea.
← Revision 54 as of 2022-04-05 05:44:27 → ⇥
Size: 0
Editor: mkoeppe
Comment: outdated
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= Sage Tasks Outline =

This is a general outline of targeted areas, including specific tasks, for improving the usability of [[http://www.sagemath.org/ | Sage]]. The sources include the [[SageUsability | Sage Usability Improvements List]] and [[http://sage.math.washington.edu:8100/file/tip/sagenb/todo.txt | sagenb/todo.txt]], but the scope here is wider. Feel free to make changes. To keep items succinct, please make links to group discussions, etc.


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

 * [[http://www.sagenb.org | Sagenb.org]] privacy policy.

 * 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 | SageForge]] - semi-automated repository for contributions to Sage:
   * Scripts, worksheets, databases, and packages of [nearly] all sizes.
   * Supplementary documentation, including multimedia.
   * Optional reviews and ratings.
   * Live, ulimited cellular paste-bin.
   * RSS feeds.


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

 * Tests:
   * Increase coverage to 100%.
   * Fix all sagenb doctests and run them from Sage library.
   * Meaningful statistics / benchmarks, e.g., %timeit for individual doctests.

 * Build logs:
   * Separate file for each spkg for parallel builds.
   * Group by install, upgrade, or spkg install event.
   * Remotely aggregate and display refreshed statistics.

 * Porting:
   * andLinux Sage.
   * Windows.
   * Windows build farm.
   * Sagelite for Windows.
   * Binary distributions that don't use SSE3, etc.

 * Notebook load tests - [[http://grinder.sourceforge.net/ | The Grinder]], [[http://funkload.nuxeo.org/ | FunkLoad]], [[http://www.pylot.org/ | Pylot]], [[http://watir.com/ | Watir]], [[http://pypi.python.org/pypi/zope.testbrowser | Zope.testbrowser]].


############################## DEVELOPMENT ##############################
== Development ==

 * Auto-reload / auto-build changed files - [[http://www.sagemath.org/doc/reference/sage/misc/attach.html | attach]], [[http://pythonpaste.org/script/ | paster serve --reload]], !CherryPy's [[http://www.cherrypy.org/wiki/AutoReload | AutoReload]].

 * [[http://groups.google.com/group/sage-devel/msg/fb95603488afd9de | More convenient development workflow]]:
   * Code review tools - [[http://code.google.com/p/rietveld/ | Rietveld]].
   * Automated, continuous builds and testing for new patches.

 * [[http://www.doughellmann.com/articles/CompletelyDifferent-2008-03-linters/index.html | Static Python code analysis]].


############################## DOCUMENTATION ##############################
== Documentation ==

 * Document:

   * Add many more modules to the reference manual.
   * [[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]].
   * [[SageNotebook | Notebook server technical overview]].
   * [[http://groups.google.com/group/sage-support/browse_thread/thread/b0d15b82eea3d652 | Run notebook server as daemon]].

############################## NOTEBOOK: ADMIN ##############################
== Notebook: Admin ==

 * Don't list '''all''' users' worksheets.

 * Authentication - abstract interface:
   * LDAP.
   * UNIX accounts.

 * Dashboard:
   * Real-time and cumulative statistics, aggregate and per user.
   * Backups: complete or selective.
   * Manage user accounts, passwords, groups, privileges.
   * Send email to all registered users.
   * Install new / updated modules and spkgs.

 * '''Lots''' of options with sensible defaults:
   * Email address as username.
   * Secure tokens to reset passwords.
   * Moderated new account registration.
   * Custom analytics tags, geolocation ([[http://www.clustrmaps.com/ | ClustrMaps]]).


######################### NOTEBOOK: INTROSPECTION #########################
== Notebook: Introspection ==

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

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

 * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e854336b08d436c6/fb8a62d01475e3eb?#fb8a62d01475e3eb | 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]]. Open worksheet docstrings to this browser.


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

 * %timeit.

 * %cython mode, full and outside `sage`.

 * Slideshow mode - [[http://trac.sagemath.org/sage_trac/ticket/6342 | #6342]].

 * interacts:
   * Auto updates.
   * Live published or remote - [[http://trac.sagemath.org/sage_trac/ticket/6855 | #6855]].
   * Control over widget layout - [[http://trac.sagemath.org/sage_trac/ticket/7379 | #7379]].
   * Examples to include with Sage.
   * [[http://groups.google.com/group/sage-devel/browse_thread/thread/8aa6a3a84365f06d/42c7edf1c23ca169?#42c7edf1c23ca169 | Free-form workspace with pipelines]].
   * Display nicely formatted docstrings (or captions).
   * [[http://groups.google.com/group/sage-devel/msg/d32ad8e2663bd7d1 | Simplify extension]], via HTML templates or an API.
   * More widgets: [[http://trac.sagemath.org/sage_trac/ticket/7427 | circular slider ("angle" wheel)]], [[http://trac.sagemath.org/sage_trac/ticket/5305 | date picker ]], [[http://trac.sagemath.org/sage_trac/ticket/7267 | compact color picker]], vertical sliders, spreadsheets, interactive plots, etc.
   * [[http://github.com/clemesha/jquery-interact | New architecture]].

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

 * reST - [[http://markitup.jaysalvat.com/home/ | markItUp]] with server-side Sphinx.

 * Chat - [[http://qwebirc.org/ | qwebirc]], [[http://webchat.freenode.net/ | Web IRC]].

 * Debugging:
   * Prettier tracebacks for %modes.
   * Python debugger a la [[https://developer.mozilla.org/En/Pylons | Pylons]] - [[http://trac.sagemath.org/sage_trac/ticket/7509 | #7509]].

 * [[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 - [[https://bespin.mozilla.com/ | BeSpin]], [[http://marijn.haverbeke.nl/codemirror/ | CodeMirror]] ([[http://trac.sagemath.org/sage_trac/ticket/7501 | #7501]]).

 * Browse worksheet directories like a file system.

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


######################### NOTEBOOK: UNDER THE HOOD #########################
== Notebook: Under the hood ==

 * Implement `base_url`.

 * Deprecation message at top of '''old''' notebook `.py` files.

 * Move `is_valid_username`, etc., out of `twist.py`. A validation module for all types of notebook form fields.

 * `notebook()`:
   * Allow default systems besides 'sage'.
   * Allow a different sage command on a remote machine.

 * Manage Jmol applet count / memory use - [[http://groups.google.com/group/sage-notebook/browse_thread/thread/0fd98c858e7d24c5/2ef2c296f1b13c3b?#2ef2c296f1b13c3b | sage-notebook]].

 * Use Python's [[http://docs.python.org/library/logging.html | logging facility]].

 * [[http://bitbucket.org/brickenstein/rumcomponent/src/tip/rumcomponent/ | Component architecture]].

 * Cythonize pexpect.

 * Processes:
   * Balance server pool loads.
   * Run the worksheet process as another user.
   * Reference implementation:
     * Make ctrl-c quit.
     * Don't put "data" link in all output cells.
   * Don't blocking the server: making docbrowsers, etc.
   * Remote worksheet processes.
   * Use fork (cf. [[http://trac.sagemath.org/sage_trac/ticket/6967 | #6967]]), named pipes, and/or [[http://docs.python.org/library/mmap.html | memory-mapped]] files for worksheet processes.

 * Client-server and server-server interaction:
   * Load JS / CSS components on demand - [[http://ajile.net/ | Ajile]].
   * Server-to-server backups, possibly with authentication.

 * Decouple secure transport from sage/dsage. Use OpenSSL.

 * Remote access Python API - [[http://code.google.com/apis/documents/overview.html | Google Documents List Data API]].
   * (Non-)authenticated modes.
   * Manipulate, share, up/download, publish worksheets at a given Sage(Forge) server.

 * Storage:
   * Fix `worksheet.autosave()`.
   * Always retrieve worksheet content from disk on open.
   * Use a revision control tool (e.g., Mercurial) for undo, history, snapshots, etc.
   * File size limit - auto-delete and warn above threshold.
   * Access a user's data directory '''securely''' via the new storage API.
   * Handle permissions better for directories, history, output, conf files, etc.

 * 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.:
   * Switch from twisted.web2 to [[http://jcalderone.livejournal.com/tag/sixty+seconds | twisted.web]].
   * [[http://routes.groovie.org/ | URL routes]].


######################### NOTEBOOK: USER INTERACTION #########################
== 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:
   * Defaults: typeset, implicit multiplication, 3D viewer, rename "Untitled" worksheets.
   * Custom window close callback.
   * Function to update worksheet titlebar.
   * Easy backups, selective or complete.
   * 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.
   * [[http://deanm.github.com/pre3d/ | Pre3d]]-[[http://groups.google.com/group/sage-devel/browse_thread/thread/0315e138d5783377/742d9f9bb00b0cd7?#742d9f9bb00b0cd7 | enabled `canvas3d` viewer]].
   * 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:
   * Export screen with checkboxes for images, data, etc.
   * Use notebook as IDE for running sage instance.
   * Optional always visible menubar at top of worksheet.
   * Make "Browse your computer" upload fields editable.
   * Fix "undefined" bug on first save in Safari 4.0.3.
   * Don't list "Sage Users" when sharing.
   * Rate worksheet title shows false error.
   * Page through worksheet list, not all at once - [[http://tablesorter.com/ | tablesorter]].
   * "Save as" option, e.g., for downloading, that prompts for a name.
   * Toolbar with buttons to interrupt running code, save, attach files, etc.
   * Real-time concurrent editing - [[http://trac.sagemath.org/sage_trac/ticket/7362 | #7362]].
   * 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 - [[http://trac.sagemath.org/sage_trac/ticket/6855 | #6855]].
   * Only to selected users or groups.

 * Notebook:
   * [[http://groups.google.com/group/sage-devel/browse_thread/thread/e46f0a59d5cf70dc | Tags]].
   * Suppress browser warning for Konqueror.
   * Manage logins:
     * View recent account activity. Add last login to `user.py`.
     * Invalidate other sessions' cookies.
     * 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.

 * External:
   * Embed live cells / worksheets - [[http://trac.sagemath.org/sage_trac/ticket/6855 | #6855]].
   * [[http://wave.google.com/ | Wave]] [[http://code.google.com/apis/wave/guide.html | gadgets and robots]].
   * Live published worksheets.