From 204336e1a5fb6f49447070e11cc57ceeb2453b6a Mon Sep 17 00:00:00 2001 From: "James R. Barlow" Date: Tue, 18 Apr 2017 18:26:31 -0700 Subject: [PATCH] Move release notes into the rest of documentation --- README.rst | 2 +- docs/index.rst | 11 +- RELEASE_NOTES.rst => docs/release_notes.rst | 112 ++++++++++---------- 3 files changed, 64 insertions(+), 61 deletions(-) rename RELEASE_NOTES.rst => docs/release_notes.rst (97%) diff --git a/README.rst b/README.rst index 2ed58590..f1d61dd6 100644 --- a/README.rst +++ b/README.rst @@ -35,7 +35,7 @@ Main features - Supports more than `100 languages `_ recognized by Tesseract - Battle-tested on thousands of PDFs, a test suite and continuous integration -For details: please consult the `release notes `_. +For details: please consult the `documentation `_. Motivation ---------- diff --git a/docs/index.rst b/docs/index.rst index 029f1d9c..f166a89d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,14 +11,18 @@ be searched. PDFs are the best format for scanned documents. Unfortunately, PDFs can be difficult to work with. OCRmyPDF makes it easy to apply image processing and OCR to existing PDFs. -Contents: - .. toctree:: - :maxdepth: 2 + :maxdepth: 1 introduction + release_notes installation languages + +.. toctree:: + :caption: Usage + :maxdepth: 2 + cookbook advanced batch @@ -26,7 +30,6 @@ Contents: errors - Indices and tables ================== diff --git a/RELEASE_NOTES.rst b/docs/release_notes.rst similarity index 97% rename from RELEASE_NOTES.rst rename to docs/release_notes.rst index 153f5847..22823d19 100644 --- a/RELEASE_NOTES.rst +++ b/docs/release_notes.rst @@ -1,18 +1,18 @@ -RELEASE NOTES +Release notes ============= OCRmyPDF uses `semantic versioning `_. v4.5.4 -====== +------ - Fix ``--skip-big`` raising an exception if a page contains no images (#152) (thanks to @TomRaz) - Fix an issue where pages with no images might trigger "cannot write mode P as JPEG" (#151) v4.5.3 -====== +------ - Added a workaround for Ghostscript 9.21 and probably earlier versions would fail with the error message "VMerror -25", due to a Ghostscript bug in XMP metadata handling - High Unicode characters (U+10000 and up) are no longer accepted for setting metadata on the command line, as Ghostscript may not handle them correctly. @@ -21,7 +21,7 @@ v4.5.3 v4.5.2 -====== +------ - Fix issue #147. ``--pdf-renderer tess4 --clean`` will produce an oversized page containing the original image in the bottom left corner, due to loss DPI information. - Make "using Tesseract 4.0" warning less ominous @@ -29,13 +29,13 @@ v4.5.2 v4.5.1 -====== +------ - Fix issue #137, proportions of images with a non-square pixel aspect ratio would be distorted in output for ``--force-ocr`` and some other combinations of flags v4.5 -==== +---- - Exotic PDFs containing "Form XObjects" are now supported (issue #134; PDF reference manual 8.10), and images they contain are taken into account when determining the resolution for rasterizing - The Tesseract 4 Docker image no longer includes all languages, because it took so long to build something would tend to fail @@ -43,7 +43,7 @@ v4.5 v4.4.2 -====== +------ - The Docker images (ocrmypdf, ocrmypdf-polyglot, ocrmypdf-tess4) are now based on Ubuntu 16.10 instead of Debian stretch @@ -54,7 +54,7 @@ v4.4.2 v4.4.1 -====== +------ - To prevent a `TIFF output error `_ caused by img2pdf >= 0.2.1 and Pillow <= 3.4.2, dependencies have been tightened - The Tesseract 4.00 simultaneous process limit was increased from 1 to 2, since it was observed that 1 lowers performance @@ -63,7 +63,7 @@ v4.4.1 - Tweaks to setup.py to deal with issues in the v4.4 release v4.4 -==== +---- - Tesseract 4.00 is now supported on an experimental basis. @@ -81,32 +81,32 @@ v4.4 v4.3.5 -====== +------ - Update documentation to confirm Python 3.6.0 compatibility. No code changes were needed, so many earlier versions are likely supported. v4.3.4 -====== +------ - Fixed "decimal.InvalidOperation: quantize result has too many digits" for high DPI images v4.3.3 -====== +------ - Fixed PDF/A creation with Ghostscript 9.20 properly - Fixed an exception on inline stencil masks with a missing optional parameter v4.3.2 -====== +------ - Fixed a PDF/A creation issue with Ghostscript 9.20 (note: this fix did not actually work) v4.3.1 -====== +------ - Fixed an issue where pages produced by the "hocr" renderer after a Tesseract timeout would be rotated incorrectly if the input page was rotated with a /Rotate marker - Fixed a file handle leak in LeptonicaErrorTrap that would cause a "too many open files" error for files around hundred pages of pages long when ``--deskew`` or ``--remove-background`` or other Leptonica based image processing features were in use, depending on the system value of ``ulimit -n`` @@ -117,7 +117,7 @@ v4.3.1 v4.3 -==== +---- - New feature ``--remove-background`` to detect and erase the background of color and grayscale images - Better documentation @@ -128,20 +128,20 @@ v4.3 + Some output validation is disabled in this mode v4.2.5 -====== +------ - Fixed an issue (#100) with PDFs that omit the optional /BitsPerComponent parameter on images - Removed non-free file milk.pdf v4.2.4 -====== +------ - Fixed an error (#90) caused by PDFs that use stencil masks properly - Fixed handling of PDFs that try to draw images or stencil masks without properly setting up the graphics state (such images are now ignored for the purposes of calculating DPI) v4.2.3 -====== +------ - Fixed an issue with PDFs that store page rotation (/Rotate) in an indirect object - Integrated a few fixes to simplify downstream packaging (Debian) @@ -155,20 +155,20 @@ v4.2.3 v4.2.2 -====== +------ - Improvements to documentation v4.2.1 -====== +------ - Fixed an issue where PDF pages that contained stencil masks would report an incorrect DPI and cause Ghostscript to abort - Implemented stdin streaming v4.2 -==== +---- - ocrmypdf will now try to convert single image files to PDFs if they are provided as input (#15) @@ -201,13 +201,13 @@ v4.2 - Ghostscript now runs in "safer" mode where possible v4.1.4 -====== +------ - Bug fix: monochrome images with an ICC profile attached were incorrectly converted to full color images if lossless reconstruction was not possible due to other settings; consequence was increased file size for these images v4.1.3 -====== +------ - More helpful error message for PDFs with version 4 security handler - Update usage instructions for Windows/Docker users @@ -216,14 +216,14 @@ v4.1.3 v4.1.2 -====== +------ - Replace IEC sRGB ICC profile with Debian's sRGB (from icc-profiles-free) which is more compatible with the MIT license - More helpful error message for an error related to certain types of malformed PDFs v4.1 -==== +---- - ``--rotate-pages`` now only rotates pages when reasonably confidence in the orientation. This behavior can be adjusted with the new argument ``--rotate-pages-threshold`` - Fixed problems in error checking if ``unpaper`` is uninstalled or missing at run-time @@ -231,20 +231,20 @@ v4.1 v4.0.7 -====== +------ - Minor correction to Ghostscript output settings v4.0.6 -====== +------ - Update install instructions - Provide a sRGB profile instead of using Ghostscript's v4.0.5 -====== +------ - Remove some verbose debug messages from v4.0.4 - Fixed temporary that wasn't being deleted @@ -252,22 +252,22 @@ v4.0.5 - Inline images are now checked during DPI calculation instead of rejecting the image v4.0.4 -====== +------ Released with verbose debug message turned on. Do not use. Skip to v4.0.5. v4.0.3 -====== +------ New features ------------- +^^^^^^^^^^^^ - Page orientations detected are now reported in a summary comment Fixes ------ +^^^^^ - Show stack trace if unexpected errors occur - Treat "too few characters" error message from Tesseract as a reason to skip that page rather than @@ -276,10 +276,10 @@ Fixes v4.0.2 -====== +------ Fixes ------ +^^^^^ - Fixed compatibility with Tesseract 3.04.01 release, particularly its different way of outputting orientation information @@ -288,19 +288,19 @@ Fixes v4.0.1 -====== +------ Fixes ------ +^^^^^ - Fixed a KeyError if tesseract fails to find page orientation information v4.0 -==== +---- New features ------------- +^^^^^^^^^^^^ - Automatic page rotation (``-r``) is now available. It uses ignores any prior rotation information on PDFs and sets rotation based on the dominant orientation of detectable text. This feature is @@ -310,7 +310,7 @@ New features Fixes ------ +^^^^^ - Fixed an issue where lossless reconstruction could cause some pages to be appear incorrectly if the page was rotated by the user in Acrobat after being scanned (specifically if it a /Rotate tag) @@ -319,7 +319,7 @@ Fixes Changes -------- +^^^^^^^ - Logging output is now much easier to read - ``--deskew`` is now performed by Leptonica instead of unpaper (#25) @@ -332,20 +332,20 @@ Changes v3.2.1 -====== +------ Changes -------- +^^^^^^^ - Fixed issue #47 "convert() got and unexpected keyword argument 'dpi'" by upgrading to img2pdf 0.2 - Tweaked the Dockerfiles v3.2 -==== +---- New features ------------- +^^^^^^^^^^^^ - Lossless reconstruction: when possible, OCRmyPDF will inject text layers without otherwise manipulating the content and layout of a PDF page. For example, a PDF containing a mix @@ -357,25 +357,25 @@ New features for the polyglots among us. It is much larger. Changes -------- +^^^^^^^ - JPEG transcoding quality is now 95 instead of the default 75. Bigger file sizes for less degradation. v3.1.1 -====== +------ Changes -------- +^^^^^^^ - Fixed bug that caused incorrect page size and DPI calculations on documents with mixed page sizes v3.1 -==== +---- Changes -------- +^^^^^^^ - Default output format is now PDF/A-2b instead of PDF/A-1b - Python 3.5 and macOS El Capitan are now supported platforms - no changes were @@ -390,10 +390,10 @@ Changes - Set up Travis CI automatic integration testing v3.0 -==== +---- New features ------------- +^^^^^^^^^^^^ - Easier installation with a Docker container or Python's ``pip`` package manager - Eliminated many external dependencies, so it's easier to setup @@ -416,7 +416,7 @@ New features - Multiple images on the same PDF page are now supported Changes -------- +^^^^^^^ - New, robust rewrite in Python 3.4+ with ruffus_ pipelines - Now uses Ghostscript 9.14's improved color conversion model to preserve PDF colors @@ -454,7 +454,7 @@ Changes .. _JHOVE: http://jhove.sourceforge.net/ Release candidates ------------------- +^^^^^^^^^^^^^^^^^^ - rc9: @@ -522,12 +522,12 @@ where ``settings.txt`` contains *one argument per line*, for example: Fixes ------ +^^^^^ - Handling of filenames containing spaces: fixed Notes and known issues ----------------------- +^^^^^^^^^^^^^^^^^^^^^^ - Some dependencies may work with lower versions than tested, so try overriding dependencies if they are "in the way" to see if they work. @@ -540,7 +540,7 @@ Notes and known issues v2.2-stable (2014-09-29) -======================== +------------------------ OCRmyPDF versions 1 and 2 were implemented as shell scripts. OCRmyPDF 3.0+ is a fork that gradually replaced all shell scripts with Python while maintaining the existing command line arguments. No one is maintaining old versions.