Using SchemeDoc from a Scheme interpreter

This tutorial will guide you through the steps of using SchemeDoc from a Scheme interpreter such as DrScheme or 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.
  2. Start your Scheme interpreter.
    If you use DrScheme set the language level to "PLT, Textual (MzScheme, includes R5RS)".
  3. Define the variable laml-dir
    The variable laml-dir should point out your LAML directory. Example:
       (define laml-dir "c:/programs/laml/")
  4. Load the necessary LAML and SchemeDoc software
    This is done by
       (load (string-append laml-dir "laml-init.scm"))
  5. Activate SchemeDoc on a Scheme source file:
    Pass a text string with the full path to a Scheme file.
    SchemeDoc looks for special markup within Scheme comments. See the example Scheme source file ex.scm.
       (schemedoc "C:/users/kurt/scheme-programs/ex.scm")
  6. 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).
  7. An alternative approach: Improved control of SchemeDoc
    You can, alternatively, process the Scheme source file with SchemeDoc via a LAML script (a tiny Scheme program) such as ex.sdoc.
    Notice that at the bottom of this script we refer to the Scheme source file ex.scm. Do the following to run the script
       (laml "C:/users/kurt/scheme-programs/ex.sdoc")
    The resulting HTML file is here.
    The script languge is documented here.
 

The steps above have been tested with DrScheme 370 and 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.