Emit annotation page count as a sidecar in the output zip#84
Open
delize wants to merge 1 commit into
Open
Conversation
Write a '<doc> _scrybble.json' sidecar next to the rendered outputs containing
{"annotation_pages": N}, where N is the number of .rm annotation files (pages
with handwriting/ink). This lets a client distinguish a document with real
handwriting from an un-annotated PDF without guessing from file size; N is 0
for an un-annotated document. Additive - existing consumers ignore the file.
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
1 participant
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.
Adds a small
<doc> _scrybble.jsonsidecar next to the rendered_remarks.pdf/_obsidian.md, containing:{"annotation_pages": N}where N is the number of
.rmannotation files (pages with handwriting/ink). It's 0 for a document that was added but never annotated (e.g. a blank daily-journal PDF).Why: a client can't reliably tell a real handwritten note from an un-annotated PDF by file size (a blank multi-page template is bigger than a one-page note) or by markdown emptiness (handwriting-only notebooks also produce empty markdown). The annotation-file count is the authoritative signal, and only the renderer has it. This lets the Obsidian plugin's automatic sync skip empty documents instead of cluttering the vault.
Additive and backward-compatible: it's one extra file in the output dir; existing consumers that pick out the pdf/md ignore it.
Verified: rendered a real un-annotated PDF end-to-end; produces
… _scrybble.json={"annotation_pages": 0}alongside the normal outputs.