.. _document-metadata:

Filling the Document Metadata
=============================

Metadata contains all the information related to the document: they are its ID card. They provide essential information for its identification and its comprehension. Metadata also make the document more easily retrievable through search by other users.

Editing a document's metadata is done in three steps (*Basic Metadata*, *Location and Licenses*, *Optional Metadata*). The first two steps are mandatory (no documents will be published if the required information are not provided) whereas the last one is optional.

1. On the **Basic Metadata** page, the essential information that has to be filled is:

  * The *Title* of the document, which should be clear and understandable;
  * The *Resources* the document should be linked to;
  * An *Abstract* on the document;
  * The *Creation/Publication/Revision* dates which define the time period that is covered by the document;
  * The *Keywords*, which should be chosen within the available list. The contributor search for available keywords by clicking on the searching bar, or on the folder logo representing, or by entering the first letters of the desired word. Key-words should be relevant to the imported document;
  * The *Category* in which the document belongs;
  * The *Group* to which the document is linked.

  .. figure:: img/document_basic_metadata.png
      :align: center

      *Document Basic Metadata*

  Once all the fields are filled, click on the blue button :guilabel:`Next >>` in the bottom right corner of the page.

  .. note:: When a document is linked to some resources, you can see that link on the *Resource Page*.

    .. figure:: img/documents_linked_to_layer.png
        :align: center
        :width: 500px

        *Documents linked to a Layer*

    It will be also visible on the :ref:`document-info` page.

    .. figure:: img/resources_linked_to_document.png
        :align: center
        :width: 500px

        *Resources linked to a Document*

2. On the **Location and Licenses** page, the following information should be filled:

  * The *Language* of the document;
  * The *Regions*, which informs on the spatial extent covered by the document. Proposed extents cover the following scales: global, continental, regional, national;
  * The *Data Quality statement* (general explanation of the data producer's knowledge about the lineage of a dataset);
  * Potential *Restrictions* to sharing the document should be provided in the Restrictions box.

  .. figure:: img/document_location_licenses.png
      :align: center

      *Document Location and Licenses*

  Click on the blue button :guilabel:`Next >>` to go ahead to the next step.

3. On the **Optional Metadata** page, complementary information can be added:

  * The *Edition* to indicate the reference or the source of the document;
  * The *Purpose* of the document and its objectives;
  * Any *Supplemental information* that can provide a better understanding of the uploaded document;
  * The *Maintenance frequency* of the document;
  * The *Spatial representation type* used.

  *Responsible Parties*, *Owner* and *Permissions* are listed on the right side of the page, you can edit them.

  .. figure:: img/document_optional_metadata.png
      :align: center

      *Document Optional Metadata*

  | If all the mandatory information is filled out the document can be published, if not the ``Completeness`` progress bar warns you that something is missing.
  | Click on the blue button :guilabel:`Update` to save information on the system.