=================
Editing Workflows
=================

------------------------
Generic Editing Workflow
------------------------

.. attention::

  By default all documents are read-only. A new document can only be edited before it is shared. Once it is shared, a document can no longer be edited directly.

.. tip::

  To modify a shared document, you must propose a change to it by creating a new :term:`Variant`. The new Variant can be edited before it is shared. Once shared, a variant also becomes read-only.

  The editor/rapporteur/owner of the document (depending on how rights are configured) can choose to accept the change proposed in the variant (along with other proposals in other variants), merge them into the document and create a new version. See the :ref:`Editing Workflows <06-specification-drafting-workflow:editing workflows>` section for more information.

Create a document
"""""""""""""""""

In order to create a new document refer to the :ref:`Creating a new document <03-workspace:Create a new document>` section.

Enter a title for your document.

Select in the Context field your working group and click on :guilabel:`Create document`.

You then have the document created and you may start editing (refer to the :ref:`Basic Editing Functionality <04-basic-editing:Basic Editing Functionality>` section).

Share a document
""""""""""""""""

When a document is created, it is editable and it is private to the owner (i.e. no one else can view and edit the document).

In order to let delegates view the document, it is necessary that the owner shares the document (|red-one|).

Share a document by clicking on the :guilabel:`Share` button (see |red-one|) and the status of the document changes from 'Private' to 'ForReview'.

.. figure:: _static/share-document.png

Once the document is shared, no more text modifications can be applied (read-only mode) and the docuemtn becomes visible to all delegates.

Now every delegate can search the document and add the document to their workspace.

Create a variant
""""""""""""""""

To modify a shared document, you must propose a change to it by creating a new Variant.

Create a variant by clicking on the button :guilabel:`Create New Variant` (see |red-one|).

.. figure:: _static/create-new-dsd-variant.png

A modal opens, and you can

- enter a title (see |red-one|)

- cancel the action (see |red-two|)

- click on :guilabel:`Create Variant` (see |red-three|)

.. figure:: _static/modal-new-dsd-variant.png

When you click on :guilabel:`Create Variant`, the new variant is created and

- the breadcrumb indicates the path to the Variant: Workspace > Baseline > Variant (see |red-one|)

- the document name remains unchanged (see |red-two|)

- the tab shows the name of the Variant (see |red-three|)

- the variant can be edited by its creator (see |red-four|)

- the variant is private to the owner (see |red-five|)

.. figure:: _static/new-dsd-variant.png

Delete a variant
""""""""""""""""

When you have the baseline opened, then you can see in the right hand pane the variant that you have created.

The figure below shows a baseline which contains a variant with status 'Private' (see |red-one|).

Click on the delete icon (see |red-two|) and the variant will be deleted.

.. image:: _static/simple-delete-variant.png
   :scale: 75 %

.. tip:: You can only delete a variant if you are the owner of this variant and its status is 'Private'.

Merge a variant into a Merge Variant
""""""""""""""""""""""""""""""""""""""""""

When you have the baseline opened, then you can see in the right hand pane the variant that you have created.

.. tip:: When you have created a variant, you can navigate back to the baseline by clicking on the breadcrumb.

The figure below shows a baseline which contains a variant (see |red-one|).

The variant has a title and shows the company name and author name (see |red-two|).

You can click on the :guilabel:`Merge` button (see |red-three|) in order to start the implementation process.

.. figure:: _static/list-of-variant.png

When you have clicked on the :guilabel:`Merge` button then:

- a merging variant tab is created and activated (see |red-one|)

- the content of the variant is merged into the merging variant

- the variant status has changed to 'implemented' (see |red-two|)

- You can see the implemented changes by clicking on the :guilabel:`Show Changes` button (see |red-three|).

.. figure:: _static/merging-variant.png

Promote a Merge Variant to become the new baseline
""""""""""""""""""""""""""""""""""""""""""""""""""

You can click on the :guilabel:`Promote to new version` button (see |red-one|) in order to make the merging variant become the next document version.

.. figure:: _static/promote-merging-variant.png

When you click on the :guilabel:`Promote to new version` button then:

- the status of the document version 0.0.0 changes to 'revised';

- the merging variant becomes the new document with version 0.0.1 (see |red-one|) and status 'For Review' (see |red-two|).
  The modifications, that the variant introduced, are included (see |red-three|).

.. figure:: _static/document-v1.png

.. |red-one| image:: _static/red-one.png
  :height: 25
.. |red-two| image:: _static/red-two.png
  :height: 25
.. |red-three| image:: _static/red-three.png
  :height: 25
.. |red-four| image:: _static/red-four.png
  :height: 25
.. |red-five| image:: _static/red-five.png
  :height: 25