aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2021-12-13Work old "upgrading" sections into the release notesJay Berkenbilt
These are for ancient versions.
2021-12-13Remove superfluous "Upgrading to 4.0" chapterJay Berkenbilt
2021-12-13Doc: reorganize front sectionJay Berkenbilt
2021-12-13Remove docbook manual and associated filesJay Berkenbilt
2021-12-13Minor doc cleanup, update spelling checkerJay Berkenbilt
2021-12-13Doc: update requirements for building the documentationJay Berkenbilt
2021-12-13Remove "Indices and tables"Jay Berkenbilt
This was inserted by sphinx-quickstart, but it doesn't do anything for us.
2021-12-13Explicitly mark perl codeblock as suchJay Berkenbilt
2021-12-13Replace xref links to :ref:Jay Berkenbilt
Pandoc doesn't convert <xref> correctly, but it does so consistently, so this commit just changes all xref links to :ref:.
2021-12-13Replace <firstterm> with emphasisJay Berkenbilt
At one time, it seems that I was starting to use the <firstterm> feature of docbook, but I forgot about it long ago, and there is nothing consistent. In the absence of an actual glossary, just use emphasis for terminology and don't tag it in any special way. This could be fixed later if we wanted to.
2021-12-13Convert the original xml comment to an rst commentJay Berkenbilt
2021-12-13Replace <replaceable> with {...}Jay Berkenbilt
All occurrences are in :file: or :samp: now.
2021-12-13Wrap remaining replaceables in :samp:Jay Berkenbilt
2021-12-13Relabel replaceable in samp or fileJay Berkenbilt
Replace @1@replaceable@1@...@2@replaceable@2@ with @3@replaceable@3@...@3@replaceable@3@ inside of :samp: and :file: so that all remaining @1@replaceable@1@...@2@replaceable@2@ are outside. Since the {...} syntax for replaceable only works in :samp: and :file:, we will have to enclose the remaining ones in :samp: for them to work.
2021-12-13Convert <option> to :samp: and clean up literal blocksJay Berkenbilt
:option: is stronger and assumes a reference to a list of options. Since we don't have that yet, just use :samp: for options. Inside literal code blocks, there is no expansion, so just remove markup.
2021-12-13Replace things previously marked with <filename> with :file:`...`Jay Berkenbilt
2021-12-13Replace command|application with :command:`...`Jay Berkenbilt
Replace @1@...@2@ stuff from prior to the conversion with new representation.
2021-12-13doc: fix whitespace and indentation in pandoc outputJay Berkenbilt
Pandoc indented lists with two spaces after the dash, which is ugly and messes up emacs fill-paragraph. I transformed the spacing using a combination of this perl script and manual edits. I verified that the HTML generated by sphinx was identical before and after the edits and that this commit contains only whitespace changes. The perl script as it stands does not do indentation quite right for variable lists, but there were only about 8 cases that it missed, so I just fixed them manually. ```perl #!/usr/bin/env perl require 5.008; use warnings; use strict; use File::Basename; my $whoami = basename($0); my @liststack = (); while (<>) { if (m/^( *- )\S/) { my $pre = $1; while ((scalar(@liststack) > 0) && ($liststack[-1] >= length($pre))) { pop(@liststack); } if ((scalar(@liststack) == 0) && ($pre =~ m/^ /)) { push(@liststack, 1); } push(@liststack, length($pre)); my $n = scalar(@liststack); #print "** $n\n"; my $newpre = (' ' x ($n - 1)) . '- '; s/^$pre/$newpre/; } elsif (scalar(@liststack) > 0) { if ($_ ne "\n") { while (scalar(@liststack) > 0) { my $pre = m/^( *)/; if (length($1) < $liststack[-1]) { #print "XXX pop\n"; pop(@liststack); } else { last; } } my $n = scalar(@liststack); #print "** $n\n"; my $indent = ' ' x $n; s/^ +/$indent/; } } print; } ```
2021-12-13Fix errors introduced by pandocJay Berkenbilt
These showed up as warnings from sphinx-build
2021-12-13Switch build from docbook manual to sphinxJay Berkenbilt
Also remove linearization from qpdf-manual.pdf. It's a small file, and removing the dependency on the qpdf executable significantly shortens build times.
2021-12-12Insert output of pandoc as isJay Berkenbilt
pandoc -f docbook -t rst qpdf-manual.xml >| /tmp/a.rst Insert /tmp/a.rst into existing index.rst
2021-12-12Sphinx docs: tweak output of sphinx-quickstartJay Berkenbilt
2021-12-12Create initial sphinx document sourcesJay Berkenbilt
Run sphinx-quickstart. Throw everything away except conf.py and index.rst. We will incorporate this into our own build system.
2021-12-12Prepare for docbook -> rst: replace SGML entitlesJay Berkenbilt
We were using SGML entities for various non-ASCII characters so they could convert properly for both HTML and print, but this is no longer necessary as we move from docbook to RST, so just replace them. Note that the conversions done by sphinx automatically handle "smart quotes", so it works to just use regular quotes in place of &LDQUO; and &RDQUO;.
2021-12-12Prepare for docbook -> rst: protect a comment so it survives pandocJay Berkenbilt
2021-12-12Prepare for docbook -> rst: protect some XML elementsJay Berkenbilt
Pandoc docbook -> rst fails to convert the following elements, so change them to @1@tag@1@ ... @2@tag@2@ for later processing. This way, they will survive the conversion, and we can deal with them later. <application> <command> <filename> <firstterm> <option> <replaceable>
2021-12-12doc: Replace Gajic with Gajić (finally)Jay Berkenbilt
With docbook, this was not converted properly in the PDF version, but since we are moving out of docbook, we can just put the Unicode character in the source.
2021-12-12doc: remove unneeded footnoteJay Berkenbilt
Footnotes are yucky in online documentation, and the one footnote in the doc is no longer needed, so remove it.
2021-12-12TODO: doc conversion notesJay Berkenbilt
Make a list of things that need to be done while converting docbook to sphinx/rst.
2021-12-12TODOJay Berkenbilt
2021-12-10Clarify docs around @filename and leading/trailing spaceJay Berkenbilt
2021-12-10Handle bitstream overflow errors more gracefully (fixes #581)Jay Berkenbilt
* Make it a runtime error, not a logic error * Include additional information * Capture it properly in checkLinearization
2021-12-10C API: expose functions for indirect objects (fixes #588)Jay Berkenbilt
2021-12-10Expose QPDFObjectHandle::addTokenFilter (fixes #580)Jay Berkenbilt
2021-12-10C API: overhaul error handlingJay Berkenbilt
* Handle error conditions that occur when using the object handle interfaces. In the past, some exceptions were not correctly converted to errors or warnings. * Add more detailed information to qpdf-c.h * Make it possible to work more explicitly with uninitialized objects
2021-12-10Use a specific error code for type warnings and clarify docsJay Berkenbilt
2021-12-10Add missing unit test for register progress reporter in C APIJay Berkenbilt
It was exercised in the pdf-linearize example but not in qpdf-ctest.
2021-12-09Split qpdf-ctest test 24 into multiple testsJay Berkenbilt
Thanks for the nudge from m-holger!
2021-12-09Update ABI note about fluent interfacesJay Berkenbilt
2021-12-09Remove notes on safe QPDFObjectHandle -- not worth doingJay Berkenbilt
The impact on the code would be extremely high, and using it would clutter the code greatly because it would break chaining like a.getKey("/B").getKey("/C"). There are better ways to deal with the issue.
2021-12-09Refactor trap_errors to use std::functionJay Berkenbilt
2021-12-09Add changelog and release note for #587Jay Berkenbilt
2021-12-09C API: qpdf_oh_is_initializedJay Berkenbilt
2021-12-09C API: qpdf_get_last_string_lengthJay Berkenbilt
2021-12-09Typos in commentsJay Berkenbilt
2021-12-09Apply spell check to qpdf .h filesJay Berkenbilt
2021-12-09Minor documentation updatesm-holger
2021-12-02C-API expose new_object as qpdf_oh_new_objectm-holger
2021-11-29Improve testing and error handling around operating before processingJay Berkenbilt
2021-11-29Initialize QPDF::Members::file (fixes #584)Jay Berkenbilt