Skip to content

Commit

Permalink
Some documentation...
Browse files Browse the repository at this point in the history
  • Loading branch information
domi4484 committed Jul 22, 2021
1 parent 550bee0 commit 08f9944
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Document Management System plugin for QGIS

## What
A document management plugin to help managing relations between a documents table and features.
A document management plugin to help managing relations between a document table and one or more feature tables.

## Configuration

### Relations
The relation/s between the Document table and the Feature/s table/s must be configured by hand
in the usal way in Project -> Properties -> Relations.
The relation/s between the Document table and the Feature/s table/s must be configured by hand in the usual way in Project -> Properties -> Relations.
Please refer to the QGIS documentation for how to setup [relations](https://docs.qgis.org/testing/en/docs/user_manual/working_with_vector/attribute_table.html#vector-relations) or [polymorphic relations](https://docs.qgis.org/testing/en/docs/user_manual/working_with_vector/attribute_table.html#introducing-polymorphic-relations).

### Document side

Expand Down Expand Up @@ -43,8 +43,8 @@ Set to *Document relation editor (Feature side)*

#### Widget configuration

* **Document path:** An expression to the default path for documents.
* **Document filename:** The field containing the document filename.
* **Documents default path:** An expression to the default path for documents. This is in most cases the same expression as for the attachment widget's default path in the documents table attribute form. For example `@project_folder || '/Documents'`
* **Documents path field name:** The name of the field containing the filename in the documents table.
* **Document author:** An expression for the author of the document.


Expand Down
Binary file modified docs/images/ConfigurationFeatureSideScreenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,18 @@
</property>
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="2">
<widget class="QgsFieldExpressionWidget" name="mDocumentsPathExpressionWidget" native="true"/>
<widget class="QgsFieldExpressionWidget" name="mDocumentsPathExpressionWidget" native="true">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-family:'Noto Serif','ui-serif','serif'; font-size:16px; color:#363c42; background-color:#ffffff;&quot;&gt;An expression to the default path for documents. This is in most cases the same expression as for the attachment widget’s default path in the documents table attribute form.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
</widget>
</item>
<item row="1" column="2">
<widget class="QgsFieldExpressionWidget" name="mDocumentFilenameExpressionWidget" native="true"/>
<widget class="QgsFieldExpressionWidget" name="mDocumentFilenameExpressionWidget" native="true">
<property name="toolTip">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;The name of the field containing the filename in the documents table&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
</widget>
</item>
<item row="2" column="2">
<widget class="QgsFieldExpressionWidget" name="mDocumentAuthorExpressionWidget" native="true"/>
Expand All @@ -33,7 +41,7 @@
<item row="0" column="0" colspan="2">
<widget class="QLabel" name="label_2">
<property name="text">
<string>Documents path</string>
<string>Documents default path</string>
</property>
</widget>
</item>
Expand All @@ -53,7 +61,7 @@
<item row="1" column="0">
<widget class="QLabel" name="label">
<property name="text">
<string>Document filename</string>
<string>Documents path field name</string>
</property>
</widget>
</item>
Expand Down

0 comments on commit 08f9944

Please sign in to comment.