This is an accumulation (the "Big List") of doc tasks, items that we're aware of but not getting to, except on an opportunistic basis. Some of this points to the need for a completely new, and new kind of, document.
General
- Examples: update, retire, and create
- Rework Help (both content and system)
- Update System Limits doc
- Update Memory Management doc - done 7.2
- GC doc - done 7.2, included in Memory Management
- Introductory documents for everything (tutorials, walkthroughs, etc.)
- Need a new general tutorial for VisualWorks
- Need a general tutorial for the Web Application Server
- Porting 3.0 (or earlier) to VisualWorks 5i / 7 (or later)
- Deploying an image as executable
- Datamining the Solutions database
- General doc tasks (clean up template; update indexes; general house-cleaning)
- Double-dispatch pattern
- Subclassing nil
VisualWorks Basics - Update/improve parcel documentation
- Rewrite/update Source Code Management doc
- Document doc, including printing support
- Process doc, make more helpful (incl Promise and ProcessScheduler)
- Document the new Process monitor tool
- Graphics doc, make more helpful
- Improve Settings doc - done 7.2
- Improve error handling doc
- Undeprecate Signal - done 7.1
- Block usage (more details)
- Streams, esp. multi-byte
- Pragmas: defining/using
- Line-end conventions
- Platform-specific features or special instructions
- Executing an OS shell command from VW
GUI Stuff - Menu doc, update and complete
- Dialog doc, update and complete
- Look and Feel policies
- LookPreferences
- Paints
- Update/improve font documentation (including composed chars)
- Programmatic widget entry points
- Programmatic focus control
- Adding widgets to palette
- Creating custom widgets
- Call-back programming pattern
- Exception handling in the UI
- Widget API
- ApplicationModel API
- Hotkey configuration
- Aspect channel (doc'ed, but problematic)
- #thisContext
- VW Installer (once made part of product)
- Class StringParameterSubstitution (good class comment, but needs exposure)
Store - Store API
- Migration strategies
- Major edit (in process)
- How to use PVCS
- Enhance merge doc
Miscellany - Opentalk, turn into user and updated API doc
- COM: massive edit/rewrite
- DLSS updates
- Database: major update and edit (new presentation)
- EXDI API
- Tools API
- DST updates - done 7.1
- PlugIn updates
- Advanced Tools update, cleanup
- Internationalization/Localization: major edit/rewrite needed.
- Porting 3.x to 5i.x/7
- DLLCC: expand use of ordinals with real world examples (i.e. SocratesEXDI); simple coding guidelines to improve performance; document support for Mac OSX
- Parcel / Package API
- XML Schema for xmlToSmalltalkBinding, source and other xml documents. If they are well annotated that would be a help. But having the schemas is even more important. Building an xmlToSmalltalkBinding in an XML editor like oXygen is far more easier with the schema then without.
Walkthroughs/Tutorials Walkthroughs are "user seductive" documents, and not appropriate for all product aspects. These are needed for areas that we really want VW to be seen as an alternative to the VB/Java/C#/.NET/... solutions. - how to access a web service
- how to create a web service
- how to get and sort email
- how to send email
- how to FTP
- how to set up a web toolkit app - start to finish
- Setting up the VW side server
- Integration with the web server
- Getting a simple (one of the example apps) app to run