[plt-scheme] scribbling docs in different versions of DrScheme

From: Robert Matovinovic (robert.matovinovic at web.de)
Date: Tue Jun 17 11:22:51 EDT 2008

First, thank you to all involved for v4 of DrScheme. It is getting better
every time and it is great to see the development. Hope it will go on

It may be of interest for the developers so I want to share my experience
preparing docs with scribble. I use the include-section command to nest
files which otherwise become to long. Index-section I use in the main file
to get the indices. Under Windows XP I used
version [3m]
version 4.0 [3m]
version [3m]
To compile my collection on the command line with setup-plt -l collect.

Under version [3m] compilation doesn't show any errors,
docs are produced, but I don't get the entries in help desk. F1 or search
for the documents doesn't work.

For version 4.0 [3m] it is the same behaviour after compilation. But
compilation takes a looong time since there are many warnings for duplicate
tags in other collections.

So I switched back to version [3m]. Here everything
works fine.

For information example files here:

#lang scribble/doc
@(require scribble/manual
          (for-label scheme "commands.ss")
@(declare-exporting mycollect/commands)

#lang scribble/doc
@(require scribble/manual
          (for-label scheme "commands.ss")
@(declare-exporting mycollect/commands)
@title{Scheme Extensions}

#lang scribble/doc
@(require scribble/manual
          (for-label scheme "commands.ss")
@(declare-exporting mycollect/commands)
@defform[(position x y z)]
Sets a position in world coordinates.


Robert Matovinovic
Wintererstr. 61
79104 Freiburg
Tel:    +49 (0)761 51 93 544
Cell:   +49 (0)171 56 32 330
email: robert.matovinovic at web.de

Posted on the users mailing list.