[racket-dev] accessing @deftech terms in the reference from the guide

From: Ryan Culpepper (ryanc at ccs.neu.edu)
Date: Wed Oct 23 20:50:54 EDT 2013

On 10/23/2013 08:22 PM, David T. Pierson wrote:
> Are terms defined via @deftech in the Racket reference supposed to be
> accessible via @tech from the Racket guide?
>
> In pkgs/racket-pkgs/racket-doc/scribblings/reference/evts.scrbl there
> exists a line that looks like:
>
>    ... @deftech{synchronizable event} ...
>
> In my pkgs/racket-pkgs/racket-doc/scribblings/guide/concurrency.scrbl I
> have:
>
>    ... @tech{synchronizable event}s. ...
>
> When I build, I get:
>
>    raco setup: --- building documentation ---
>    raco setup: WARNING: undefined tag in <pkgs>/racket-doc/scribblings/guide/guide.scrbl:
>    raco setup:  (tech "synchronizable event")
>
> I'm guessing only the @deftech terms defined in the guide are accessible?  This
> is not a big deal, I just wanted to be sure I wasn't doing something
> incorrectly.

You need to use the #:doc argument to the tech function to tell it that 
the term was defined in the Racket Reference. Thus:

.... @tech[#:doc '(lib 
"scribblings/reference/reference.scrbl")]{synchronizable events} ....

or better:

@(define reference-doc '(lib "scribblings/reference/reference.scrbl"))
.... @tech[#:doc reference-doc]{synchronizable events} ....

Ryan


Posted on the dev mailing list.