From e0f341938a195118953eb96635fe9d025a5abf1f Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH] docs(configuration.rst): add doc for NUMBER_OF_SUGGESTED_DATES --- docs/configuration.rst | 14 ++++++++++++++ paperless.conf.example | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index dce6b3a83..f9714379c 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -741,6 +741,20 @@ PAPERLESS_FILENAME_DATE_ORDER= Defaults to none, which disables this feature. +PAPERLESS_NUMBER_OF_SUGGESTED_DATES= + Paperless will search the entire document for any date. The first date found will + be used as a default value for the created date. With this setting in place, + paperless will suggestion other dates found in the document. + + Regarding the size of the document, the task to find all dates can consuming much time. + Therefore the number of found dates can be limited with this setting. + + If 10 dates should be suggested, paperless will grab every date from the top of the + document to the bottom until it has reached 10 dates. After this, duplicates will + be removed, which can lead to less than 10 dates displayed in the frontend. + + Set the number to 0 to disable this feature (default) + PAPERLESS_THUMBNAIL_FONT_NAME= Paperless creates thumbnails for plain text files by rendering the content of the file on an image and uses a predefined font for that. This diff --git a/paperless.conf.example b/paperless.conf.example index 3c6566325..cdf148ea1 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -69,7 +69,7 @@ #PAPERLESS_POST_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh #PAPERLESS_FILENAME_DATE_ORDER=YMD #PAPERLESS_FILENAME_PARSE_TRANSFORMS=[] -#PAPERLESS_NUMBER_OF_SUGGESTION_DATES=5 +#PAPERLESS_NUMBER_OF_SUGGESTED_DATES=5 #PAPERLESS_THUMBNAIL_FONT_NAME= #PAPERLESS_IGNORE_DATES= #PAPERLESS_ENABLE_UPDATE_CHECK=