From dac8ba2873f3f79addb9f91b5374a42f4d7640e5 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Mon, 30 Jun 2014 09:32:01 +0100 Subject: [PATCH] scribble & pict: add history These history notes should have been part of commits c4a58dc4a5 and 05760a12f6. --- .../pict-doc/pict/scribblings/pict.scrbl | 17 +++++++++++++---- pkgs/pict-pkgs/pict-lib/info.rkt | 2 +- .../scribblings/scribble/renderer.scrbl | 18 ++++++++++++++---- .../scribblings/scribble/running.scrbl | 4 ++++ 4 files changed, 32 insertions(+), 9 deletions(-) diff --git a/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl b/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl index 962791935f..0084e5d3c0 100644 --- a/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl +++ b/pkgs/pict-pkgs/pict-doc/pict/scribblings/pict.scrbl @@ -64,9 +64,16 @@ picts. The functions @racket[pict-width], @racket[pict-height], @racket[pict-descent], and @racket[pict-ascent] extract bounding box information from a pict. -A pict is a convertible datatype through the @racketmodname[file/convertible] -protocol. Supported conversions include @racket['png-bytes], -@racket['eps-bytes], and @racket['pdf-bytes]. +A pict is a convertible datatype through the +@racketmodname[file/convertible] protocol. Supported conversions +include @racket['png-bytes], @racket['eps-bytes], @racket['pdf-bytes], +@racket['svg-bytes], and variants such as @racket['png-bytes+bounds] +and @racket['png-bytes+bounds8]. + +@history[#:changed "1.2" @elem{Added support for + @racket['png-bytes+bounds], + @racket['png-bytes+bounds8] and similar + variants.}] @defstruct[pict ([draw any/c] @@ -992,7 +999,9 @@ A parameter that determines an amount of padding added to each edge of a @tech{pict} when converting to a format like @racket['png@2x-bytes+bounds8] (see @racketmodname[file/convertible]). The default value of the parameter is @racket['(3 3 3 3)], which adds three pixels to each edge to accomodate -a small amount of drawing outside the pict's @tech{bounding box}.} +a small amount of drawing outside the pict's @tech{bounding box}. + +@history[#:added "1.2"]} @defproc[(draw-pict [pict pict?] diff --git a/pkgs/pict-pkgs/pict-lib/info.rkt b/pkgs/pict-pkgs/pict-lib/info.rkt index fb0736c177..35f2c8847d 100644 --- a/pkgs/pict-pkgs/pict-lib/info.rkt +++ b/pkgs/pict-pkgs/pict-lib/info.rkt @@ -12,4 +12,4 @@ (define pkg-authors '(mflatt robby)) -(define version "1.1") +(define version "1.2") diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/renderer.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/renderer.scrbl index a7fe6c1328..71e29c901a 100644 --- a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/renderer.scrbl +++ b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/renderer.scrbl @@ -104,7 +104,9 @@ written to the current output port. If @racket[warn-undefined?] is a true value, then references to missing cross-reference targets trigger a warning message on the -current error port.} +current error port. + +@history[#:changed "1.4" @elem{Added the @racket[#:image-preferences] argument.}]} @section{Base Renderer} @@ -261,7 +263,8 @@ Represents a renderer. [prefix-file (or/c path-string? #f) #f] [style-file (or/c path-string? #f) #f] [style-extra-files (listof path-string?) null] - [extra-files (listof path-string?) null])]{ + [extra-files (listof path-string?) null] + [image-preferences (listof (or/c 'ps 'pdf 'png 'svg 'gif)) null])]{ Creates a renderer whose output will go to @racket[dest-dir]. For example, @racket[dest-dir] could name the directory containing the @@ -287,8 +290,15 @@ styles in a formal-specific way; see @secref["config-style"] for more information. The @racket[extra-files] argument names files to be copied to the -output location, such as image files or extra configuration files.} -} +output location, such as image files or extra configuration files. + +The @racket[image-preferences] argument specified preferred formats +for image files and conversion, where formats listed earlier in the +list are more preferred. The renderer may not support all of the +formats listed in @racket[image-preferences]. + +@history[#:changed "1.4" @elem{Added the @racket[image-preferences] + initialization argument.}]}} @; ---------------------------------------- diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/running.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/running.scrbl index 8173a4e88e..df95d135cb 100644 --- a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/running.scrbl +++ b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/running.scrbl @@ -72,6 +72,8 @@ 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.4" @elem{Added @DFlag{dvipdf}.}] + @section{Extra and Format-Specific Files} Use the @DFlag{style} flag to specify a format-specific file to adjust @@ -188,6 +190,8 @@ ps}. To generate HTML pages with images converted to SVG format instead of PNG format, combine @DFlag{html} with @exec{@DPFlag{convert} svg}. +@history[#:changed "1.4" @elem{Added @DPFlag{convert} support.}] + @section{Passing Command-Line Arguments to Documents} When @exec{scribble} loads and renders a document module, by default