diff --git a/docs/_static/ACL.png b/docs/_static/ACL.png deleted file mode 100644 index acd3458113..0000000000 Binary files a/docs/_static/ACL.png and /dev/null differ diff --git a/docs/_static/arrow_right.png b/docs/_static/arrow_right.png deleted file mode 100644 index 036b9e2947..0000000000 Binary files a/docs/_static/arrow_right.png and /dev/null differ diff --git a/docs/_static/bootstrap_button.png b/docs/_static/bootstrap_button.png deleted file mode 100644 index b0aaf68dfb..0000000000 Binary files a/docs/_static/bootstrap_button.png and /dev/null differ diff --git a/docs/_static/document_types_button.png b/docs/_static/document_types_button.png deleted file mode 100644 index 364dd4784e..0000000000 Binary files a/docs/_static/document_types_button.png and /dev/null differ diff --git a/docs/_static/documents_tab.png b/docs/_static/documents_tab.png deleted file mode 100644 index 01d4613be5..0000000000 Binary files a/docs/_static/documents_tab.png and /dev/null differ diff --git a/docs/_static/index_instance.png b/docs/_static/index_instance.png deleted file mode 100644 index 223e7f298a..0000000000 Binary files a/docs/_static/index_instance.png and /dev/null differ diff --git a/docs/_static/index_tab.png b/docs/_static/index_tab.png deleted file mode 100644 index fc1b81f189..0000000000 Binary files a/docs/_static/index_tab.png and /dev/null differ diff --git a/docs/_static/index_template.png b/docs/_static/index_template.png deleted file mode 100644 index 1f68f01176..0000000000 Binary files a/docs/_static/index_template.png and /dev/null differ diff --git a/docs/_static/indexes_button.png b/docs/_static/indexes_button.png deleted file mode 100644 index d511c52321..0000000000 Binary files a/docs/_static/indexes_button.png and /dev/null differ diff --git a/docs/_static/mayan_architecture.png b/docs/_static/mayan_architecture.png deleted file mode 100644 index f9f6c3c8aa..0000000000 Binary files a/docs/_static/mayan_architecture.png and /dev/null differ diff --git a/docs/_static/metadata_types_button.png b/docs/_static/metadata_types_button.png deleted file mode 100644 index f49b94d9a0..0000000000 Binary files a/docs/_static/metadata_types_button.png and /dev/null differ diff --git a/docs/_static/ocr_button.png b/docs/_static/ocr_button.png deleted file mode 100644 index 795010ab0c..0000000000 Binary files a/docs/_static/ocr_button.png and /dev/null differ diff --git a/docs/_static/page.png b/docs/_static/page.png deleted file mode 100644 index 464caf278a..0000000000 Binary files a/docs/_static/page.png and /dev/null differ diff --git a/docs/_static/permissions.png b/docs/_static/permissions.png deleted file mode 100644 index 3c3809f405..0000000000 Binary files a/docs/_static/permissions.png and /dev/null differ diff --git a/docs/_static/screenshots/smart_links_screenshot.png b/docs/_static/screenshots/smart_links_screenshot.png deleted file mode 100644 index cc507d06fb..0000000000 Binary files a/docs/_static/screenshots/smart_links_screenshot.png and /dev/null differ diff --git a/docs/_static/screenshots/tags_screenshot.png b/docs/_static/screenshots/tags_screenshot.png deleted file mode 100644 index 542a28894f..0000000000 Binary files a/docs/_static/screenshots/tags_screenshot.png and /dev/null differ diff --git a/docs/_static/setup_tab.png b/docs/_static/setup_tab.png deleted file mode 100644 index 4b14ced8f3..0000000000 Binary files a/docs/_static/setup_tab.png and /dev/null differ diff --git a/docs/_static/smart_links_button.png b/docs/_static/smart_links_button.png deleted file mode 100644 index 2e38cae5d2..0000000000 Binary files a/docs/_static/smart_links_button.png and /dev/null differ diff --git a/docs/_static/smart_links_link.png b/docs/_static/smart_links_link.png deleted file mode 100644 index ffee00f834..0000000000 Binary files a/docs/_static/smart_links_link.png and /dev/null differ diff --git a/docs/_static/sources_button.png b/docs/_static/sources_button.png deleted file mode 100644 index d8ab39d500..0000000000 Binary files a/docs/_static/sources_button.png and /dev/null differ diff --git a/docs/_static/tags_link.png b/docs/_static/tags_link.png deleted file mode 100644 index e65281ea87..0000000000 Binary files a/docs/_static/tags_link.png and /dev/null differ diff --git a/docs/_static/tags_tab.png b/docs/_static/tags_tab.png deleted file mode 100644 index 822a61d467..0000000000 Binary files a/docs/_static/tags_tab.png and /dev/null differ diff --git a/docs/_static/tools_tab.png b/docs/_static/tools_tab.png deleted file mode 100644 index 3b2392bfd8..0000000000 Binary files a/docs/_static/tools_tab.png and /dev/null differ diff --git a/docs/_static/tree_template_link.png b/docs/_static/tree_template_link.png deleted file mode 100644 index 55e9709166..0000000000 Binary files a/docs/_static/tree_template_link.png and /dev/null differ diff --git a/docs/_static/versioning.png b/docs/_static/versioning.png deleted file mode 100644 index 6ec2f24d86..0000000000 Binary files a/docs/_static/versioning.png and /dev/null differ diff --git a/docs/_static/web_form_source_tab.png b/docs/_static/web_form_source_tab.png deleted file mode 100644 index f0b51d97be..0000000000 Binary files a/docs/_static/web_form_source_tab.png and /dev/null differ diff --git a/docs/figure_src/ACL.svg b/docs/figure_src/ACL.svg deleted file mode 100644 index f0d4c66162..0000000000 --- a/docs/figure_src/ACL.svg +++ /dev/null @@ -1,594 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - Roles - Groups - Users - Users - Groups - Users - Permissions - Documents - Tags - Folders - Tier 1: Actor - Tier 2: Access - Tier 3: Object - - - diff --git a/docs/figure_src/index_instance.svg b/docs/figure_src/index_instance.svg deleted file mode 100644 index 9d404e1a85..0000000000 --- a/docs/figure_src/index_instance.svg +++ /dev/null @@ -1,724 +0,0 @@ - - - - - - - - - - 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' - document.metadata_value_for.due_date - 'Suppliers' - document.metadata_value_for.supplier - Index template - - - - - - - - - - - diff --git a/docs/figure_src/index_template.svg b/docs/figure_src/index_template.svg deleted file mode 100644 index 547d09fcbc..0000000000 --- a/docs/figure_src/index_template.svg +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - Sample index - 'Due dates' - document.metadata_value_for.due_date - 'Suppliers' - document.metadata_value_for.supplier - Index template - - - - - - diff --git a/docs/figure_src/permissions.svg b/docs/figure_src/permissions.svg deleted file mode 100644 index 3588418dfd..0000000000 --- a/docs/figure_src/permissions.svg +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - Users - Users - Groups - Roles - Permissions - Tier 1: Actor - Tier 2: Access - - - diff --git a/docs/figure_src/versioning.svg b/docs/figure_src/versioning.svg deleted file mode 100644 index e1f16f0618..0000000000 --- a/docs/figure_src/versioning.svg +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - Original version: 1.0.0 - - New major version: 2.0.0 - - New minor version: 1.1.0 - - New micro version: 1.0.1 - - - - diff --git a/docs/index.rst b/docs/index.rst index 448a3058dc..c7fd768d23 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,6 @@ Understanding Mayan EDMS :doc:`Indexes ` | :doc:`Smart links ` | :doc:`Tags ` | - :doc:`OCR ` Release notes ============= diff --git a/docs/topics/features.rst b/docs/topics/features.rst index 41c0b33314..fd459ce21f 100644 --- a/docs/topics/features.rst +++ b/docs/topics/features.rst @@ -18,11 +18,11 @@ Features * Office document format support. - * Word processing files, spreadsheets, presentations are common supported formats. + * **Mayan EDMS** can detect the presence of Libre Office and use it to support word processing files, spreadsheets and presentations. -* User defined metadata fields and meta data sets. +* User defined metadata fields. - * Metadata fields can be grouped into sets per technical, legal or structural requirements such as the `Dublin core`_. + * Several metadata fields can be matched to a document type as per technical, legal or structural requirements such as the `Dublin core`_. * Dynamic default values for metadata. @@ -60,7 +60,7 @@ Features * Multiple page PDFs and TIFFs files are supported. -* :doc:`Distributed OCR processing <../topics/ocr>`. +* Automatic OCR processing. * The task of transcribing text from documents via OCR can be distributed among several physical or virtual computers to decrease load and increase availability. @@ -69,11 +69,11 @@ Features * **Mayan EDMS** being written using the Django_ framework, can be translated to practically any language spoken in the world. For a list of translated languages have a look at Transifex_. -* :doc:`Multilingual OCR support <../topics/ocr>`. +* Multilingual OCR support. - * Multilingual OCR is provided as supported by the available language backends of the OCR engine tesseract. + * Current language of the document is passed to the corresponding OCR engine to increase the rate of data vs. recognition errors. -* :doc:`Plugable storage backends <../topics/file_storage>` (File based and GridFS included). +* :doc:`Plugable storage backends <../topics/file_storage>`. * Very easy to use 3rd party plugins such as the ones available for Amazon EC2. @@ -81,8 +81,11 @@ Features * Labeled and color coded tags can be assigned for intuitive recognition. +* Workflows. + + * Keep track of the state a document, along with the log of the previous state changes. + .. _`Dublin core`: http://dublincore.org/metadata-basics/ -.. _Samba: http://www.samba.org/ .. _Django: https://www.djangoproject.com/ .. _Transifex: https://www.transifex.com/projects/p/mayan-edms/ diff --git a/docs/topics/getting_started.rst b/docs/topics/getting_started.rst index c128430708..39f9a6e08b 100644 --- a/docs/topics/getting_started.rst +++ b/docs/topics/getting_started.rst @@ -10,8 +10,7 @@ The easy 2 step setup Document sources ---------------- -|Setup tab| |Right arrow| |Sources button| |Right arrow| |Web form tab| - + Before anything else you must define from where you will feed **Mayan EDMS** documents for it to process and store. To do this first go to the ``Setup`` tab then to the ``Sources`` button. To obtain the fastest working setup, create a @@ -22,30 +21,15 @@ compressed files uploaded from this source will be automatically decompressed an their content treated as individual documents. -Quickly bootstraping your Mayan EDMS install --------------------------------------------- -|Setup tab| |Right arrow| |Bootstrap button| - -**Mayan EDMS** includes an app called ``Bootstrap``. This app stores -scripted configurations, that when executed will setup your installation of **Mayan EDMS**. -From there you can then fine tune this setup to your needs. To use this -app go to the ``Setup`` area and launch the app using the ``Bootstrap`` button. - -.. hint:: Predefined sample setups can be downloaded from the - `Official bootstrap setup repository for Mayan EDMS`_. If you want to use - one of the available setups for testing or as a starting point, choose one - and import it with ``Import from URL``. Finally execute it on an empty database. - The longer custom setup ======================= Setting your document types --------------------------- -|Setup tab| |Right arrow| |Document types button| If none of the available bootstrap setups fit your needs and your wish to -setup **Mayan EDMS** from scratch, the first thing to consider is what your document -types will be. Examples of document types are: ``Legal documents``, +setup **Mayan EDMS** from scratch, the first thing to consider is what your document +types will be. Examples of document types are: ``Legal documents``, ``Internal documents``, ``Medical records``, ``Designing specifications``, ``Permits``. A document type represents a group, a type, a class of documents which share some common properties. A good indicator that can help you determine you document types @@ -54,7 +38,6 @@ is what kind of information or ``metadata`` is attached to the documents. Defining metadata ----------------- -|Setup tab| |Right arrow| |Metadata types button| With your document types defined it should be much easier now to define the required ``metadata`` for each of these document types. When creating ``metadata`` types, @@ -67,15 +50,15 @@ can have default values to speed up data entry, default static values are enclos quotes, ie:: "Building A" - + or:: "Storage room 1" - + Default values can also be defined as ``Python`` statements or functions such as:: current_date() - + If you want to restrict or standardize the values for a metadata type, use the ``Lookup`` field to define the list of options that are allowed. Define the lookup list using a ``Python`` list of quoted values, for example:: @@ -96,37 +79,5 @@ this type, the related metadata types for this document type will be preselected After defining all your metadata types you can also define your indexes to let **Mayan EDMS** automatically categorize your documents based on their metadata. -Refer to the chapter named :doc:`Indexes ` for examples on how to -use the document indexes. - - -.. |Setup tab| image:: /_static/setup_tab.png - :alt: Setup tab - :align: middle - -.. |Sources button| image:: /_static/sources_button.png - :alt: Sources button - :align: middle - -.. |Web form tab| image:: /_static/web_form_source_tab.png - :alt: Web form tab - :align: middle - -.. |Bootstrap button| image:: /_static/bootstrap_button.png - :alt: Bootstrap button - :align: middle - -.. |Right arrow| image:: /_static/arrow_right.png - :alt: Right arrow - :align: middle - -.. |Document types button| image:: /_static/document_types_button.png - :alt: Document types button - :align: middle - -.. |Metadata types button| image:: /_static/metadata_types_button.png - :alt: Metadata types button - :align: middle - -.. _DjangoZoom: http://djangozoom.com/ -.. _`Official bootstrap setup repository for Mayan EDMS`: http://bootstrap.mayan-edms.com/ +Refer to the chapter named :doc:`Indexes ` for examples on how to +use the document indexes. diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 6eccd98a02..0cae551fbc 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -15,7 +15,6 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: indexes installation license - ocr permissions signatures smart_links diff --git a/docs/topics/indexes.rst b/docs/topics/indexes.rst index edf3a23007..9760d8d3a0 100644 --- a/docs/topics/indexes.rst +++ b/docs/topics/indexes.rst @@ -1,9 +1,6 @@ ======= Indexes ======= -To configure: |Setup tab| |Right arrow| |Indexes button| |Right arrow| |Tree template link| - -To use: |Index tab| Indexes are an automatic method to hierarchically organize documents in relation to their metadata and to each other. @@ -16,9 +13,6 @@ 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. -.. image:: ../_static/index_template.png - :alt: index template - Index instances =============== @@ -26,28 +20,3 @@ The 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:: ../_static/index_instance.png - :alt: index instance - - -.. _Samba: http://www.samba.org/ - -.. |Setup tab| image:: /_static/setup_tab.png - :alt: Setup tab - :align: middle - -.. |Right arrow| image:: /_static/arrow_right.png - :alt: Right arrow - :align: middle - -.. |Indexes button| image:: /_static/indexes_button.png - :alt: Indexes button - :align: middle - -.. |Tree template link| image:: /_static/tree_template_link.png - :alt: Tree template link - :align: middle - -.. |Index tab| image:: /_static/index_tab.png - :alt: Index tab - :align: middle diff --git a/docs/topics/ocr.rst b/docs/topics/ocr.rst deleted file mode 100644 index b1b13243c2..0000000000 --- a/docs/topics/ocr.rst +++ /dev/null @@ -1,31 +0,0 @@ -=== -OCR -=== -To use: |Tools tab| |Right arrow| |OCR button| - -Because OCR is an intensive operation, documents are queued for OCR for -later handling. Ideally the machine serving **Mayan EDMS** should not do OCR -processing, with other machines or cloud instances then connected to the same -database doing the OCR processing. The document is checked to see if there are -text parsers available, is no parser is available for that file type then the document is passed -to Tesseract_ page by page and the results stored per page, this is to -keep the page image in sync with the transcribed text. However when -viewing the document in the details tab all the pages text are -concatenated and shown to the user. All newly uploaded documents will be -queued automatically for OCR, if this is not desired setting the :setting:`OCR_AUTOMATIC_OCR` -option to ``False`` would stop this behavior. - - -.. _Tesseract: http://code.google.com/p/tesseract-ocr/ - -.. |Tools tab| image:: /_static/tools_tab.png - :alt: Tags tab - :align: middle - -.. |Right arrow| image:: /_static/arrow_right.png - :alt: Right arrow - :align: middle - -.. |OCR button| image:: /_static/ocr_button.png - :alt: OCR button - :align: middle diff --git a/docs/topics/permissions.rst b/docs/topics/permissions.rst index 1d5d2387f6..2253131c9d 100644 --- a/docs/topics/permissions.rst +++ b/docs/topics/permissions.rst @@ -16,10 +16,6 @@ this method could be thought out as a global permission granting level. Example: Roles being granted the ``Document view`` permission will be able to view **all** documents in existance. -.. image:: ../_static/permissions.png - :alt: 2-tier permission diagram - - 3 tier access control ===================== @@ -30,9 +26,6 @@ permission but only in relation to a selected object. Example: Granting user ``Joe`` the ``Document view`` access control for document ``Payroll``, would allow him to view this document only. -.. image:: ../_static/ACL.png - :alt: 3-tier access control diagram - The permission system enforces inheritance by first checking if the user has a global permission, is a member of a group or a role that has a global permission and if not then checks to see if that user, a group or role to diff --git a/docs/topics/smart_links.rst b/docs/topics/smart_links.rst index cc4e32bb88..52bb15df13 100644 --- a/docs/topics/smart_links.rst +++ b/docs/topics/smart_links.rst @@ -3,112 +3,101 @@ Smart links =========== -To configure: |Setup tab| |Right arrow| |Smart links button| - -To use: |Document icon| |Right arrow| |Smart links link| - Smart links are usefull for navigation between documents. They are rule based but don't create any organizational structure, just show the documents that match the rules as evaluated against the metadata of the currently -displayed document. +displayed document. -.. figure:: /_static/screenshots/smart_links_screenshot.png - :alt: Smart links screenshot - :scale: 75% - Screenshot of smart links in action. The documents being shown are from the same - permit file number as the current document being viewed by the user. - Notice how the current document is also highlighted with a black border. - **Details** -To create a Smart Link, a user with adequate permissions first clicks on the +To create a Smart Link, a user with adequate permissions first clicks on the "Settings" tab in the top menu, then click on the "Smart Links" button. The screen -for creating a new (or editing an existing) Smart Link requires you to name the +for creating a new (or editing an existing) Smart Link requires you to name the Link and to ensure it is enabled if you wish to user it. Optionally, "Dynamic title" -may be created. The Dynamic title is entended to contain references to attributes -of a document or it's metadata. Let's cover some simpler cases and come back to -dynamic references below. +may be created. The Dynamic title is entended to contain references to attributes +of a document or it's metadata. Let's cover some simpler cases and come back to +dynamic references below. -*Static Links* +*Static Links* Smart links don't actually have to be overly smart. As a gentle introduction, lets create a simple "static" link which will show all the documents added in the year 2014. We'll use the title "Added in 2014", leave the dynamic title empty, and ensure -that "Enabled" is checked. +that "Enabled" is checked. -To have the link actually do something, we have to add one or more "condition". -Conditions are translated by the system into clauses in a query (search) of the +To have the link actually do something, we have to add one or more "condition". +Conditions are translated by the system into clauses in a query (search) of the document database. There is a "Create condition" link in the right-bar of the Smart -Link screen. For our simple case, the value of the "Inclusion" drop down does not -matter; we can leave it at the default "AND". For "Foreign document data" we will +Link screen. For our simple case, the value of the "Inclusion" drop down does not +matter; we can leave it at the default "AND". For "Foreign document data" we will enter: document.date_added -For "Operator" we will select "contains". +For "Operator" we will select "contains". For "Expression" we will enter: 2014 -Underneath this field, "negated" should be unchecked and "enabled" should be checked. -Save the condition then go to the documents tab. Click on the filename of any file -listed there. Click on the "Smart link" tab under the submenu. A list of all -documents entered in 2014 (if any) should be shown. +Underneath this field, "negated" should be unchecked and "enabled" should be checked. +Save the condition then go to the documents tab. Click on the filename of any file +listed there. Click on the "Smart link" tab under the submenu. A list of all +documents entered in 2014 (if any) should be shown. There are a number of other document attributes which can be used in searches, with -some important caveats: +some important caveats: * date_added: (discussed above) -* comments: this is next to useless at present, since instead of searching through - text of all comments you can instead search for the "id" of comments. +* comments: this is next to useless at present, since instead of searching through + text of all comments you can instead search for the "id" of comments. * description: enclose the text you want to search for in 'single' or "double" quotes. * document_type: can be used if Document Types have been defined and assigned to docs - as they have been uploaded. The search is performed against the "id" of the document_type + as they have been uploaded. The search is performed against the "id" of the document_type and not against the textual description of the Document Type. This limitation, - however, is hidden if used in a dynamic link as demonstrated below. - -* documentcheckout: a meaningful query clause can be consructed by choosing this + however, is hidden if used in a dynamic link as demonstrated below. + +* documentcheckout: a meaningful query clause can be consructed by choosing this documnet attribute and testing if it "is equal to" 1 (for "true" or "is checked out") or 0 (for "false" or "is not checked out") - -* documentrenamecount: this attribute is reported by the system as available for + +* documentrenamecount: this attribute is reported by the system as available for searching but it's utility is not clear - -* folderdocument: This attribute searches agains the "id" of the folder to which - a document may have been added, not against the textual name of a folder and thus - is useful primarily in dynamicly defined links (see below). - + +* folderdocument: This attribute searches agains the "id" of the folder to which + a document may have been added, not against the textual name of a folder and thus + is useful primarily in dynamicly defined links (see below). + * id: each document has a unique numeric id which can be used in searches * indexinstancenode: ?? -* metadata: ?? (see below) +* metadata: ?? (see below) * queuedocument: ?? * recentdocument: this attibute appears to hold an integer (simple number like 1,2,3) - indicating the relative order in which documents were added to the system. This + indicating the relative order in which documents were added to the system. This may be of some use for finding documents which were added before or after a given - document. - -* tagged_items: using this attribute by entering in an integer value appears to + document. + +* tagged_items: using this attribute by entering in an integer value appears to perform a search equivalent to "if document has at least one tag and this id number" - + * tags: the "id" value of the corresponding tags are used. A tag will be matched if it - is alone or among several tags assigned to a document. - + is alone or among several tags assigned to a document. + * uuid: of little value, since these are by definition unique. * versions: ?? -You can also define Smart Links based on Metadata types and values which you have -defined. For this to work, it appears to be necessary to give the metadata type "Name" +You can also define Smart Links based on Metadata types and values which you have +defined. For this to work, it appears to be necessary to give the metadata type "Name" (also known as "Internal name") which is all lowercase. The "Title" can be uppercase. For instance, if a metadata type is defined with these values: @@ -116,59 +105,59 @@ For instance, if a metadata type is defined with these values: Title: Priority Default: 5 Lookup: (1,2,3,4,5,6,7,8,9,10) -Then I can assign various documents different priorities and create a "Smart Link" -to find the high priority links by defining the condition as - Inclusion: and - Foreign document data: is greater or equal to - Expression: 5 +Then I can assign various documents different priorities and create a "Smart Link" +to find the high priority links by defining the condition as +Inclusion: and +Foreign document data: is greater or equal to +Expression: 5 *Dynamic Smart Links* -Links which are truly Smart are created by referencing the current value of the +Links which are truly Smart are created by referencing the current value of the document you are viewing and not a static value in at least one of the conditions. For instance, the last example above can be modified so that the Smart Link is: - Inclusion: and + Inclusion: and Foreign document data: is greater or equal to Expression: metadata.priority - -By including "metadata.priority" as the Expression instead of a static value, we -now have a Smart Link which will find all other documents with a Priority metadata -value greater than or equal to the one we are viewing. -Here's an example by Mathias from the forums -() which -demonstrates how to find other documents in the same project, if "project" has -been defined as a Metadata type. This example shows how to use the Dynamic Title +By including "metadata.priority" as the Expression instead of a static value, we +now have a Smart Link which will find all other documents with a Priority metadata +value greater than or equal to the one we are viewing. + +Here's an example by Mathias from the forums +() which +demonstrates how to find other documents in the same project, if "project" has +been defined as a Metadata type. This example shows how to use the Dynamic Title feature also. -Title: Same project -Dynamic title: u'All documents of: %s' % getattr(metadata, 'project', 'None') +Title: Same project +Dynamic title: u'All documents of: %s' % getattr(metadata, 'project', 'None') -Condition: -Inclusion: and -Foreign document data: metadata.project -Operator: equal -Expression: metadata.project +Condition: +Inclusion: and +Foreign document data: metadata.project +Operator: equal +Expression: metadata.project The document attributes listed above which use the "id" value to do matching are more useful for dynamic than static conditions. For instance we can set both the -foreign and current document Expressiong to "document.document_type" to get a -Smart Link to all other documents of the same Document Type as the current one. +foreign and current document Expressiong to "document.document_type" to get a +Smart Link to all other documents of the same Document Type as the current one. *Combining Conditions* -In theory we should be able to add multiple conditions and choose "and" or "or" -to define how they interact with the previous condition. There does not appear +In theory we should be able to add multiple conditions and choose "and" or "or" +to define how they interact with the previous condition. There does not appear to be a mechanism for defining parenthises to group conditions, but such subtleties are far beyond the current state of this funcitonality as even the simplest cases -appear not to work. Defining to conditions, each of which yeild a set with +appear not to work. Defining to conditions, each of which yeild a set with documents in common, and then combining them with "and" yeilds no documents at all. -Switching to "or" returns the same documents multiple times. +Switching to "or" returns the same documents multiple times. *Tricky Smart Links* -Advanced users can explore ways to use regular expressions in Smart Links. For +Advanced users can explore ways to use regular expressions in Smart Links. For example, one might want easy access to documentation for software features not yet in production by using: @@ -176,25 +165,3 @@ Foreign document data: document.description Operator: is in regular expression (case insensitive) Expression: r'test|experimental|development' - - -.. |Setup tab| image:: /_static/setup_tab.png - :alt: Setup tab - :align: middle - -.. |Right arrow| image:: /_static/arrow_right.png - :alt: Right arrow - :align: middle - -.. |Smart links button| image:: /_static/smart_links_button.png - :alt: Smart links button - :align: middle - -.. |Document icon| image:: /_static/page.png - :alt: Document icon - :align: middle - -.. |Smart links link| image:: /_static/smart_links_link.png - :alt: Smart links link - :align: middle - diff --git a/docs/topics/tags.rst b/docs/topics/tags.rst index 4b0fdf18b6..b052432ecc 100644 --- a/docs/topics/tags.rst +++ b/docs/topics/tags.rst @@ -2,35 +2,8 @@ Tags ==== -To configure and use: |Tags tab| - -To use: |Document icon| |Right arrow| |tags link| - Tags allow giving documents a toggable property. Documents can also be tagged with more than one tag. Once tagged, documents can be search also by their tags and from the tags main menu a list of all the documents with a particular tag can be obtained easily. Aside from their texts, tags can be assigned a particular color. - -.. figure:: /_static/screenshots/tags_screenshot.png - :alt: Tags links screenshot - :scale: 35% - - Screenshot of showing how tags can also be used to represent the state of a - document, in this case the review state of a permit. - -.. |Tags tab| image:: /_static/tags_tab.png - :alt: Tags tab - :align: middle - -.. |Right arrow| image:: /_static/arrow_right.png - :alt: Right arrow - :align: middle - -.. |Tags link| image:: /_static/tags_link.png - :alt: Tags link - :align: middle - -.. |Document icon| image:: /_static/page.png - :alt: Document icon - :align: middle diff --git a/docs/topics/versioning.rst b/docs/topics/versioning.rst index f8e170532f..27381ae7f2 100644 --- a/docs/topics/versioning.rst +++ b/docs/topics/versioning.rst @@ -7,9 +7,6 @@ document. Users are provided with a very comprehensive but easy to use version numbering system that allows specifying a major, minor or micro version number increase. -.. image:: ../_static/versioning.png - :alt: versioning diagram - A comment field is also provided to allow users to summarize the new verdion changes in comparison with the previous one. If a new version was uploded by mistake or such new version is no