Finished indexes topic of the documentation will full ilustrations
This commit is contained in:
BIN
docs/topics/index_instance.png
Normal file
BIN
docs/topics/index_instance.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
BIN
docs/topics/index_template.png
Normal file
BIN
docs/topics/index_template.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
docs/topics/indexes.png
Normal file
BIN
docs/topics/indexes.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
@@ -2,23 +2,48 @@
|
||||
Indexes
|
||||
=======
|
||||
|
||||
Administrators first define the template of the index and an instance
|
||||
of the index is then auto-populated with links to the documents depending
|
||||
on the rules of each branch of the index evaluated againts the metadata
|
||||
of the documents. Indexes can be mirrored to the operating system filesystem
|
||||
using the configuration option
|
||||
:setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`. This creates an actual
|
||||
directory tree and links to the actual stored files but using
|
||||
the filename of the documents as stored in the database. This
|
||||
filesystem mirror of the index can them be served with Samba_ across the
|
||||
network. This access would be read-only, and new versions of the files
|
||||
would have to be uploaded from the web GUI using the new document
|
||||
versioning support.
|
||||
Indexes are an automatic method to hierarchically organize documents in relation to their metadata and to each other.
|
||||
Since multiple indexes can be defined, the first step is to create an empty index.
|
||||
Administrators then define the tree template showing how the index will be structured.
|
||||
Each branch can be a pseudo folder, which can hold other child 'folders' or
|
||||
a document container which will have all the links to the documents that
|
||||
matched the path to reach the document container.
|
||||
|
||||
The index cannot be edited manually, only changing
|
||||
.. image:: index_template.png
|
||||
:alt: index template
|
||||
|
||||
This template is the skeleton from which an instance of the index is then
|
||||
auto-populated with links to the documents depending on the rules of each
|
||||
branch of the index evaluated against the metadata and properties of the documents.
|
||||
|
||||
.. image:: index_instance.png
|
||||
:alt: index instance
|
||||
|
||||
Indexes can be mirrored to the operating system filesystem
|
||||
using the configuration option
|
||||
:setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`.
|
||||
|
||||
``settings_local.py``::
|
||||
|
||||
# Supposing the 'Sample index' internal name is 'sample_index'
|
||||
DOCUMENT_INDEXING_FILESYSTEM_SERVING = {
|
||||
'sample_index': '/var/local/document/sharing/invoices/',
|
||||
}
|
||||
|
||||
This creates an actual directory tree and links to the actual stored files but using
|
||||
the filename of the documents as stored in the database.
|
||||
|
||||
.. image:: indexes.png
|
||||
:alt: indexes diagram
|
||||
|
||||
This filesystem mirror of the index can them be served with Samba_ across the
|
||||
network. This access would be read-only, with new versions of the files
|
||||
being uploaded from the web GUI using the document versioning support.
|
||||
|
||||
The index cannot be edited manually to protect it's integrity, only changing
|
||||
the rules or the metadata of the documents would cause the index to be
|
||||
regenerated. For manual organization of documents there are the folders,
|
||||
their structure is however flat, and they have to be manually updated and
|
||||
curated.
|
||||
curated.
|
||||
|
||||
.. _Samba: http://www.samba.org/
|
||||
|
||||
Reference in New Issue
Block a user