TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-22 10:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Website redesign

Browse Source
This commit is contained in:
eikek
2022-01-27 20:23:15 +01:00
parent 3fc7f54f1a
commit 261d2af9bb
248 changed files with 3519 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
website/site/content/docs/webapp/customfields.md
View File

@ -3,6 +3,8 @@ title = "Custom Fields"
weight = 18
+++
# Custom Fields
Custom fields allow to attach user defined metadata to items. For
example, you may want to track the amount of each receipt or the
invoice number etc. You can define fields that can be associated to
@ -15,7 +17,7 @@ Custom fields can be deactivated in the user settings.
Go to the _Manage Data_ page, that can be reached from the top right
menu. One entry at the left shows _Custom Fields_:
{{ figure(file="custom-fields-01.png") }}
{{ figure2(light="custom-fields-01.png", dark="custom-fields-01_dark.png") }}
Fields are defined per collective. They can also be created in the
item edit menu (just like creating organizations). The `#Usage`
@ -23,7 +25,7 @@ columns show how many items have a value for this field.
A field consists of a name, a format and optional a label:
{{ figure(file="custom-fields-02.png") }}
{{ figure2(light="custom-fields-02.png", dark="custom-fields-02_dark.png") }}
The name and format is required. The name must be unique among all
your fields and it is special in that it must be a valid _identifier_:
@ -73,7 +75,7 @@ corresponding input field is shown asking for values. You can select
multiple fields. Only one value is allowed to set per item and field.
The example below shows a text field and a money field:
{{ figure(file="custom-fields-03.png") }}
{{ figure2(light="custom-fields-03.png", dark="custom-fields-03_dark.png") }}
You can create new fields right here without going to the _Manage
Data_ page, by clicking the plus icon (1). The format of each field is
@ -83,14 +85,13 @@ As soon as a correct value is typed in, it is saved to the item and
shown in the header next to the tags. If you click the trash-can icon
next to an input, the value is removed from the item.
{{ figure(file="custom-fields-04.png") }}
{{ figure2(light="custom-fields-04.png", dark="custom-fields-04_dark.png") }}
The item card also shows custom fields, in the same place as tags:
<div class="columns is-centered">
<div class="column is-one-quarter">
{{ imgnormal(file="custom-fields-05.png", width=300) }}
</div>
<div class="flex flex-row items-center justify-center">
{{ imgnormal2(light="custom-fields-05.png", dark="custom-fields-05_dark.png", width=300) }}
</div>
Adding values for custom fields in
@ -102,13 +103,13 @@ Adding values for custom fields in
The search menu shows the same dropdown for selecting a custom field.
Then you can set values that are matched against your items.
{{ figure(file="custom-fields-06.png") }}
{{ figure2(light="custom-fields-06.png", dark="custom-fields-06_dark.png") }}
Values are also validated in the search form. Only valid values are
sent to the server for searching. There is one exception: you can use
a wildcard at beginning and/or end to do a substring match:
{{ figure(file="custom-fields-07.png") }}
{{ figure2(light="custom-fields-07.png", dark="custom-fields-07_dark.png") }}
For all numeric and money values, a little summary is displayed next
to the overall item count at the top of the page.