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

2013-10-23 Thread David T. Pierson 
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.

Thanks.

David

_
  Racket Developers list:
  http://lists.racket-lang.org/dev

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

2013-10-23 Thread Ryan Culpepper 

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

_
 Racket Developers list:
 http://lists.racket-lang.org/dev

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

2013-10-23 Thread Jay McCarthy 
If a @tech references something from another document, you need to use
the #:doc argument to @tech. I find this very inconvenient and a
blemish in the system. You can make it not so painful by defining the
technical term you will use many times in one place:

https://github.com/plt/racket/blob/master/pkgs/web-server-pkgs/web-server-doc/web-server/scribblings/formlets.scrbl#L7

On Wed, Oct 23, 2013 at 6:22 PM, David T. Pierson d...@mindstory.com 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.

 Thanks.

 David

 _
   Racket Developers list:
   http://lists.racket-lang.org/dev



-- 
Jay McCarthy j...@cs.byu.edu
Assistant Professor / Brigham Young University
http://faculty.cs.byu.edu/~jay

The glory of God is Intelligence - DC 93
_
  Racket Developers list:
  http://lists.racket-lang.org/dev