Update docs for makeqr macro in qrcode plugin #8654
Merged
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.
name: Update docs for makeqr macro in qrcode plugin
about: Make the docs of the makeqr macro more practical by directly providing relevant context and usage examples
Is your PR related to a problem? Please describe.
The current docs for makeqr macro do not explain how to display a QR code, only how to generate data URI of an image.
The possible error correction levels are mentioned in a quote from external resource, without comprehensive explanation of what they do.
Describe the solution you are proposing
Add two examples of how to display an image with the QR code, instead of just generating a data URI.
Remove two old examples that wouldn't bring much now.
Add a table describing the error correction levels.
Remove the quote from external documentation site (but leave a link to it).
Describe alternatives you've considered
Other examples or a more elegant way of displaying a QR with dynamic content are always a possibility, I haven't come up with anything better.
Additional context
Screenshot of docs before changes:
Screenshot of docs after changes:
Handling of the base64 data URI might not be obvious to users less familiar with html.
I think it's practical to have a description of the correction levels directly in the plugin docs.
The macro/text substitution method of displaying a QR code with transcluded content is taken from
$:/plugins/tiddlywiki/qrcode/make/MakeGenericQR
.Checklist before requesting a review