Caveats

The trading-shim is currently under active development, as is the IB tws, so that documentation for the shim aims at a moving target. Please understand that this manual, as so the shim, is currently a work in progress. Much of the text is incomplete, particularly in the reference section, where it has been collected from many shorter works written over the course of development, and not yet revised for consistency. That being said, most of the tutorial is newly written for the benefit of the first-time user, if only to answer support questions from the mailing list, and I hope the tutorial will be of immediate use to readers. In addition, many of the diagrams in the reference section are automatically generated, and these figures should be of great help to anyone tackling the sources for the first time.

As an aid to the reader in estimating the amount of text in each chapter, and to help one avoid repeatedly drilling down to empty sections, Table 1.1 gives the page counts and status of each chapter. In that table, the nil sign [] indicates a chapter that is either empty or nearly so, and a checkmark, one that has reached final draft status; those are essentially complete outside of updates as either tables listed immediately prior to the checkmark, or features listed in Chapter 11, are completed.


Table 1.1: Chapter page counts and completion status
Ch Title Pages Status
1 Introduction 6 Table 1.1 $\surd$
2 Why the Shim? 7   $\surd$
3 Installation, Setup, and Startup 23    
4 Using the Command Language 9   []
5 Adding Info to the Database [*]   []
[*] Using the Shim 5   []
A Related Command Scripts 5   []


Feedback from readers has indicated that the partially completed chapters of the manual were confusing, and so they have now been commented out. Those chapters that are checked off in Table 1.1 are essentially finished, and are included herein; those with a blank status entry are in the process of being written, and may be included; and those with a status of nil, [], are just placeholders. Readers who are not sure what the rest of this paragraph means should skip over it secure in the confidence that they would not care even if they fully understood. Developers who wish to look at the unfinished parts of the manual, in particular the reference, may compare the files manual.tex, manual.full.tex, and manual.part.tex in the doc directory, using say the diff utility, after which case the steps to build a bleeding-edge version of the manual should be obvious. Or you can ask on the list, and I'll be glad to help.

Bill Pippin 2010-01-14