[plt-scheme] Scribble question: how do you refer to another Scribble document?

From: Stephen Bloch (sbloch at adelphi.edu)
Date: Sat Jan 16 15:52:52 EST 2010

I tried sending this before, but apparently from the wrong e-mail address so it went to the moderator.  Let's try again.

I'm documenting a teachpack that includes almost-identical copies of image.ss and universe.ss, and rather than repeat or include all their documentation I thought it would make more sense to just hot-link to it.  As I read the docs,

@secref[#:doc something]

should do the trick.  My first few attempts being unsuccessful, I looked through the bundle for examples.  I found

@secref[#:doc '(lib "scribblings/setup-plt/setup-plt.scrbl") "setup-info"]

copied this into my own scribble file, built and installed a PLaneT package, and it worked.

Since I wanted to refer to the whole file rather than one specific tag in it, I replaced "setup-info" with "top",
built and installed the PLaneT package, and it worked.  I concluded that what goes in the quotation marks is a path from .../collects to a .scrbl file.  But when I replaced that path with "teachpack/htdp/scribblings/image.scrbl", setup-plt said

WARNING: undefined tag

and the generated HTML page has some Scheme code in red talking about

(part ("(lib scribblings/image.scrbl)" "top"))

I thought maybe the target had to be in some particular blessed directory, so I copied "image.scrbl" into the same directory that "setup-plt.scrbl" had been in, and linked to it there.  Same result; it's not about being descended from the "scribblings" directory.

A little help, please?

Stephen Bloch
sbloch at adelphi.edu

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.racket-lang.org/users/archive/attachments/20100116/f836621f/attachment.html>

Posted on the users mailing list.