OpenSystemsDevelopment / qpdf

Commit 7cae125e6e1fa7a41ad17a3cd513fbd2d1ddc67e

Authored by Jay Berkenbilt
1 parent 057bd659

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

Inline Side-by-side
Showing 2 changed files with 16 additions and 7 deletions
@@ -10,6 +10,15 @@ Before Release: @@ -10,6 +10,15 @@ Before Release:
10 10
11 Pending changes: 11 Pending changes:
12 12
  13 +* Think about whether additional JSON use cases would be served by
  14 + having qpdf-v2 contain things other than "objects" or making qpdf
  15 + --json include everything that --json-output includes. Right now, if
  16 + you wanted to do something in json objects based on page
  17 + information, you'd have to run qpdf --json and also qpdf
  18 + --json-output separately. Also "qpdf-v2" doesn't follow the naming
  19 + convention. See pinned email from m-holger with subject "qpdf
  20 + json.rst" from June 5
  21 + (04ad60e5-3274-4a9e-abde-3de97640d370@www.fastmail.com)
13 * Good C API for json v2 22 * Good C API for json v2
14 * QPDFPagesTree -- avoid ever flattening the pages tree. 23 * QPDFPagesTree -- avoid ever flattening the pages tree.
15 * Check about runpath in the linux-bin distribution. I think the 24 * Check about runpath in the linux-bin distribution. I think the
manual/json.rst
  View file @7cae125
@@ -12,12 +12,11 @@ Overview @@ -12,12 +12,11 @@ Overview
12 -------- 12 --------
13 13
14 Beginning with qpdf version 11.0.0, the qpdf library and command-line 14 Beginning with qpdf version 11.0.0, the qpdf library and command-line
15 -program can produce a JSON representation of the in a PDF file. qpdf  
16 -version 11 introduces JSON format version 2. Prior to qpdf 11,  
17 -versions 8.3.0 onward had a more limited JSON representation  
18 -accessible only from the command-line. For details on what changed,  
19 -see :ref:`json-v2-changes`. The rest of this chapter documents qpdf  
20 -JSON version 2. 15 +program can produce a JSON representation of a PDF file. qpdf version
  16 +11 introduces JSON format version 2. Prior to qpdf 11, versions 8.3.0
  17 +onward had a more limited JSON representation accessible only from the
  18 +command-line. For details on what changed, see :ref:`json-v2-changes`.
  19 +The rest of this chapter documents qpdf JSON version 2.
21 20
22 Please note: this chapter discusses *qpdf JSON format*, which 21 Please note: this chapter discusses *qpdf JSON format*, which
23 represents the contents of a PDF file. This is distinct from the 22 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 @@ -289,7 +288,8 @@ As such, none of the things ``QPDFWriter`` does apply. This includes
289 recompression of streams, renumbering of objects, anything to do with 288 recompression of streams, renumbering of objects, anything to do with
290 object streams (which are not represented by qpdf JSON at all since 289 object streams (which are not represented by qpdf JSON at all since
291 they are PDF syntax, not semantics), encryption, decryption, 290 they are PDF syntax, not semantics), encryption, decryption,
292 -linearization, QDF mode, etc. 291 +linearization, QDF mode, etc. See :ref:`rewriting` for a more in-depth
  292 +discussion.
293 293
294 .. _json.example: 294 .. _json.example:
295 295