From a0c74025e3c1cda4b17c044c13f7251f6a7fe96c Mon Sep 17 00:00:00 2001 From: jonaswinkler Date: Tue, 15 Dec 2020 14:30:31 +0100 Subject: [PATCH] changelog and docs --- docs/advanced_usage.rst | 36 +++++++++++++++++++++--------------- docs/changelog.rst | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 15 deletions(-) diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst index b5ae254b3..48a86384c 100644 --- a/docs/advanced_usage.rst +++ b/docs/advanced_usage.rst @@ -263,10 +263,10 @@ using the identifier which it has assigned to each document. You will end up get files like ``0000123.pdf`` in your media directory. This isn't necessarily a bad thing, because you normally don't have to access these files manually. However, if you wish to name your files differently, you can do that by adjusting the -``PAPERLESS_FILENAME_FORMAT`` settings variable. +``PAPERLESS_FILENAME_FORMAT`` configuration option. -This variable allows you to configure the filename (folders are allowed!) using -placeholders. For example, setting +This variable allows you to configure the filename (folders are allowed) using +placeholders. For example, configuring this to .. code:: bash @@ -277,17 +277,16 @@ will create a directory structure as follows: .. code:: 2019/ - my_bank/ - statement-january-0000001.pdf - statement-february-0000002.pdf + My bank/ + Statement January.pdf + Statement February.pdf 2020/ - my_bank/ - statement-january-0000003.pdf - shoe_store/ - my_new_shoes-0000004.pdf - -Paperless appends the unique identifier of each document to the filename. This -avoids filename clashes. + My bank/ + Statement January.pdf + Letter.pdf + Letter_01.pdf + Shoe store/ + My new shoes.pdf .. danger:: @@ -299,6 +298,7 @@ Paperless provides the following placeholders withing filenames: * ``{correspondent}``: The name of the correspondent, or "none". * ``{document_type}``: The name of the document type, or "none". +* ``{tag_list}``: A comma separated list of all tags assigned to the document. * ``{title}``: The title of the document. * ``{created}``: The full date and time the document was created. * ``{created_year}``: Year created only. @@ -309,8 +309,14 @@ Paperless provides the following placeholders withing filenames: * ``{added_month}``: Month added only (number 1-12). * ``{added_day}``: Day added only (number 1-31). -Paperless will convert all values for the placeholders into values which are safe -for use in filenames. + +Paperless will try to conserve the information from your database as much as possible. +However, some characters that you can use in document titles and correspondent names (such +as ``: \ /`` and a couple more) are not allowed in filenames and will be replaced with dashes. + +If paperless detects that two documents share the same filename, paperless will automatically +append ``_01``, ``_02``, etc to the filename. This happens if all the placeholders in a filename +evaluate to the same value. .. hint:: diff --git a/docs/changelog.rst b/docs/changelog.rst index a50fc31d5..0e55cb144 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,6 +5,40 @@ Changelog ********* + +paperless-ng 0.9.7 +################## + + +* Front end + + * Thanks to the hard work of `Michael Shamoon`_, paperless now comes with a much more streamlined UI for + filtering documents. + + * `Michael Shamoon`_ replaced the document preview with another component. This should fix compatibility with Safari browsers. + + * Paperless now stores your saved views on the server and associates them with your user account. You + will have to recreate your views. + +* Other additions and changes + + * The GitHub and documentation links now open in new tabs/windows. Thanks to `rYR79435`_. + * The new filename format field ``{tag_list}`` inserts a list of tags into the filename, separated by comma. + * The ``document_retagger`` no longer removes inbox tags or tags without matching rules. + * The new configuration option ``PAPERLESS_COOKIE_PREFIX`` allows you to run multiple instances of paperless on different ports. + This option enables you to be logged in into multiple instances by specifying different cookie names for each instance. + +* Fixes + + * Sometimes paperless would assign dates in the future to newly consumed documents. + * The filename format fields ``{created_month}`` and ``{created_day}`` now use a leading zero for single digit values. + * The filename format field ``{tags}`` can no longer be used without arguments. + * Paperless was not able to consume many images (especially images from mobile scanners) due to missing DPI information. + Paperless now assumes A4 paper size for PDF generation if no DPI information is present. + * Documents with empty titles could not be opened from the table view due to the link being empty. + * Fixed an issue with filenames containing special characters such as ``:`` not being accepted for upload. + + paperless-ng 0.9.6 ################## @@ -841,6 +875,8 @@ bulk of the work on this big change. * Initial release +.. _rYR79435: https://github.com/rYR79435 +.. _Michael Shamoon: https://github.com/shamoon .. _jayme-github: http://github.com/jayme-github .. _Brian Conn: https://github.com/TheConnMan .. _Christopher Luu: https://github.com/nuudles