▼ |  | Scriblib: Extra Scribble Libraries

1 | Examples Using the GUI Toolbox
2 | Figures
3 | Bibliographies
4 | Bib Te X Bibliographies
5 | Footnotes
6 | Conditional Content
7 | Book-Style Indexing

► | 2 | Figures

2.1 | Configuring Output

On this page:

figure
figure*
figure**
figure-here
left-figure-style
center-figure-style
right-figure-style
left
figure-ref
Figure-ref
Figure-target
suppress-floats
2.1`` Configuring Output

8.2
top ← prev up next →

### 2`` Figures

(require scriblib/figure) | package: scribble-lib

> > procedure

> > (figure |  | tag |  |  |  |
> > |  | caption |  |  |  |
> > |  | p ... |  |  |  |
> > | [ | #:style style |  |  |  |
> > |  | #:label-sep label-sep |  |  |  |
> > |  | #:label-style label-style |  |  |  |
> > |  | #:continue? continue?]) |  | → |  | block?

> tag : string?
> caption : content?
> p : pre-flow?
> style : style? = center-figure-style
> label-sep : pre-content? = ": "
> label-style : element-style? = #f
> continue? : any/c = #f

> > procedure

> > (figure* |  | tag |  |  |  |
> > |  | caption |  |  |  |
> > |  | p ... |  |  |  |
> > | [ | #:style style |  |  |  |
> > |  | #:label-sep label-sep |  |  |  |
> > |  | #:label-style label-style |  |  |  |
> > |  | #:continue? continue?]) |  | → |  | block?

> tag : string?
> caption : content?
> p : pre-flow?
> style : style? = center-figure-style
> label-sep : pre-content? = ": "
> label-style : element-style? = #f
> continue? : any/c = #f

> > procedure

> > (figure** |  | tag |  |  |  |
> > |  | caption |  |  |  |
> > |  | p ... |  |  |  |
> > | [ | #:style style |  |  |  |
> > |  | #:label-sep label-sep |  |  |  |
> > |  | #:label-style label-style |  |  |  |
> > |  | #:continue? continue?]) |  | → |  | block?

> tag : string?
> caption : content?
> p : pre-flow?
> style : style? = center-figure-style
> label-sep : pre-content? = ": "
> label-style : element-style? = #f
> continue? : any/c = #f

> > procedure

> > (figure-here |  | tag |  |  |  |
> > |  | caption |  |  |  |
> > |  | pre-flow ... |  |  |  |
> > | [ | #:style style |  |  |  |
> > |  | #:label-sep label-sep |  |  |  |
> > |  | #:label-style label-style |  |  |  |
> > |  | #:continue? continue?]) |  | → |  | block?

> tag : string?
> caption : content?
> pre-flow : pre-flow?
> style : style? = center-figure-style
> label-sep : pre-content? = ": "
> label-style : element-style? = #f
> continue? : any/c = #f

Creates a figure. The given tag is for use with figure-ref or Figure-ref. The caption is an element. The pre-flow is decoded as a flow.

For HTML output, the figure and figure* functions are the same, while figure** allows the content to be wider than the document body. For two-column Latex output, figure* and figure** generate a figure that spans columns.

For Latex output, figure-here generates a figure to be included at the position in the output text where the figure-here occurs in the source text. For HTML output, all figure variants place the figure where the use appears in the source text.

By default, style is set so that the content of the figure is centered. Use left-figure-style, center-figure-style, or right-figure-style to specify the alignment.

The label-sep and label-style arguments adjust the way that the caption’s label is shown. By default, the label is the word “Figure” followed by a space, the figure number, “:”, and a space, but label-sep can specify an alternative to the “:” and ending space. The composed label is given the style specified by label-style.

If continue? is a true value, then the figure counter is not incremented.

Changed in version 1.24 of package scribble-lib: Added the #:label-sep and #:label-style arguments.

> > value

> > left-figure-style : style?

> > value

> > center-figure-style : style?

> > value

> > right-figure-style : style?

> > value

> > left : style?

Implements figure alignments.

The left binding is a synonym for left-figure-style, provided for backward compatibility.

> > procedure

> > (figure-ref |  | tag |  |  |  |
> > |  | ...+ |  |  |  |
> > |  | #:link-render-style link-style) |  | → |  | element?

> tag : string?
> link-style : (or/c link-render-style? #f)

Generates a reference to one or more figures, using a lowercase word “figure”.

If link-style or (current-link-render-style) at the time of rendering indicates the 'number style mode, then the word “figure” itself is not hyperlinked. Otherwise, the word figure is hyperlinked together with the referenced figure’s number.

Changed in version 1.26 of package scribble-lib: Added the #:link-render-style argument.

> > procedure

> > (Figure-ref |  | tag |  |  |  |
> > |  | ...+ |  |  |  |
> > |  | #:link-render-style link-style) |  | → |  | element?

> tag : string?
> link-style : (or/c link-render-style? #f)

Like figure-ref, but capitalizes the word “Figure”.

Changed in version 1.26 of package scribble-lib: Added the #:link-render-style argument.

> > procedure

> > (Figure-target tag [#:continue? continue?]) → element?

> tag : string?
> continue? : any/c = #f

Generates a new figure label. This function is normally not used directly, since it is used by figure.

> > procedure

> > (suppress-floats) → element?

Produces an empty element that renders in Latex as \suppressfloats, which discourages the placement of figures in the column or page of the surrounding text.

#### 2.1`` Configuring Output

Output uses the following style names, which can be adjusted in an overriding ".css" or ".tex" specification:

- "Figure", "FigureMulti", "FigureMultiWide", or "HereFigure" — used for the outer of three nested-flows for a figure, depending on whether figure, figure*, figure**, or figure-here is used to generate the figure.

- "Leftfigure", "Centerfigure", or "Rightfigure" — used for the middle of three nested-flows for a figure, depending on the specified style.

- "FigureInside" — used for the inner of three nested-flows for a figure.

- "Legend" — Wraps the caption for a figure.

- "LegendContinued" — Wraps the caption for a figure that does not increment the figure counter.

- "FigureTarget" — Wraps the label anchor and text within a figure’s caption. For Latex output, the corresponding command is given a second argument, which is just the generated label (used with \label in the command’s first argument).

- "FigureRef" — Wraps a reference to a figure. For Latex output, the corresponding command is given a second argument, which is just the target label.

top ← prev up next →