suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

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

Browse Source 
original commit: f1521de96b52a0f52ec23a02c5016622524086e5
This commit is contained in:
Matthew Flatt 2014-02-07 22:34:15 -07:00
parent 19ea3a7194
commit 2064749fa2
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl
View File

@ -392,13 +392,13 @@ result of @racket[(entity '_entity-id)].}
@defmodule[scribble/html/resource] @defmodule[scribble/html/resource]
@defproc[(resource [path string?] @defproc[(resource [path string?]
[renderer (path-string? . -> . any)] [renderer (or/c (path-string? . -> . any) #f)]
[#:exists exists (or/c 'delete-file #f) 'delete-file]) [#:exists exists (or/c 'delete-file #f) 'delete-file])
(and/c resource? (and/c resource?
(->* () (any/c) -> string?))]{ (->* () (any/c) -> string?))]{
Creates and returns a new @deftech{resource} value. Creating a 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 initiated by @racket[render-all], while calling the result resource as
a function generates a URL for the resource. 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{.}, @litchar{/}-separated relative path with no @litchar{..}, @litchar{.},
or @litchar{//}. The @racket[path] string can end in @litchar{/}, in or @litchar{//}. The @racket[path] string can end in @litchar{/}, in
which case @racket["index.html"] is effectively added to the string. 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 path for the file to be created. The path provided to
@racket[renderer] will be different from @racket[path], because the @racket[renderer] will be different from @racket[path], because the
function is invoked in the target directory. function is invoked in the target directory.

3
pkgs/scribble-pkgs/scribble-html-lib/scribble/html/resource.rkt
View File

@ -206,7 +206,8 @@
;; we're in local build mode, and insist on an absolute url, so ;; we're in local build mode, and insist on an absolute url, so
;; construct a `file://' result ;; construct a `file://' result
(list* "file://" (current-directory) url)))) (list* "file://" (current-directory) url))))
(add-renderer path render) (when renderer
(add-renderer path render))
(define (url [absolute? #f]) (define (url [absolute? #f])
;; be conservative, in case it needs to be extended in the future ;; be conservative, in case it needs to be extended in the future
(case absolute? (case absolute?