From 7cae125e6e1fa7a41ad17a3cd513fbd2d1ddc67e Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Sun, 5 Jun 2022 19:29:24 -0400 Subject: [PATCH] JSON doc fixes and ideas based on discussion with m-holger --- TODO | 9 +++++++++ manual/json.rst | 14 +++++++------- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/TODO b/TODO index 7d70e254..3b1f149a 100644 --- a/TODO +++ b/TODO @@ -10,6 +10,15 @@ Before Release: Pending changes: +* Think about whether additional JSON use cases would be served by + having qpdf-v2 contain things other than "objects" or making qpdf + --json include everything that --json-output includes. Right now, if + you wanted to do something in json objects based on page + information, you'd have to run qpdf --json and also qpdf + --json-output separately. Also "qpdf-v2" doesn't follow the naming + convention. See pinned email from m-holger with subject "qpdf + json.rst" from June 5 + (04ad60e5-3274-4a9e-abde-3de97640d370@www.fastmail.com) * Good C API for json v2 * QPDFPagesTree -- avoid ever flattening the pages tree. * Check about runpath in the linux-bin distribution. I think the diff --git a/manual/json.rst b/manual/json.rst index 960cccab..2e71bdab 100644 --- a/manual/json.rst +++ b/manual/json.rst @@ -12,12 +12,11 @@ Overview -------- Beginning with qpdf version 11.0.0, the qpdf library and command-line -program can produce a JSON representation of the in a PDF file. qpdf -version 11 introduces JSON format version 2. Prior to qpdf 11, -versions 8.3.0 onward had a more limited JSON representation -accessible only from the command-line. For details on what changed, -see :ref:`json-v2-changes`. The rest of this chapter documents qpdf -JSON version 2. +program can produce a JSON representation of a PDF file. qpdf version +11 introduces JSON format version 2. Prior to qpdf 11, versions 8.3.0 +onward had a more limited JSON representation accessible only from the +command-line. For details on what changed, see :ref:`json-v2-changes`. +The rest of this chapter documents qpdf JSON version 2. Please note: this chapter discusses *qpdf JSON format*, which represents the contents of a PDF file. This is distinct from the @@ -289,7 +288,8 @@ As such, none of the things ``QPDFWriter`` does apply. This includes recompression of streams, renumbering of objects, anything to do with object streams (which are not represented by qpdf JSON at all since they are PDF syntax, not semantics), encryption, decryption, -linearization, QDF mode, etc. +linearization, QDF mode, etc. See :ref:`rewriting` for a more in-depth +discussion. .. _json.example: