diff --git a/docs/_images/workflow-connections.png b/docs/_images/workflow-connections.png new file mode 100644 index 0000000..125ccae Binary files /dev/null and b/docs/_images/workflow-connections.png differ diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 0000000..545da60 --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,16 @@ +.. _mcp-file-location-sink-configuration: + +Configuration +------------- + +This step is used for saving a file to the local disk outside the workflow directory. +This step uses a *http://physiomeproject.org/workflow/1.0/rdf-schema#file_location* to define the location where the file is saved. +To set the location to save the file to use the *...* button to open a file chooser dialog. +The *File* input is used to hold the relative path from the workflow to the output file location. + +.. _fig-mcp-file-location-sink-configure-dialog: + +.. figure:: _images/step-configuration-dialog.png + :alt: Step configure dialog + + *File Location Sink* step configuration dialog. diff --git a/docs/index.rst b/docs/index.rst index 094d54c..66bd519 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,35 +1,23 @@ -MAP Client Plugin - File Location Sink -====================================== +File Location Sink +================== -The **File Location Sink** is MAP Client plugin for saving a file to a location outside the workflow. - -.. _fig-mcp-file-location-sink-un-configured-step: - -.. figure:: _images/un-configured-step.png - :alt: Un-configured step icon - - An un-configured *File Location Sink* step icon. +Overview +-------- -Configure ---------- - -This step is used for saving a file to the local disk outside the workflow directory. -This step uses a *http://physiomeproject.org/workflow/1.0/rdf-schema#file_location* to define the location where the file is saved. -To set the location to save the file to use the *...* button to open a file chooser dialog. -The *File* input is used to hold the relative path from the workflow to the output file location. - -.. _fig-mcp-file-location-sink-configure-dialog: +The **File Location Sink** is MAP Client plugin for saving a file to a location outside the workflow. -.. figure:: _images/step-configuration-dialog.png - :alt: Step configure dialog +Specification +------------- - *File Location Sink* step configuration dialog. +Information on this plugins' specification is available :ref:`here `. -Ports ------ +Configuration +------------- -This plugin: +Information on this plugins' configuration is available :ref:`here `. -* **uses**: +Instructions +------------ - * *http://physiomeproject.org/workflow/1.0/rdf-schema#file_location* +This is a non-interactive step. +See `Configuration`_. diff --git a/docs/specification.rst b/docs/specification.rst new file mode 100644 index 0000000..cdb134c --- /dev/null +++ b/docs/specification.rst @@ -0,0 +1,10 @@ +.. _mcp-file-location-sink-specification: + +Ports +----- + +This plugin: + +uses: + + * *http://physiomeproject.org/workflow/1.0/rdf-schema#file_location*