Using SchemeDoc from an operating sytem command prompt

This tutorial will guide you through the steps of using SchemeDoc from a command prompt.
You cannot use this approach if LAML is configured to use DrScheme. You are recommended to configure LAML to use MzScheme.

  1. SchemeDoc installation.
    You must first install SchemeDoc (or the full LAML system) relative to your platform (such as Windows), operating system (such as Windows XP) and Scheme System (such as DrScheme).
    On Windows: If you organize the Scheme and SchemeDoc software as recommended, this is an easy step.
    If at all possible for you, you should add the LAML bin directory to the path environment variable of your operating system.
  2. Start your command prompt
    On windows, this is done via the menus Start > Programs > Accessories > Command Prompt
    Navigate to the directory in which your Scheme stuff is located.
  3. Make and run a LAML script which procduces the docmentation.
    The script should normally be in the same directory as your Scheme source file. The example script ex.sdoc makes the documetation of the Scheme source file ex.scm.
    From the command prompt, run the script by
       laml ex.sdoc
    If you could not add the laml bin directory to the operating system path you have to write something like
       C:\programs\laml\bin\laml ex.sdoc
  4. Enjoy the result.
    The resulting HTML file is available in the same directory as your source file.
    In our case it is ex.html. A couple of other auxiliary files do also appear (not important to you).
 

The steps above have been tested with MzScheme 370 on Windows 2000, LAML (full) version 32.1.
The steps above have also been tested with MzScheme 209 on Linux with LAML (full) version 32.1.
The steps above have also been tested with MzScheme 209 on Windows XP with SchemeDoc version 32.1.

Back to the SchemeDoc home page.