diff --git a/docs/figure_src/ACL.svg b/docs/figure_src/ACL.svg index 61132ca3a5..f0d4c66162 100644 --- a/docs/figure_src/ACL.svg +++ b/docs/figure_src/ACL.svg @@ -15,7 +15,10 @@ id="svg4485" version="1.1" inkscape:version="0.48.2 r9819" - sodipodi:docname="ACL.svg"> + sodipodi:docname="ACL.svg" + inkscape:export-filename="/home/rosarior/development/mayan/mayan/docs/topics/ACL.png" + inkscape:export-xdpi="100" + inkscape:export-ydpi="100"> + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + due_data = '1/1/2012'supplier = 'ABC inc' + due_date = '2/1/2012'supplier = 'Z inc' + Documents + Sample index + 'Due dates' + '1/1/2012' + Document A + Document B + '2/1/2012' + Document A + Document B + 'Suppliers' + 'ABC inc' + 'Z inc' + Document A + Document B + + due_date = '1/1/2012'supplier = 'Z inc' + Document C + + Document C + + Document C + Index (generated) + + + + + + + + + + + + + + + + + + + + + + + Sample index + 'Due dates' + metadata.due_date + 'Suppliers' + metadata.supplier + Index template + + + + + + + + + + + diff --git a/docs/figure_src/index_template.svg b/docs/figure_src/index_template.svg new file mode 100644 index 0000000000..9a586b74db --- /dev/null +++ b/docs/figure_src/index_template.svg @@ -0,0 +1,204 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + Sample index + 'Due dates' + metadata.due_date + 'Suppliers' + metadata.supplier + Index template + + + + + + diff --git a/docs/figure_src/indexes.svg b/docs/figure_src/indexes.svg new file mode 100644 index 0000000000..f08d8ab0fd --- /dev/null +++ b/docs/figure_src/indexes.svg @@ -0,0 +1,513 @@ + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + Database + Index templates + Documents + Generated indexes + Disk + Directory tree(that mirrors an index) + + + + File servingsoftware + + Mayan EDMS server or cluster + + Clients + Networks attached drivers + + + + + + + + + Continuous synchonizationof generated indexes anddirectory tree + Document usage with existing software + Users don't needto learn new software + + + diff --git a/docs/topics/index_instance.png b/docs/topics/index_instance.png new file mode 100644 index 0000000000..9310c1c013 Binary files /dev/null and b/docs/topics/index_instance.png differ diff --git a/docs/topics/index_template.png b/docs/topics/index_template.png new file mode 100644 index 0000000000..6d5596dd89 Binary files /dev/null and b/docs/topics/index_template.png differ diff --git a/docs/topics/indexes.png b/docs/topics/indexes.png new file mode 100644 index 0000000000..a1a5c776e6 Binary files /dev/null and b/docs/topics/indexes.png differ diff --git a/docs/topics/indexes.rst b/docs/topics/indexes.rst index 8807b594ae..426ddc0a9c 100644 --- a/docs/topics/indexes.rst +++ b/docs/topics/indexes.rst @@ -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/