commit 68c455796854b7d23578921995d903f25a1b4e9e
parent 5e49131e44d863b874520a3c8206eafafe7d3629
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Fri, 3 Mar 2017 07:46:29 -0700
catch up docs on `--xelatex`
Also, adjust help text for `--doc-binding` to make it
fit in 80 columns, and clean up related documentation text.
Diffstat:
4 files changed, 26 insertions(+), 9 deletions(-)
diff --git a/scribble-doc/scribblings/scribble/renderer.scrbl b/scribble-doc/scribblings/scribble/renderer.scrbl
@@ -415,7 +415,20 @@ support yet.
@defmixin[render-mixin (render<%>) ()]{
Specializes a @racket[render<%>] class for generating PDF output via
-Latex, building on @|latex:render-mixin| from @racketmodname[scribble/latex-render].}}
+Latex, building on @|latex:render-mixin| from @racketmodname[scribble/latex-render].}
+
+@defmixin[dvi-render-mixin (render<%>) ()]{
+
+Like @racket[render-mixin], but generates PDF output via @exec{latex},
+@exec{dvips}, and @exec{pstopdf}.
+
+@history[#:added "1.4"]}}
+
+@defmixin[xelatex-render-mixin (render<%>) ()]{
+
+Like @racket[render-mixin], but generates PDF output via @exec{xelatex}.
+
+@history[#:added "1.19"]}
@; ----------------------------------------
diff --git a/scribble-doc/scribblings/scribble/running.scrbl b/scribble-doc/scribblings/scribble/running.scrbl
@@ -35,6 +35,9 @@ its file suffix:
@item{@DFlag{pdf} --- PDF @filepath{@|fn|.pdf} that is generated
via @exec{pdflatex}}
+ @item{@DFlag{xelatex} --- PDF @filepath{@|fn|.pdf} that is generated
+ via @exec{xelatex}}
+
@item{@DFlag{dvipdf} --- PDF @filepath{@|fn|.pdf} that is generated
via @exec{latex}, @exec{dvips}, and @exec{pstopdf}}
@@ -65,16 +68,17 @@ source declares a module. The module should either have a @racket[doc]
that exports @racket[doc] as a @racket[part], or it should directly
export @racket[doc] as a @racket[part]. (The submodule is tried first,
and the main module is not directly loaded or evaluated if the
-submodule can be loaded on its own.) (Use @DFlag{doc-binding} to
-change @racket[doc] to another symbol.)
+submodule can be loaded on its own.) Use @DFlag{doc-binding} to
+access an alternate exported name in place of @racket[doc].
When multiple documents are rendered at the same time, cross-reference
information in one document is visible to the other documents. See
@secref["xref-flags"] for information on references that cross
documents that are built separately.
-@history[#:changed "1.18" @elem{Added @DFlag{doc-binding}.}]
-@history[#:changed "1.4" @elem{Added @DFlag{dvipdf}.}]
+@history[#:changed "1.4" @elem{Added @DFlag{dvipdf}.}
+ #:changed "1.18" @elem{Added @DFlag{doc-binding}.}
+ #:changed "1.19" @elem{Added @DFlag{xelatex}.}]
@section{Extra and Format-Specific Files}
diff --git a/scribble-lib/info.rkt b/scribble-lib/info.rkt
@@ -23,4 +23,4 @@
(define pkg-authors '(mflatt eli))
-(define version "1.18")
+(define version "1.19")
diff --git a/scribble-lib/scribble/run.rkt b/scribble-lib/scribble/run.rkt
@@ -140,9 +140,9 @@
#:once-each
[("--quiet") "suppress output-file and undefined-tag reporting"
(current-quiet #t)]
- [("--doc-binding") new-doc-binding
- "look for document in new-doc-binding rather than 'doc"
- (set! doc-binding (string->symbol new-doc-binding))]
+ [("--doc-binding") id
+ "render document provided as <id> instead of `doc`"
+ (set! doc-binding (string->symbol id))]
#:args (file . another-file)
(let ([files (cons file another-file)])
(parameterize ([current-command-line-arguments
