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

scribble: ++args for passing command-line arguments to documents

Browse Source 
original commit: 392ea2e91d6c51157daa35dd1aa72cca951b6ac9
This commit is contained in:
Matthew Flatt 2014-01-19 15:22:15 -08:00
parent 78728a728e
commit eb4e22904a
2 changed files with 32 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/running.scrbl
View File

@ -164,3 +164,22 @@ in @filepath{a.scrbl} and @filepath{b.scrbl}, then
builds @filepath{c.html} with cross-reference links into builds @filepath{c.html} with cross-reference links into
@filepath{a.html} and @filepath{b.html}. @filepath{a.html} and @filepath{b.html}.
@section{Passing Command-Line Arguments to Documents}
When @exec{scribble} loads and renders a document module, by default
it sets @racket[current-command-line-arguments] to an empty vector.
Use the @DPFlag{arg} flag (any number of times) to add a string to
@racket[current-command-line-arguments].
For example,
@commandline{scribble ++arg --mode ++arg fast turtle.scrbl}
causes @racket[(current-command-line-arguments)] to return
@racket['#("--mode" "fast")] while @filepath{turtle.scrbl} is loaded
and rendered, which could affect the content that
@filepath{turtle.scrbl} generates if it uses
@racket[current-command-line-arguments].
@history[#:changed "1.1" @elem{Added the empty-vector default and @DPFlag{arg} flag.}]

20
pkgs/scribble-pkgs/scribble-lib/scribble/run.rkt
View File

@ -30,6 +30,7 @@
(define current-directory-depth (make-parameter 0)) (define current-directory-depth (make-parameter 0))
(define current-quiet (make-parameter #f)) (define current-quiet (make-parameter #f))
(define helper-file-prefix (make-parameter #f)) (define helper-file-prefix (make-parameter #f))
(define doc-command-line-arguments (make-parameter null))
(define (read-one str) (define (read-one str)
(let ([i (open-input-string str)]) (let ([i (open-input-string str)])
@ -119,18 +120,23 @@
[("++info-in") file "load format-specific cross-ref info from <file>" [("++info-in") file "load format-specific cross-ref info from <file>"
(current-info-input-files (current-info-input-files
(cons file (current-info-input-files)))] (cons file (current-info-input-files)))]
[("++arg") arg "add <arg> to current-command-line-arguments"
(doc-command-line-arguments
(cons arg (doc-command-line-arguments)))]
#:once-each #:once-each
[("--quiet") "suppress output-file and undefined-tag reporting" [("--quiet") "suppress output-file and undefined-tag reporting"
(current-quiet #t)] (current-quiet #t)]
#:args (file . another-file) #:args (file . another-file)
(let ([files (cons file another-file)]) (let ([files (cons file another-file)])
(build-docs (map (lambda (file) (parameterize ([current-command-line-arguments
;; Try `doc' submodule, first: (list->vector (reverse (doc-command-line-arguments)))])
(if (module-declared? `(submod (file ,file) doc) #t) (build-docs (map (lambda (file)
(dynamic-require `(submod (file ,file) doc) 'doc) ;; Try `doc' submodule, first:
(dynamic-require `(file ,file) 'doc))) (if (module-declared? `(submod (file ,file) doc) #t)
files) (dynamic-require `(submod (file ,file) doc) 'doc)
files)))) (dynamic-require `(file ,file) 'doc)))
files)
files)))))
(define (build-docs docs files) (define (build-docs docs files)
(when (and (current-dest-name) (when (and (current-dest-name)