tingerrr / subpar

A typst package for creating sub figures.

subpar

Subpar is a Typst package for creating sub figures.

#import "@preview/subpar:0.1.1"

#set page(height: auto)
#set par(justify: true)

#subpar.grid(
  figure(image("/assets/andromeda.jpg"), caption: [
    An image of the andromeda galaxy.
  ]), <a>,
  figure(image("/assets/mountains.jpg"), caption: [
    A sunset illuminating the sky above a mountain range.
  ]), <b>,
  columns: (1fr, 1fr),
  caption: [A figure composed of two sub figures.],
  label: <full>,
)

Above in @full, we see a figure which is composed of two other figures, namely @a and @b.

Contributing

Contributions are most welcome, make sure to let others know you're working on something beforehand so no two people waste their time working on the same issue. It's recommended to have typst-test installed to run tests locally.

Documentation

A guide and API-reference for subpar can be found in it's manual.

subpar's Issues

If inside the main figure's caption, don't prefix subfigure ref with figure ref

i'd like to not prefix the subfigure counter with the main figure when referencing from within the main figure's caption. in this example

#import "@preview/subpar:0.1.0"

#subpar.grid(
  figure(image("/assets/andromeda.jpg"), caption: [
    An image of the andromeda galaxy.
  ]), <a>,
  figure(image("/assets/mountains.jpg"), caption: [
    A sunset illuminating the sky above a mountain range.
  ]), <b>,
  columns: (1fr, 1fr),
  caption: [A figure composed of two sub figures, @a and @b],
  label: <full>,
)

i'm trying to get the caption

A figure composed of two sub figures, a) and b)

instead of

A figure composed of two sub figures, Figure 1a and Figure 1b

Related comment

Vertically aligned sub figure captions

Allow vertically aligning sub figure captions, for sub figures which differ in size.

Multi-language support

Currently, the supplement of a super-figure is set to "Figure" explicitly, because it cannot be resolved by user code in the show rule in order to apply it to its children regardless of their kind.

Better support for resolving auto values in typst itself or better native i18n support like in typst#3728 could solve this.

Alternatively, the linguify package or my unfinished translation package could be used to provide translations.

Supplement will not resolve within the elements context

When using propagate-supplement: true, we use a mirror implementation of the built-in supplement resolver, but this cannot resolve the context in which an element is referred to, leading to incorrect references if used in a multilingual document.

A current workaround is setting propagate-supplement to false and specifying the supplement for all sub figures manually.

`subpar.grid` does not pass `kind` to `subpar.super`

When using grid the kind parameter is not passed to super, this means that users are unable to configure the super figure kind leading to incorrect counting and default supplements.

Prefer named sink args to prevent overriding defaults set with show rule

subpar/src/lib.typ

Lines 114 to 115 in cac5e07

	placement: placement,
	gap: gap,

By defining these to have a default value through the function signature, and passing them directly to figure, any values set through set/show rules are overridden. Taking sink arguments and destructuring named arguments into the parent figure should suitably retain control without applying defaults.

How to align first line of captions?

Hi,

I'm really excited about subpar, I jumped on it as soon as I saw the first version was released!

I'm trying it out on a project of mine and I see the figure captions are aligned nicely, but the result looks a bit off to my taste:

In this case it would make more sense to me if the captions' first lines were aligned.

Do you have any suggestions on how I could achieve this, or would it have to be integrated into subpar?

Position of the subfigures' reference numbers

It would be nice to have an option to position the subfigures' numbers in a specific position, like in the top left corner.

This is an example from a comment on the Typst repo:

Using "supplement: [Listing]" does not work

Using supplement: "Listing" returns panicked with: "Cannot infer supplement, must be set."

Temporary workaround: propagate-supplement: false

Relative numbering is incorrect for super-figures

In order to allow relative numbering, the numbering would be set to a function which evaluates the another counter and appends the actual figure number. This works with normal figures and sub-figures, but not with super-figures.

This is because the ref show rule must be adjusted to use the correct figure number itself.

Something like typst#3930 could solve this by explicitly providing the location at which the numbering function should be evaluated, the same way outline and ref do it on their own already.

But perhaps the counters could be stepped differently, such that the ref show rule is not required.