break various documentation dependencies by making them indirect

An "indirect" reference is resolved when HTML is loaded,
instead of at document-build time.
This commit is contained in:
Matthew Flatt 2013-07-11 15:46:46 -06:00
parent 8cf13c3f46
commit 3b89a05d46
10 changed files with 27 additions and 20 deletions

View File

@ -100,7 +100,7 @@ without a @hash-lang[] prefix:
@racketmodname[mzlib/shared].} @racketmodname[mzlib/shared].}
@item{The @as-index{@drlang{Swindle} language} starts with the same @item{The @as-index{@drlang{Swindle} language} starts with the same
bindings as @racketmodname[swindle], and evaluates the program like bindings as @racketmodname[swindle #:indirect], and evaluates the program like
@racket[load].} @racket[load].}
] ]
@ -358,11 +358,14 @@ by three calls to @racket[read-line].
@section[#:tag "experimental-langs"]{Other Experimental Languages} @section[#:tag "experimental-langs"]{Other Experimental Languages}
For information on @onscreen{Lazy Racket}, see @other-manual['(lib "lazy/lazy.scrbl")]. For information on @onscreen{Lazy Racket}, see @seclink["top" #:doc
'(lib "lazy/lazy.scrbl") #:indirect? #t]{the Lazy Racket documentation}.
For information on @onscreen{FrTime}, see @other-manual['(lib "frtime/scribblings/frtime.scrbl")]. For information on @onscreen{FrTime}, see @seclink["top" #:doc '(lib
"frtime/scribblings/frtime.scrbl") #:indirect? #t]{the FrTime documentation}.
For information on @onscreen{Algol 60}, see @other-manual['(lib "algol60/algol60.scrbl")]. For information on @onscreen{Algol 60}, see @seclink["top" #:doc '(lib
"algol60/algol60.scrbl") #:indirect? #t]{the Algol60 documentation}.
@; ---------------------------------------- @; ----------------------------------------

View File

@ -20,7 +20,7 @@
@deprecated[@racketmodname[racket/gui]]{This library will @deprecated[@racketmodname[racket/gui]]{This library will
no longer be public in a future release; much of it will no longer be public in a future release; much of it will
be available privately to continue to support the implementation be available privately to continue to support the implementation
of @racket[htdp/image], but the other exported functions of @racketmodname[htdp/image #:indirect], but the other exported functions
here are not useful and have names that confusingly match here are not useful and have names that confusingly match
unrelated other libraries.} unrelated other libraries.}

View File

@ -5,7 +5,7 @@
@defmodule[mrlib/image-core] @defmodule[mrlib/image-core]
This library is the core part of the @racketmodname[2htdp/image] library that DrRacket This library is the core part of the @racketmodname[2htdp/image #:indirect] library that DrRacket
links into the namespace of all languages that it runs. This ensures that minimal links into the namespace of all languages that it runs. This ensures that minimal
support for these images are the same in all languages, specifically including support for these images are the same in all languages, specifically including
support for printing the images and constructing the core data structures making support for printing the images and constructing the core data structures making

View File

@ -7,7 +7,7 @@
a simple tool for plotting data values to a device context.} a simple tool for plotting data values to a device context.}
@bold{This is an old library, kept only for compatibility.} You will @bold{This is an old library, kept only for compatibility.} You will
undoubtedly want to use the @racketmodname[plot] library instead, which offers undoubtedly want to use the @racketmodname[plot #:indirect] library instead, which offers
many more features and is actively maintained. many more features and is actively maintained.
@defstruct[data-set ([points (listof (is-a?/c point%))] @defstruct[data-set ([points (listof (is-a?/c point%))]

View File

@ -20,7 +20,7 @@
@defmodule*/no-declare[(pict)]{ The @defmodule*/no-declare[(pict)]{ The
@racketmodname[pict] library is one of the standard Racket @racketmodname[pict] library is one of the standard Racket
functional picture libraries (the other being @racketmodname[2htdp/image]). functional picture libraries (the other being @racketmodname[2htdp/image #:indirect]).
This library was original designed for use with This library was original designed for use with
@seclink[#:doc '(lib "scribblings/slideshow/slideshow.scrbl") "top"]{Slideshow}, @seclink[#:doc '(lib "scribblings/slideshow/slideshow.scrbl") "top"]{Slideshow},
and is re-provided by the @racketmodname[slideshow] language.} and is re-provided by the @racketmodname[slideshow] language.}

View File

@ -53,8 +53,10 @@ according to @|r5rs|:
@item{DrRacket provides an @onscreen{R5RS} language, which can be @item{DrRacket provides an @onscreen{R5RS} language, which can be
selected via the @menuitem["Language" "Choose Language..."] selected via the @menuitem["Language" "Choose Language..."]
menu item. See @secref[#:doc drs-doc "choose-language"] in menu item. See @seclink[#:doc drs-doc "choose-language"
@other-manual[drs-doc] for more information.} #:indirect? #t]{@onscreen{Choose Language...}} in
@seclink["top" #:doc drs-doc #:indirect? #t]{the DrRacket
documentation} for more information.}
@item{The @exec{plt-r5rs} executable runs an @|r5rs| program or @item{The @exec{plt-r5rs} executable runs an @|r5rs| program or
provides a read-eval-print loop for evaluating @|r5rs| provides a read-eval-print loop for evaluating @|r5rs|

View File

@ -44,13 +44,16 @@ including the following:
@racketmodname[racket], but statically typed; see @racketmodname[racket], but statically typed; see
@other-manual['(lib "typed-racket/scribblings/ts-guide.scrbl")]} @other-manual['(lib "typed-racket/scribblings/ts-guide.scrbl")]}
@item{@racketmodname[lazy] --- like @racketmodname[racket/base], but @item{@racketmodname[lazy #:indirect] --- like
avoids evaluating an expression until its value is needed; see @racketmodname[racket/base], but avoids evaluating an
@other-manual['(lib "lazy/lazy.scrbl")]} expression until its value is needed; see @seclink["top" #:doc
'(lib "lazy/lazy.scrbl") #:indirect? #t]{the Lazy Racket
documentation}.}
@item{@racketmodname[frtime] --- changes evaluation in an even more @item{@racketmodname[frtime #:indirect] --- changes evaluation in an
radical way to support reactive programming; see even more radical way to support reactive programming; see
@other-manual['(lib "frtime/scribblings/frtime.scrbl")]} @seclink["top" #:doc '(lib "frtime/scribblings/frtime.scrbl")
#:indirect? #t]{the FrTime documentation}.}
@item{@racketmodname[scribble/base] --- a language, which looks more @item{@racketmodname[scribble/base] --- a language, which looks more
like Latex than Racket, for writing documentation; see like Latex than Racket, for writing documentation; see

View File

@ -678,7 +678,7 @@ corresponds to the default @tech{module name resolver}.
@tech{collection}, and @filepath{main.rkt} is the library file name. @tech{collection}, and @filepath{main.rkt} is the library file name.
@examples[ @examples[
(code:comment @#,t{the main @racketmodname[swindle] library:}) (code:comment @#,t{the main @racketmodname[swindle #:indirect] library:})
(eval:alts (require (lib "swindle")) (void)) (eval:alts (require (lib "swindle")) (void))
(code:comment @#,t{the same:}) (code:comment @#,t{the same:})
(eval:alts (require (lib "swindle/main.rkt")) (void))]} (eval:alts (require (lib "swindle/main.rkt")) (void))]}

View File

@ -646,7 +646,7 @@ renders as
Any value that is convertable to an image can be used directly within Any value that is convertable to an image can be used directly within
a Scribble document. Functions from the @racketmodname[pict] a Scribble document. Functions from the @racketmodname[pict]
and @racketmodname[2htdp/image] libraries, for example, generate and @racketmodname[2htdp/image #:indirect] libraries, for example, generate
images. For example, images. For example,
@sample|{ @sample|{

View File

@ -16,8 +16,7 @@
The @filepath{syntax-color} collection provides the underlying data The @filepath{syntax-color} collection provides the underlying data
structures and some helpful utilities for the @racket[color:text<%>] structures and some helpful utilities for the @racket[color:text<%>]
class of the @other-manual['(lib class of @racketmodname[framework].
"scribblings/framework/framework.scrbl")].
@; ---------------------------------------------------------------------- @; ----------------------------------------------------------------------