lindell / lindell/JsBarcode

Documentation: Explain ratio relationship between height, width, and font size

Open
#393 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.9k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

To support scaling rendering, `width`, `height`, and `font size` do not reflect absolute units but rather proportions. In printing to custom media such as die cut labels it would reduce the amount of trial and error to have the proportional relationships between those values documented. Specifically a couple sentences in the `options` documentation would suffice:
1. Using the defaults for `width: 2` and `height: 100` as an example state what the aspect ratio of the rectangle of the smallest *"unguarded"* line would be.
2. Using the defaults for `width: 2` and `font size: 20` as an example state what the ratio between the smallest line and the font scale would be. Analogous to a *"psuedo-point"* relative to the smallest line width.

Contributor guide

Open the contributing guide

Research direction

Locate the options documentation and review how the default width, height, and font size are described. Add the two requested proportional relationships using the stated defaults, then verify that the wording clearly explains the smallest unguarded line and the font scale.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.