Restructure the documentation, and draw the symbols so they scan - #2
Merged
Merged
Conversation
The figures were drawn in currentColor on a transparent ground so they would inherit whatever page they landed on. That inverts them wherever the page is dark: the documentation site on its dark theme, and GitHub on its dark theme, which is where these same files are read. A symbol is defined by its reflectance. A decoder finds it by that polarity, locking onto the finder patterns of a matrix code or the guard bars of a linear one. Inverted, it looks like a barcode and does not scan, so a page showing one to say "this package encodes barcodes" was showing a drawing of one. The QR figures also take the four-module quiet zone ISO/IEC 18004 requires, where they had two. The DataMatrix figures keep theirs: ISO/IEC 16022 asks for one module, which they already clear. Regenerated with tools/barcode/generate-examples.php. Verified by sampling the raster on the module grid: quiet zone clear, three finder patterns exact, timing pattern alternating.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two commits, kept apart because they answer different questions, but shipped
together because the second only touches files the first creates.
Restructure the documentation
Rewrites the README around what the package does rather than around its class
list, drops the "See also" blocks that repeated the navigation, and adds
installation.md,options.mdandrenderers.md. Two figures per symbology,both referenced from
docs/code/<slug>.md: the canonical symbol, and one optionthat changes what the reader sees. An option only earns a figure where it is
legible as a picture, so a scale change gets a sentence and a quiet zone, a bar
width ratio or an error correction level gets a drawing.
Draw the example symbols dark on a light ground
The figures were drawn in
currentColoron a transparent ground so they wouldinherit whatever page they landed on. That inverts them wherever the page is
dark: the documentation site on its dark theme, and GitHub on its dark theme,
which is where these same files are read.
A symbol is defined by its reflectance. A decoder finds it by that polarity,
locking onto the finder patterns of a matrix code or the guard bars of a linear
one. Inverted, it looks like a barcode and does not scan, so a page showing one
to say "this package encodes barcodes" was showing a drawing of one.
The QR figures also take the four-module quiet zone ISO/IEC 18004 requires,
where they had two. The DataMatrix figures keep theirs: ISO/IEC 16022 asks for
one module, which they already clear, and widening it would only shrink the
symbol inside the same box.
Verified by sampling the rasterised output on the module grid rather than by
eye: quiet zone clear on all four sides, the three finder patterns exact to the
module, timing pattern alternating.
Regenerated with
tools/barcode/generate-examples.php, which now carries thereason in its header so the next person does not restore
currentColor.