[racket] Documentation in Help Desk

[Marco Morazan]

Dear All,

What is the proper incantation to have documentation appear in the help desk for I package I have written and installed using DrRacket?

--

Cheers,

Marco

Have a´¨)
¸.·´¸.·*´¨) ¸.·*¨)
(¸.·´ (¸.·´ * wonderful day! :)

[Alexander D. Knauth]

What do you have so far?

> ____________________
> Racket Users list:
> http://lists.racket-lang.org/users


____________________
Racket Users list:
http://lists.racket-lang.org/users

[Marco Morazan]

I have a scribble file (called main) for the documentation that compiles and an info.rkt file that contains:

#lang info

(define scribblings '(("manual.scrbl" ())))

Working with DrRacket 6.1.1 [3m]

Thanks,

Marco

[Alexander D. Knauth]

Do you have a multi-collection or a single-collection package?  

If this is the only info.rkt and there’s not a (define collection ‘multi) in it it’s a single-collection.

http://docs.racket-lang.org/pkg/Package_Concepts.html#%28part._concept~3amulti-collection%29

If it’s a multi-collection package, is this info.rkt the info.rkt for the package or for the collection?

(the (define collection ‘multi) should be in the one for the package, and

the (define scribblings ….) should be in the one for the collection)

If it’s a single-collection package, the info.rkt is for both the package and the collection.

And did you put “manual.scrbl” in the scribblings when the file is “main.scrbl”?

And if you have all this correct and where it should be, but didn’t when you tried to install it for the first time,

you probably have to either uninstall and reinstall or run raco setup on the collection.  

[Marco Morazan]

Thanks! The problem was, indeed, the scribblings. --Marco