lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "fix list indentation - mkdocs expects four spaces"

Browse Source 
This reverts commit 30a119387acdef9b10693e2eeb3dc0010baf7449.
This commit is contained in:
Martin Dörfelt 2024-10-27 16:28:05 +01:00 committed by shamoon
parent 1c391969a9
commit bfb436ad08
4 changed files with 537 additions and 537 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/api.md
View File

@ -430,49 +430,49 @@ a json payload of the format:
The following methods are supported: The following methods are supported:
- `set_correspondent` - `set_correspondent`
- Requires `parameters`: `{ "correspondent": CORRESPONDENT_ID }` - Requires `parameters`: `{ "correspondent": CORRESPONDENT_ID }`
- `set_document_type` - `set_document_type`
- Requires `parameters`: `{ "document_type": DOCUMENT_TYPE_ID }` - Requires `parameters`: `{ "document_type": DOCUMENT_TYPE_ID }`
- `set_storage_path` - `set_storage_path`
- Requires `parameters`: `{ "storage_path": STORAGE_PATH_ID }` - Requires `parameters`: `{ "storage_path": STORAGE_PATH_ID }`
- `add_tag` - `add_tag`
- Requires `parameters`: `{ "tag": TAG_ID }` - Requires `parameters`: `{ "tag": TAG_ID }`
- `remove_tag` - `remove_tag`
- Requires `parameters`: `{ "tag": TAG_ID }` - Requires `parameters`: `{ "tag": TAG_ID }`
- `modify_tags` - `modify_tags`
- Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and / or `{ "remove_tags": [LIST_OF_TAG_IDS] }` - Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and / or `{ "remove_tags": [LIST_OF_TAG_IDS] }`
- `delete` - `delete`
- No `parameters` required - No `parameters` required
- `reprocess` - `reprocess`
- No `parameters` required - No `parameters` required
- `set_permissions` - `set_permissions`
- Requires `parameters`: - Requires `parameters`:
- `"set_permissions": PERMISSIONS_OBJ` (see format [above](#permissions)) and / or - `"set_permissions": PERMISSIONS_OBJ` (see format [above](#permissions)) and / or
- `"owner": OWNER_ID or null` - `"owner": OWNER_ID or null`
- `"merge": true or false` (defaults to false) - `"merge": true or false` (defaults to false)
- The `merge` flag determines if the supplied permissions will overwrite all existing permissions (including - The `merge` flag determines if the supplied permissions will overwrite all existing permissions (including
removing them) or be merged with existing permissions. removing them) or be merged with existing permissions.
- `merge` - `merge`
- No additional `parameters` required. - No additional `parameters` required.
- The ordering of the merged document is determined by the list of IDs. - The ordering of the merged document is determined by the list of IDs.
- Optional `parameters`: - Optional `parameters`:
- `"metadata_document_id": DOC_ID` apply metadata (tags, correspondent, etc.) from this document to the merged document. - `"metadata_document_id": DOC_ID` apply metadata (tags, correspondent, etc.) from this document to the merged document.
- `"delete_originals": true` to delete the original documents. This requires the calling user being the owner of - `"delete_originals": true` to delete the original documents. This requires the calling user being the owner of
all documents that are merged. all documents that are merged.
- `split` - `split`
- Requires `parameters`: - Requires `parameters`:
- `"pages": [..]` The list should be a list of pages and/or a ranges, separated by commas e.g. `"[1,2-3,4,5-7]"` - `"pages": [..]` The list should be a list of pages and/or a ranges, separated by commas e.g. `"[1,2-3,4,5-7]"`
- Optional `parameters`: - Optional `parameters`:
- `"delete_originals": true` to delete the original document after consumption. This requires the calling user being the owner of - `"delete_originals": true` to delete the original document after consumption. This requires the calling user being the owner of
the document. the document.
- The split operation only accepts a single document. - The split operation only accepts a single document.
- `rotate` - `rotate`
- Requires `parameters`: - Requires `parameters`:
- `"degrees": DEGREES`. Must be an integer i.e. 90, 180, 270 - `"degrees": DEGREES`. Must be an integer i.e. 90, 180, 270
- `delete_pages` - `delete_pages`
- Requires `parameters`: - Requires `parameters`:
- `"pages": [..]` The list should be a list of integers e.g. `"[2,3,4]"` - `"pages": [..]` The list should be a list of integers e.g. `"[2,3,4]"`
- The delete_pages operation only accepts a single document. - The delete_pages operation only accepts a single document.
### Objects ### Objects

984
docs/changelog.md
View File

File diff suppressed because it is too large Load Diff

8
docs/configuration.md
View File

@ -15,10 +15,10 @@ or applicable default will be utilized instead.
- If you are running paperless on anything else, paperless will search - If you are running paperless on anything else, paperless will search
for the configuration file in these locations and use the first one for the configuration file in these locations and use the first one
it finds: it finds:
- The environment variable `PAPERLESS_CONFIGURATION_PATH` - The environment variable `PAPERLESS_CONFIGURATION_PATH`
- `/path/to/paperless/paperless.conf` - `/path/to/paperless/paperless.conf`
- `/etc/paperless.conf` - `/etc/paperless.conf`
- `/usr/local/etc/paperless.conf` - `/usr/local/etc/paperless.conf`
## Required services ## Required services

22
docs/usage.md
View File

@ -156,7 +156,7 @@ different means. These are as follows:
will not consume mails already tagged. Not all mail servers support will not consume mails already tagged. Not all mail servers support
this feature! this feature!
- **Apple Mail support:** Apple Mail clients allow differently colored tags. For this to work use `apple:<color>` (e.g. _apple:green_) as a custom tag. Available colors are _red_, _orange_, _yellow_, _blue_, _green_, _violet_ and _grey_. - **Apple Mail support:** Apple Mail clients allow differently colored tags. For this to work use `apple:<color>` (e.g. _apple:green_) as a custom tag. Available colors are _red_, _orange_, _yellow_, _blue_, _green_, _violet_ and _grey_.
!!! warning !!! warning
@ -780,16 +780,16 @@ Paperless-ngx consists of the following components:
This task processor is responsible for: This task processor is responsible for:
- Consuming documents. When the consumer finds new documents, it - Consuming documents. When the consumer finds new documents, it
notifies the task processor to start a consumption task. notifies the task processor to start a consumption task.
- The task processor also performs the consumption of any - The task processor also performs the consumption of any
documents you upload through the web interface. documents you upload through the web interface.
- Consuming emails. It periodically checks your configured - Consuming emails. It periodically checks your configured
accounts for new emails and notifies the task processor to accounts for new emails and notifies the task processor to
consume the attachment of an email. consume the attachment of an email.
- Maintaining the search index and the automatic matching - Maintaining the search index and the automatic matching
algorithm. These are things that paperless needs to do from time algorithm. These are things that paperless needs to do from time
to time in order to operate properly. to time in order to operate properly.
This allows paperless to process multiple documents from your This allows paperless to process multiple documents from your
consumption folder in parallel! On a modern multi core system, this consumption folder in parallel! On a modern multi core system, this