mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-04-05 02:49:32 +00:00
Add dashboard docs
This commit is contained in:
parent
e6477a04b6
commit
8dd844b1d4
@ -20,6 +20,7 @@ description = "A list of features and limitations."
|
||||
- A powerful [query language](@/docs/query/_index.md) to find
|
||||
documents
|
||||
- use [bookmarks](@/docs/webapp/bookmarks.md) to save more complex queries
|
||||
- customizable [dashboads](@/docs/webapp/dashboards.md) as the main page
|
||||
- Non-destructive: all your uploaded files are never modified and can
|
||||
always be downloaded untouched
|
||||
- Organize files using tags, folders, [Custom
|
||||
|
@ -10,7 +10,8 @@ mktoc = true
|
||||
|
||||
Docspell uses a query language to provide a powerful way to search for
|
||||
your documents. It is targeted at "power users" and it needs to be
|
||||
enabled explicitely in your user settings.
|
||||
enabled explicitely in your user settings to be used on the search
|
||||
page.
|
||||
|
||||
<div class="colums">
|
||||
|
||||
|
BIN
website/site/content/docs/webapp/dashboards-01.png
Normal file
BIN
website/site/content/docs/webapp/dashboards-01.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 157 KiB |
BIN
website/site/content/docs/webapp/dashboards-01d.png
Normal file
BIN
website/site/content/docs/webapp/dashboards-01d.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 155 KiB |
BIN
website/site/content/docs/webapp/dashboards-02.png
Normal file
BIN
website/site/content/docs/webapp/dashboards-02.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 133 KiB |
BIN
website/site/content/docs/webapp/dashboards-03.png
Normal file
BIN
website/site/content/docs/webapp/dashboards-03.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 131 KiB |
BIN
website/site/content/docs/webapp/dashboards-04.png
Normal file
BIN
website/site/content/docs/webapp/dashboards-04.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 124 KiB |
BIN
website/site/content/docs/webapp/dashboards-05.png
Normal file
BIN
website/site/content/docs/webapp/dashboards-05.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 145 KiB |
124
website/site/content/docs/webapp/dashboards.md
Normal file
124
website/site/content/docs/webapp/dashboards.md
Normal file
@ -0,0 +1,124 @@
|
||||
+++
|
||||
title = "Dashboards"
|
||||
weight = 5
|
||||
[extra]
|
||||
mktoc = true
|
||||
+++
|
||||
|
||||
The main page shows a dashboard that can be configured to show some
|
||||
aspects of your documents. The following shows the default dashboard
|
||||
that is bundled in the application:
|
||||
|
||||
{{ figure(file="dashboards-01.png") }}
|
||||
|
||||
It shows a predefined set of information, which can be customized. You
|
||||
can create multiple dashboards and switch between them, you can also
|
||||
define one as the "default" which is shown when the page loads.
|
||||
|
||||
|
||||
# Side menu
|
||||
|
||||
The side menu contains a list of useful links. The first loads the
|
||||
default dashboard. All others (and more) are available through the
|
||||
top-right menus as well.
|
||||
|
||||
The _Bookmarks_ section shows all your bookmarks and a click takes you
|
||||
directly to the search page with the corresponding bookmark active.
|
||||
|
||||
The _Settings_ section contains some links to useful settings and the
|
||||
_Manage_ section has links to metadata that can be managed separately.
|
||||
These links are fixed and cannot be changed.
|
||||
|
||||
# Dasbhoard properties
|
||||
|
||||
The main component on this page is the "dashboard". A dashboard has
|
||||
the following properties (all required):
|
||||
|
||||
- _name_: which must be unique among all dashboards
|
||||
- _columns_: the dashboard is a grid that has this number
|
||||
of columns, where each box can span any number of columns
|
||||
- _gap_: defines the gap between boxes
|
||||
- _scope_: (Personal or Collective) whether it is a personal or a
|
||||
collective dashboard. Personal dashboards can only be seen by its
|
||||
user, whereas collective dashboards can be used by all users of a
|
||||
collective. Every user can change/delete collective dashboards.
|
||||
- _default_ wether this dashboard is the default one and will be
|
||||
displayed when the page is loaded
|
||||
- a list of _boxes_ that define the content
|
||||
|
||||
# Customizing
|
||||
|
||||
When clicking on _Edit Dashboard_ down in the side menu, the currently
|
||||
viewed dashboard changes into a form that show the dashboards
|
||||
properties. You can change the content by changing, moving, adding and
|
||||
removing boxes and the dashboard properties.
|
||||
|
||||
## Editing dashboard properties
|
||||
|
||||
After clicking _Edit Dashboard_ the dashboard changes into a form:
|
||||
|
||||
{{ figure(file="dashboards-02.png") }}
|
||||
|
||||
Note the message on the top: it indicates that this dashboard is the
|
||||
bundled one that is used only if there are no custom ones available.
|
||||
That's why you can't delete it, for example. As soon as you click
|
||||
save, the configuration is stored at the server and the bundled
|
||||
dashboard will not show up again - until you delete all of your custom
|
||||
ones.
|
||||
|
||||
A dashboard must have a unique name, in this example the name is just
|
||||
left as is. You can change things by using the forms and you can
|
||||
reorder the boxes using the arrow buttons or drag and drop. When
|
||||
satisfied, click _Submit_. In the example, the last two boxes are
|
||||
removed and box decorations are enabled for the field overview box.
|
||||
|
||||
{{ figure(file="dashboards-03.png") }}
|
||||
|
||||
When you now edit this dasbhoard again, the message is gone and you
|
||||
can change the dashboard and also delete it. You can also create a new
|
||||
dashboard or copy the current one.
|
||||
|
||||
{{ figure(file="dashboards-04.png") }}
|
||||
|
||||
In this example, the dashboard was copied, then the message was
|
||||
changed and it was set to the default dashboard. This is how it looks
|
||||
now:
|
||||
|
||||
{{ figure(file="dashboards-05.png") }}
|
||||
|
||||
When there is more than one dashboard, the side menu shows all of
|
||||
them. The little house icon indicates whether this is the default
|
||||
dashboard. You can click on any dashboard in order to load it.
|
||||
|
||||
## Content
|
||||
|
||||
### Message
|
||||
|
||||
The simplest form is a message box that displays a title and a body.
|
||||
Both fields support markdown for basic formatting.
|
||||
|
||||
### Upload
|
||||
|
||||
The upload box can be used to show a file upload form. It can be
|
||||
optionally configured with a
|
||||
[source](@/docs/webapp/uploading.md#anonymous-upload). If no source is
|
||||
configured, it is just the main upload form using all default settings
|
||||
(skip duplicates, using the collective langauge etc).
|
||||
|
||||
### Stats
|
||||
|
||||
The stats box can display basic statistics given a [search
|
||||
query](@/docs/query/_index.md) or a
|
||||
[bookmark](@/docs/webapp/bookmarks.md). The query can be empty, which
|
||||
means to not restrict the results.
|
||||
|
||||
It is possible to display the numbers in a simple table or show an
|
||||
overview of some custom fields.
|
||||
|
||||
### Query
|
||||
|
||||
The query box can be used to display a table of documents returned
|
||||
from a [search query](@/docs/query/_index.md) or a
|
||||
[bookmark](@/docs/webapp/bookmarks.md). You can choose from a set of
|
||||
columns what to display. The first column will always be rendered as a
|
||||
link to the corresponding item.
|
@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Uploads"
|
||||
weight = 0
|
||||
weight = 8
|
||||
+++
|
||||
|
||||
This page describes, how files can get into docspell. Technically,
|
||||
|
Loading…
x
Reference in New Issue
Block a user