Minor documentation improvements/fixes

This commit is contained in:
Eike Kettner 2020-08-14 23:04:23 +02:00
parent fde52bbbb0
commit 49c3b1db3b
4 changed files with 16 additions and 10 deletions

View File

@ -15,17 +15,18 @@
- Rework page that displays sources; allow to copy the urls and add - Rework page that displays sources; allow to copy the urls and add
a qr code a qr code
- Add item notes to the cards in the list view, can be configured if - Add item notes to the cards in the list view, can be configured if
it is shown or not (see #186, #201) it is shown or not (#186, #201)
- Improve how the item notes are displayed (see #186) - Improve how the item notes are displayed in the item detail view
(#186, #192)
- Fix the *Load more…* button - Fix the *Load more…* button
- Allow to search by tag categories (see #203) - Allow to search by tag categories (#203)
- Allow to edit metadata in item detail view. Until now it was only - Allow to edit metadata in item detail view. Until now it was only
possible to add new metadata (see #205) possible to add new metadata (#205)
- Do not cover the whole screen with the metadata modal dialog, only - Do not cover the whole screen with the metadata modal dialog, only
the menu is now covered so that it is possible to select text from the menu is now covered so that it is possible to select text from
the document (see #205) the document (#205)
- Allow to hide some fields from the menus. What fields to display - Allow to hide some fields from the menus. What fields to display
can be configured in the ui settings (see #195) can be configured in the ui settings (#195)
- Implemented some routes that were specified in the openapi, but have - Implemented some routes that were specified in the openapi, but have
not been implemented so far not been implemented so far
- Fix source upload routes where it didn't check whether a source is - Fix source upload routes where it didn't check whether a source is
@ -38,14 +39,14 @@
to re-process some files of an item or all. There is no UI for this to re-process some files of an item or all. There is no UI for this
for now. You'd need to run `curl` or something manually to trigger for now. You'd need to run `curl` or something manually to trigger
it. It will replace all extracted metadata of the *files*,but it. It will replace all extracted metadata of the *files*,but
doesn't touch the metadata of the item. doesn't touch the metadata of the item. (#206)
- Add a task to convert all pdfs using the - Add a task to convert all pdfs using the
[OCRMyPdf](https://github.com/jbarlow83/OCRmyPDF) tool that can be [OCRMyPdf](https://github.com/jbarlow83/OCRmyPDF) tool that can be
used in docspell since the last release. This task converts all your used in docspell since the last release. This task converts all your
existing PDFs into a PDF/A type pdf including the OCR-ed text layer. existing PDFs into a PDF/A type pdf including the OCR-ed text layer.
There is no UI to trigger this task, but a There is no UI to trigger this task, but a
[script](https://docspell.org/docs/tools/convert-all-pdf/) is [script](https://docspell.org/docs/tools/convert-all-pdf/) is
provided to help with it. provided to help with it. (#206)
- There is now an [Android Client - There is now an [Android Client
App](https://github.com/docspell/android-client) to conveniently App](https://github.com/docspell/android-client) to conveniently
upload files from your android devices upload files from your android devices

View File

@ -95,7 +95,7 @@ data* associated:
`bill`, `contract`, `receipt` etc. Usually an item is not tagged `bill`, `contract`, `receipt` etc. Usually an item is not tagged
with more than one tag of a category. with more than one tag of a category.
- a *folder*: a folder is similiar to a tag, but an item can only be - a *folder*: a folder is similiar to a tag, but an item can only be
in exactly one folder (or none). Furhtermore folders allow to in exactly one folder (or none). Furthermore folders allow to
associate users, so that items are only visible to the users who are associate users, so that items are only visible to the users who are
members of a folder. members of a folder.
- an *item date*: this is the date of the document if this is not - an *item date*: this is the date of the document if this is not

View File

@ -20,6 +20,11 @@ your collective.
There is no UI part to trigger this route, so you need to use curl or There is no UI part to trigger this route, so you need to use curl or
the script `convert-all-pdfs.sh` in the `tools/` directory. the script `convert-all-pdfs.sh` in the `tools/` directory.
# Requirements
It is a bash script that additionally needs
[curl](https://curl.haxx.se/) and
[jq](https://stedolan.github.io/jq/).
# Usage # Usage

View File

@ -134,7 +134,7 @@ restrict the results using full text search with the *content* field.
{% infobubble(mode="warning", title="Please note") %} {% infobubble(mode="warning", title="Please note") %}
This field is intended to be used in conjunction with other fields in This field is intended to be used in conjunction with other fields in
the search menu. It *may be really slow* if used alone, since first the search menu. It *may be really slow* if used alone, since first
the database query is executed and its results are furhter constrained the database query is executed and its results are further constrained
by fulltext search. by fulltext search.
Use the search-bar with option *Contents Only* to do quick fulltext Use the search-bar with option *Contents Only* to do quick fulltext