bkyk8rc3zvpnsf5inmcqq4n3k98cv6hj-my-site-hyper-literate-git.test.suzanne.soy-0.0.1

commit 2064749fa2bda6f05cbf333c85b7ef32522bf04a
parent 19ea3a7194612a5178758cc800ac0348fba3a8e1
Author: Matthew Flatt <mflatt@racket-lang.org>
Date:   Fri,  7 Feb 2014 22:34:15 -0700

scribblings/html/resource: allow #f renderer for URL conversion

original commit: f1521de96b52a0f52ec23a02c5016622524086e5

Diffstat:
M
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl
 | 
8
+++++---
M
pkgs/scribble-pkgs/scribble-html-lib/scribble/html/resource.rkt
 | 
3
++-

2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl
@@ -392,13 +392,13 @@ result of @racket[(entity '_entity-id)].}
 @defmodule[scribble/html/resource]
 
 @defproc[(resource [path string?]
-                   [renderer (path-string? . -> . any)]
+                   [renderer (or/c (path-string? . -> . any) #f)]
                    [#:exists exists (or/c 'delete-file #f) 'delete-file])
          (and/c resource?
                 (->* () (any/c) -> string?))]{
 
 Creates and returns a new @deftech{resource} value. Creating a
-resource registers @racket[renderer] to be called when rendering is
+resource registers @racket[renderer] (if non-@racket[#f]) to be called when rendering is
 initiated by @racket[render-all], while calling the result resource as
 a function generates a URL for the resource.
 
@@ -416,8 +416,10 @@ determines the ultimate URL. The @racket[path] string must be a
 @litchar{/}-separated relative path with no @litchar{..}, @litchar{.},
 or @litchar{//}. The @racket[path] string can end in @litchar{/}, in
 which case @racket["index.html"] is effectively added to the string.
+Using @racket[resource] with @racket[#f] as @racket[renderer] is
+useful for converting a path to a URL according to @racket[url-roots].
 
-The @racket[renderer] argument renders the resource, receiving the
+The @racket[renderer] argument (when non-@racket[#f]) renders the resource, receiving the
 path for the file to be created. The path provided to
 @racket[renderer] will be different from @racket[path], because the
 function is invoked in the target directory.
diff --git a/pkgs/scribble-pkgs/scribble-html-lib/scribble/html/resource.rkt b/pkgs/scribble-pkgs/scribble-html-lib/scribble/html/resource.rkt
@@ -206,7 +206,8 @@
             ;; we're in local build mode, and insist on an absolute url, so
             ;; construct a `file://' result
             (list* "file://" (current-directory) url))))
-  (add-renderer path render)
+  (when renderer
+    (add-renderer path render))
   (define (url [absolute? #f])
     ;; be conservative, in case it needs to be extended in the future
     (case absolute?