From 3b89a05d46468a4e287c7c12c74bca324c9c21b8 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Thu, 11 Jul 2013 15:46:46 -0600 Subject: [PATCH] break various documentation dependencies by making them indirect An "indirect" reference is resolved when HTML is loaded, instead of at document-build time. --- .../drracket/scribblings/drracket/languages.scrbl | 11 +++++++---- .../mrlib/scribblings/cache-image-snip.scrbl | 2 +- .../gui-doc/mrlib/scribblings/image-core.scrbl | 2 +- .../gui-pkgs/gui-doc/mrlib/scribblings/plot.scrbl | 2 +- .../pict-doc/pict/scribblings/pict.scrbl | 2 +- pkgs/r5rs-pkgs/r5rs-doc/r5rs/r5rs.scrbl | 6 ++++-- .../racket-doc/scribblings/guide/dialects.scrbl | 15 +++++++++------ .../racket-doc/scribblings/reference/syntax.scrbl | 2 +- .../scribblings/scribble/how-to-paper.scrbl | 2 +- .../syntax-color/syntax-color.scrbl | 3 +-- 10 files changed, 27 insertions(+), 20 deletions(-) diff --git a/pkgs/drracket-pkgs/drracket/scribblings/drracket/languages.scrbl b/pkgs/drracket-pkgs/drracket/scribblings/drracket/languages.scrbl index 97338ce974..122b24261d 100644 --- a/pkgs/drracket-pkgs/drracket/scribblings/drracket/languages.scrbl +++ b/pkgs/drracket-pkgs/drracket/scribblings/drracket/languages.scrbl @@ -100,7 +100,7 @@ without a @hash-lang[] prefix: @racketmodname[mzlib/shared].} @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].} ] @@ -358,11 +358,14 @@ by three calls to @racket[read-line]. @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}. @; ---------------------------------------- diff --git a/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/cache-image-snip.scrbl b/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/cache-image-snip.scrbl index 82d1e6eb6f..71aa4e4878 100644 --- a/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/cache-image-snip.scrbl +++ b/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/cache-image-snip.scrbl @@ -20,7 +20,7 @@ @deprecated[@racketmodname[racket/gui]]{This library will no longer be public in a future release; much of it will 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 unrelated other libraries.} diff --git a/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/image-core.scrbl b/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/image-core.scrbl index c1e0d18728..01568babe2 100644 --- a/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/image-core.scrbl +++ b/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/image-core.scrbl @@ -5,7 +5,7 @@ @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 support for these images are the same in all languages, specifically including support for printing the images and constructing the core data structures making diff --git a/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/plot.scrbl b/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/plot.scrbl index 66cdd48e30..03e2b09543 100644 --- a/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/plot.scrbl +++ b/pkgs/gui-pkgs/gui-doc/mrlib/scribblings/plot.scrbl @@ -7,7 +7,7 @@ a simple tool for plotting data values to a device context.} @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. @defstruct[data-set ([points (listof (is-a?/c point%))] diff --git a/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl b/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl index 54f3bc7562..c3d4a925a0 100644 --- a/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl +++ b/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl @@ -20,7 +20,7 @@ @defmodule*/no-declare[(pict)]{ The @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 @seclink[#:doc '(lib "scribblings/slideshow/slideshow.scrbl") "top"]{Slideshow}, and is re-provided by the @racketmodname[slideshow] language.} diff --git a/pkgs/r5rs-pkgs/r5rs-doc/r5rs/r5rs.scrbl b/pkgs/r5rs-pkgs/r5rs-doc/r5rs/r5rs.scrbl index 757be0b58a..54e7ed9f9f 100644 --- a/pkgs/r5rs-pkgs/r5rs-doc/r5rs/r5rs.scrbl +++ b/pkgs/r5rs-pkgs/r5rs-doc/r5rs/r5rs.scrbl @@ -53,8 +53,10 @@ according to @|r5rs|: @item{DrRacket provides an @onscreen{R5RS} language, which can be selected via the @menuitem["Language" "Choose Language..."] - menu item. See @secref[#:doc drs-doc "choose-language"] in - @other-manual[drs-doc] for more information.} + menu item. See @seclink[#:doc drs-doc "choose-language" + #: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 provides a read-eval-print loop for evaluating @|r5rs| diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/guide/dialects.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/guide/dialects.scrbl index b9fd2b0ce0..e1d60eb13b 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/guide/dialects.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/guide/dialects.scrbl @@ -44,13 +44,16 @@ including the following: @racketmodname[racket], but statically typed; see @other-manual['(lib "typed-racket/scribblings/ts-guide.scrbl")]} - @item{@racketmodname[lazy] --- like @racketmodname[racket/base], but - avoids evaluating an expression until its value is needed; see - @other-manual['(lib "lazy/lazy.scrbl")]} + @item{@racketmodname[lazy #:indirect] --- like + @racketmodname[racket/base], but avoids evaluating an + 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 - radical way to support reactive programming; see - @other-manual['(lib "frtime/scribblings/frtime.scrbl")]} + @item{@racketmodname[frtime #:indirect] --- changes evaluation in an + even more radical way to support reactive programming; see + @seclink["top" #:doc '(lib "frtime/scribblings/frtime.scrbl") + #:indirect? #t]{the FrTime documentation}.} @item{@racketmodname[scribble/base] --- a language, which looks more like Latex than Racket, for writing documentation; see diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/reference/syntax.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/reference/syntax.scrbl index f65dd4f84c..d175c1d430 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/reference/syntax.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/reference/syntax.scrbl @@ -678,7 +678,7 @@ corresponds to the default @tech{module name resolver}. @tech{collection}, and @filepath{main.rkt} is the library file name. @examples[ - (code:comment @#,t{the main @racketmodname[swindle] library:}) + (code:comment @#,t{the main @racketmodname[swindle #:indirect] library:}) (eval:alts (require (lib "swindle")) (void)) (code:comment @#,t{the same:}) (eval:alts (require (lib "swindle/main.rkt")) (void))]} diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to-paper.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to-paper.scrbl index d47069e1a0..19177dd00f 100644 --- a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to-paper.scrbl +++ b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to-paper.scrbl @@ -646,7 +646,7 @@ renders as Any value that is convertable to an image can be used directly within 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, @sample|{ diff --git a/pkgs/syntax-color-pkgs/syntax-color-doc/syntax-color/syntax-color.scrbl b/pkgs/syntax-color-pkgs/syntax-color-doc/syntax-color/syntax-color.scrbl index 5154e00f60..c915baca24 100644 --- a/pkgs/syntax-color-pkgs/syntax-color-doc/syntax-color/syntax-color.scrbl +++ b/pkgs/syntax-color-pkgs/syntax-color-doc/syntax-color/syntax-color.scrbl @@ -16,8 +16,7 @@ The @filepath{syntax-color} collection provides the underlying data structures and some helpful utilities for the @racket[color:text<%>] -class of the @other-manual['(lib -"scribblings/framework/framework.scrbl")]. +class of @racketmodname[framework]. @; ----------------------------------------------------------------------