Skip to content

Commit fce4891

Browse files
DelazJDelazJ
committed
Moving "Storing and fetching an external resource" out of attribute table page
to "Connecting and Editing Data Across Layers"
1 parent df628da commit fce4891

File tree

2 files changed

+100
-100
lines changed

2 files changed

+100
-100
lines changed

‎docs/user_manual/working_with_vector/attribute_table.rst

-100
Original file line numberDiff line numberDiff line change
@@ -742,102 +742,6 @@ Under the :guilabel:`Feature` column, panel will display following information:
742742
related child feature.
743743

744744

745-
.. index:: External Storage, WebDAV
746-
.. _external_storage:
747-
748-
Storing and fetching an external resource
749-
==========================================
750-
751-
A field may target a resource stored on an external storage system. Attribute forms can be configured
752-
so they act as a client to an external storage system in order to store and fetch those resources, on
753-
users demand, directly from the forms.
754-
755-
.. _external_storage_configuration:
756-
757-
Configuring an external storage
758-
-------------------------------
759-
760-
In order to setup an external storage, you have to first configure it from the vector
761-
:ref:`attribute form properties <edit_widgets>` and select the :guilabel:`Attachment` widget.
762-
763-
.. _figure_external_storage_configuration:
764-
765-
.. figure:: img/external_storage_configuration.png
766-
:align: center
767-
768-
Editing a WebDAV external storage for a given field
769-
770-
From the :guilabel:`Attachment` widget, you have to first select the :guilabel:`Storage type`:
771-
772-
* :guilabel:`Select Existing File`: The target URL already exists. When
773-
you select a resource, no store operation is achieved, the attribute is simply updated with the URL.
774-
775-
* :guilabel:`Simple Copy`: Stores a copy of the resource on a file disk destination
776-
(which could be a local or network shared file system) and the attribute is updated with the path to
777-
the copy.
778-
779-
* :guilabel:`WebDAV Storage`: The resource is pushed to a HTTP server supporting the
780-
`WebDAV <https://en.wikipedia.org/wiki/WebDAV>`_ protocol and the attribute is updated with
781-
its URL. `Nextcloud <https://nextcloud.com/>`_, `Pydio <https://pydio.com>`_
782-
or other file hosting software support this protocol.
783-
784-
* :guilabel:`AWS S3`: The resource is pushed to a server supporting
785-
`AWS Simple Storage Service <https://en.wikipedia.org/wiki/Amazon_S3>`_ protocol and the attribute is
786-
updated with its URL. Amazon Web Service and `MinIO <https://en.wikipedia.org/wiki/MinIO>`_ hosting software
787-
support this protocol.
788-
789-
Then, you have to set up the :guilabel:`Store URL` parameter, which provides the URL to be used when a new
790-
resource needs to be stored. It's possible to set up an expression using the
791-
:ref:`data defined override widget <data_defined>` in order to have specific values according to
792-
feature attributes.
793-
794-
The variable **@selected_file_path** could be used in that expression and represent the absolute
795-
file path of the user selected file (using the file selector or drag'n drop).
796-
797-
.. note::
798-
799-
Using the **WebDAV** or **AWS S3** external storage, if the URL ends with a "/", it is considered as a folder and
800-
the selected file name will be appended to get the final URL.
801-
802-
803-
If the external storage system needs to, it's possible to configure an
804-
:ref:`authentication <authentication>`.
805-
806-
.. note::
807-
808-
To use the **AWS S3** external storage, you must use an **AWS S3** authentication type.
809-
810-
.. _external_storage_use:
811-
812-
Using an external storage
813-
-------------------------
814-
815-
Once configured, you can select a local file using the button :guilabel:`...` when editing a feature's attribute.
816-
Depending on the configured :ref:`storage type <external_storage_configuration>`, the file
817-
will be stored on the external storage system (except if :guilabel:`Select existing file` has been
818-
selected) and the field will be updated with the new resource URL.
819-
820-
.. _figure_external_storage_store:
821-
822-
.. figure:: img/external_storage_store.png
823-
:align: center
824-
825-
Storing a file to a WebDAV external storage
826-
827-
.. note::
828-
829-
User can also achieve the same result if he drags and drops a file on the whole attachment
830-
widget.
831-
832-
Use the |taskCancel| :sup:`Cancel` button to abort the storing process.
833-
It's possible to configure a viewer using the :guilabel:`Integrated document viewer`
834-
so the resource will be automatically fetched from the external storage system and
835-
displayed directly below the URL.
836-
The above |warning| icon indicates that the resource cannot be fetched
837-
from the external storage system. In that case, more details might appear in the
838-
:ref:`log_message_panel`.
839-
840-
841745
.. Substitutions definitions - AVOID EDITING PAST THIS LINE
842746
This will be automatically updated by the find_set_subst.py script.
843747
If you need to create a new substitution manually,
@@ -928,14 +832,10 @@ from the external storage system. In that case, more details might appear in the
928832
:width: 1.5em
929833
.. |sort| image:: /static/common/sort.png
930834
:width: 1.5em
931-
.. |taskCancel| image:: /static/common/mTaskCancel.png
932-
:width: 1.5em
933835
.. |toggleEditing| image:: /static/common/mActionToggleEditing.png
934836
:width: 1.5em
935837
.. |undo| image:: /static/common/mActionUndo.png
936838
:width: 1.5em
937-
.. |warning| image:: /static/common/mIconWarning.png
938-
:width: 1.5em
939839
.. |zoomTo| image:: /static/common/mActionZoomTo.png
940840
:width: 1.5em
941841
.. |zoomToSelected| image:: /static/common/mActionZoomToSelected.png

‎docs/user_manual/working_with_vector/joins_relations.rst

+100
Original file line numberDiff line numberDiff line change
@@ -659,6 +659,102 @@ The example above uses the following database schema:
659659
);
660660
661661
662+
.. index:: External Storage, WebDAV
663+
.. _external_storage:
664+
665+
Storing and fetching an external resource
666+
==========================================
667+
668+
A field may target a resource stored on an external storage system. Attribute forms can be configured
669+
so they act as a client to an external storage system in order to store and fetch those resources, on
670+
users demand, directly from the forms.
671+
672+
.. _external_storage_configuration:
673+
674+
Configuring an external storage
675+
-------------------------------
676+
677+
In order to setup an external storage, you have to first configure it from the vector
678+
:ref:`attribute form properties <edit_widgets>` and select the :guilabel:`Attachment` widget.
679+
680+
.. _figure_external_storage_configuration:
681+
682+
.. figure:: img/external_storage_configuration.png
683+
:align: center
684+
685+
Editing a WebDAV external storage for a given field
686+
687+
From the :guilabel:`Attachment` widget, you have to first select the :guilabel:`Storage type`:
688+
689+
* :guilabel:`Select Existing File`: The target URL already exists. When
690+
you select a resource, no store operation is achieved, the attribute is simply updated with the URL.
691+
692+
* :guilabel:`Simple Copy`: Stores a copy of the resource on a file disk destination
693+
(which could be a local or network shared file system) and the attribute is updated with the path to
694+
the copy.
695+
696+
* :guilabel:`WebDAV Storage`: The resource is pushed to a HTTP server supporting the
697+
`WebDAV <https://en.wikipedia.org/wiki/WebDAV>`_ protocol and the attribute is updated with
698+
its URL. `Nextcloud <https://nextcloud.com/>`_, `Pydio <https://pydio.com>`_
699+
or other file hosting software support this protocol.
700+
701+
* :guilabel:`AWS S3`: The resource is pushed to a server supporting
702+
`AWS Simple Storage Service <https://en.wikipedia.org/wiki/Amazon_S3>`_ protocol and the attribute is
703+
updated with its URL. Amazon Web Service and `MinIO <https://en.wikipedia.org/wiki/MinIO>`_ hosting software
704+
support this protocol.
705+
706+
Then, you have to set up the :guilabel:`Store URL` parameter, which provides the URL to be used when a new
707+
resource needs to be stored. It's possible to set up an expression using the
708+
:ref:`data defined override widget <data_defined>` in order to have specific values according to
709+
feature attributes.
710+
711+
The variable **@selected_file_path** could be used in that expression and represent the absolute
712+
file path of the user selected file (using the file selector or drag'n drop).
713+
714+
.. note::
715+
716+
Using the **WebDAV** or **AWS S3** external storage, if the URL ends with a "/", it is considered as a folder and
717+
the selected file name will be appended to get the final URL.
718+
719+
720+
If the external storage system needs to, it's possible to configure an
721+
:ref:`authentication <authentication>`.
722+
723+
.. note::
724+
725+
To use the **AWS S3** external storage, you must use an **AWS S3** authentication type.
726+
727+
.. _external_storage_use:
728+
729+
Using an external storage
730+
-------------------------
731+
732+
Once configured, you can select a local file using the button :guilabel:`...` when editing a feature's attribute.
733+
Depending on the configured :ref:`storage type <external_storage_configuration>`, the file
734+
will be stored on the external storage system (except if :guilabel:`Select existing file` has been
735+
selected) and the field will be updated with the new resource URL.
736+
737+
.. _figure_external_storage_store:
738+
739+
.. figure:: img/external_storage_store.png
740+
:align: center
741+
742+
Storing a file to a WebDAV external storage
743+
744+
.. note::
745+
746+
User can also achieve the same result if he drags and drops a file on the whole attachment
747+
widget.
748+
749+
Use the |taskCancel| :sup:`Cancel` button to abort the storing process.
750+
It's possible to configure a viewer using the :guilabel:`Integrated document viewer`
751+
so the resource will be automatically fetched from the external storage system and
752+
displayed directly below the URL.
753+
The above |warning| icon indicates that the resource cannot be fetched
754+
from the external storage system. In that case, more details might appear in the
755+
:ref:`log_message_panel`.
756+
757+
662758
.. Substitutions definitions - AVOID EDITING PAST THIS LINE
663759
This will be automatically updated by the find_set_subst.py script.
664760
If you need to create a new substitution manually,
@@ -699,11 +795,15 @@ The example above uses the following database schema:
699795
:width: 1.5em
700796
.. |symbologyRemove| image:: /static/common/symbologyRemove.png
701797
:width: 1.5em
798+
.. |taskCancel| image:: /static/common/mTaskCancel.png
799+
:width: 1.5em
702800
.. |toggleEditing| image:: /static/common/mActionToggleEditing.png
703801
:width: 1.5em
704802
.. |unchecked| image:: /static/common/unchecked.png
705803
:width: 1.3em
706804
.. |unlink| image:: /static/common/mActionUnlink.png
707805
:width: 1.5em
806+
.. |warning| image:: /static/common/mIconWarning.png
807+
:width: 1.5em
708808
.. |zoomToSelected| image:: /static/common/mActionZoomToSelected.png
709809
:width: 1.5em

0 commit comments

Comments
 (0)