racket / racket/scribble

figure: default-figure-* should be configurable

Open
#378 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

The function figure allows a limited adjustment for figure caption styling. But to totally control the styling, we need to be able to configure default-figure-label-text, default-figure-label-sep, default-figure-caption-style, and default-figure-counter-style. These parameters however are only provided in a private module scribble/private/lang-parameters.rkt.

default-figure-counter-style is also a bit odd. It is used inside make-delayed-element (in the function counter-target), so module loading ordering could affect its value.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading scribble/private/lang-parameters.rkt and the figure function to trace the four default-figure parameters. Then inspect make-delayed-element and counter-target to understand how default-figure-counter-style is used during module loading. Done means the parameters can be configured and counter behavior no longer depends unexpectedly on loading order.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.