octoleo
/
qpdf
mirror of https://github.com/qpdf/qpdf.git
2
1
Fork 0
Code Issues Releases Wiki Activity

JSON doc fixes and ideas based on discussion with m-holger

This commit is contained in:
Jay Berkenbilt 2022-06-05 19:29:24 -04:00
parent 057bd659bc
commit 7cae125e6e
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
TODO
View File

@ -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

14
manual/json.rst
View File

@ -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: