Added example of @tech with #:doc

I never remember how to use this.
This commit is contained in:
William J. Bowman 2015-09-16 18:51:45 -04:00 committed by Vincent St-Amour
parent 94804a1579
commit ea01ae2f68

View File

@ -1774,6 +1774,11 @@ key; in either case, if @racket[normalize?] is true, the key is normalized in th
@racket[deftech]. The @racket[#:doc] and @racket[#:tag-prefixes]
arguments support cross-document and section-specific references, like
in @racket[secref].
For example:
@racketblock[@tech[#:doc '(lib "scribblings/guide/guide.scrbl")]{blame object}]
creates a link to @tech[#:doc '(lib "scribblings/guide/guide.scrbl")]{blame object} in
@other-doc['(lib "scribblings/guide/guide.scrbl")].
With the default style files, the hyperlink created by @racket[tech]
is somewhat quieter than most hyperlinks: the underline in HTML output