14178
Comment: the outline of tasks belongs to Sage development, so put this page under devel/
|
13874
Several updates.
|
Deletions are marked like this. | Additions are marked like this. |
Line 4: | Line 4: |
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. | 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 [[devel/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. |
Line 29: | Line 29: |
* Fix all sagenb doctests and run them from Sage library. | |
Line 32: | Line 31: |
* Build logs: * Separate file for each spkg for parallel builds. * Group by install, upgrade, or spkg install event. * Remotely aggregate and display refreshed statistics. |
* [[http://buildbot.net/ | Buildbot]]: * Group logs by install, upgrade, or spkg install event. |
Line 42: | Line 39: |
* 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]]. |
* Fat binaries (no SSE3, etc.). * Notebook functional tests - Extend Selenium tests to other browsers. * 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]] ([[http://trac.sagemath.org/sage_trac/ticket/7468 | now in SageNB]]). |
Line 50: | Line 49: |
* 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]]. | * Auto-reload changed modules - [[http://pythonpaste.org/script/ | paster serve --reload]], !CherryPy's [[http://www.cherrypy.org/wiki/AutoReload | AutoReload]]. |
Line 56: | Line 55: |
* [[http://www.doughellmann.com/articles/CompletelyDifferent-2008-03-linters/index.html | Static Python code analysis]]. | * [[http://www.doughellmann.com/articles/CompletelyDifferent-2008-03-linters/index.html | Static Python code analysis]], [[http://pypi.python.org/pypi/pep8/ | pep8]]. |
Line 67: | Line 66: |
* [[SageNotebook | Notebook server technical overview]]. | * [[devel/SageNotebook | Notebook server technical overview]]. |
Line 127: | Line 126: |
* [[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://groups.google.com/group/sage-devel/msg/d32ad8e2663bd7d1 | Simplify extension]], possibly with templates. * More widgets: [[http://trac.sagemath.org/sage_trac/ticket/7427 | circular slider ("angle" wheel)]], [[http://trac.sagemath.org/sage_trac/ticket/5305 | date picker ]], vertical sliders, spreadsheets, interactive plots, etc. |
Line 156: | Line 155: |
* Deprecation message at top of '''old''' notebook `.py` files. |
|
Line 179: | Line 176: |
* Don't blocking the server: making docbrowsers, etc. | * Don't block the server: making docbrowsers, etc. |
Line 213: | Line 210: |
* Easy set up of shipped jsMath fonts. | * Easy set up of shipped jsMath fonts - [[http://www.mathjax.org/ | MathJax]]. |
Line 228: | Line 225: |
* Custom shortcuts, e.g., ctrl-bksp to delete previous word, not join cells - [[http://code.google.com/p/js-hotkeys/ | js-hotkeys]]. | * Custom shortcuts, e.g., ctrl-bksp to delete previous word, not join cells - [[http://trac.sagemath.org/sage_trac/ticket/7618 | #7618]]. |
Line 232: | Line 229: |
* Prevent text movement by a pixel on cell frame focus. | * Unify server and client-side resize algorithms. |
Line 246: | Line 243: |
* Use notebook as IDE for running sage instance. | * Use notebook as IDE for running sage instance - [[http://trac.sagemath.org/sage_trac/ticket/7501 | #7501]]. |
Line 248: | Line 245: |
* Make "Browse your computer" upload fields editable. | * [[http://hacks.mozilla.org/2009/12/file-drag-and-drop-in-firefox-3-6/ | Drag-and-drop file upload]]. |
Line 256: | Line 253: |
* 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]]. |
Sage Tasks Outline
This is a general outline of targeted areas, including specific tasks, for improving the usability of Sage. The sources include the Sage Usability Improvements List and 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.
1. General
Sagenb.org privacy policy.
Y. Aner's notebook threat model (PDF).
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.
2. Build / Test
- Tests:
- Increase coverage to 100%.
- Meaningful statistics / benchmarks, e.g., %timeit for individual doctests.
- Group logs by install, upgrade, or spkg install event.
- Porting:
- andLinux Sage.
- Windows.
- Windows build farm.
- Sagelite for Windows.
- Fat binaries (no SSE3, etc.).
- Notebook functional tests - Extend Selenium tests to other browsers.
Notebook load tests - The Grinder, FunkLoad, Pylot, Watir, Zope.testbrowser (now in SageNB).
3. Development
Auto-reload changed modules - paster serve --reload, CherryPy's AutoReload.
More convenient development workflow:
Code review tools - Rietveld.
- Automated, continuous builds and testing for new patches.
4. Documentation
- Document:
- Add many more modules to the reference manual.
5. 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 (ClustrMaps).
6. Notebook: Introspection
Matrix B mentioned twice in B.solve_left?: B.solve_left(B, ...).
- Better error detection, e.g., for Maxima command completion.
- Live introspection cells.
- Introspection cross-links.
- Improve introspection / completion interface: floating div, RHS div.
New documentation browser. Open worksheet docstrings to this browser.
7. Notebook: "Modes"
- %timeit.
%cython mode, full and outside sage.
Slideshow mode - #6342.
- interacts:
- Auto updates.
Live published or remote - #6855.
Control over widget layout - #7379.
- Examples to include with Sage.
- Display nicely formatted docstrings (or captions).
Simplify extension, possibly with templates.
More widgets: circular slider ("angle" wheel), date picker, vertical sliders, spreadsheets, interactive plots, etc.
reST - markItUp with server-side Sphinx.
- Debugging:
Draw - SVG-edit.
- Annotate output from matplotlib's SVG backend.
Code editor - BeSpin, CodeMirror (#7501).
- Browse worksheet directories like a file system.
8. Notebook: Under the hood
Implement base_url.
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 - sage-notebook.
Use Python's logging facility.
- 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 block the server: making docbrowsers, etc.
- Remote worksheet processes.
Use fork (cf. #6967), named pipes, and/or memory-mapped files for worksheet processes.
- Client-server and server-server interaction:
Load JS / CSS components on demand - Ajile.
- Server-to-server backups, possibly with authentication.
- Decouple secure transport from sage/dsage. Use OpenSSL.
Remote access Python API - 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: Django, Pylons, Pyjamas, Tornado, etc.:
Switch from twisted.web2 to twisted.web.
9. Notebook: User Interaction
- Help:
- Reorganize help page:
- Search for commands.
- Linking to similar and related commands.
Easy set up of shipped jsMath fonts - MathJax.
- Automatic tips for keyboard shortcuts, editing features, etc. Opt out.
- Friendly bug buddy that emails reports, bundles session history, etc.
- Reorganize help page:
- 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 - #7618.
- Cells:
- Auto-updating cells, e.g., interacts.
- Unify server and client-side resize algorithms.
- 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:
JavaScript animations.
Mouse-over for coordinates - matplotlib.
Interactively zoom, pan, annotate - canvas, SVG, Flot, Open Flash Chart.
- Worksheets:
- Export screen with checkboxes for images, data, etc.
Use notebook as IDE for running sage instance - #7501.
- Optional always visible menubar at top of worksheet.
- 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 - 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 - #7362.
- Published worksheets:
- Delete them.
- RSS feeds.
Live cells, e.g, interacts - #6855.
- Only to selected users or groups.
- Notebook:
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, Whoosh (codenode-devel).
Fix MoinMoin.
- External:
Embed live cells / worksheets - #6855.
- Live published worksheets.