June 21, 2004
OpenMCL Documentation Rebirth

Dan Knapp is heavily editing/rewriting the OpenMCL documentation, and has finished the first draft.

I've changed wording where it took too much knowledge for granted, which usually happened because it was presuming the reader had just gone through all the preceding descriptions in order. I wrote one-sentence abstracts for every function and variable, which appear in the listing of that section. I changed the formatting of the syntax summaries, and made the wording, particularly that of the parameter descriptions, conform to some style rules which I really should write down.

I added extensive hyperlinks and cross-references, and applied formatting to function and variable names which appear in the body text. I eliminated footnotes, because they break flow (call it a personal preference); they are either integrated into the text, or moved into a separate notes section at the bottom of the page, depending on their relevance.

Posted by jjwiseman at June 21, 2004 05:20 PM
Post a comment

Email Address:


Unless you answer this question, your comment will be classified as spam and will not be posted.
(I'll give you a hint: the answer is “lisp”.)


Remember info?