Skip to content

Commit

Permalink
Add subsections on ICAT data XML files and on ICAT data YAML files
Browse files Browse the repository at this point in the history
including the example data files, but no other content yet
  • Loading branch information
RKrahl committed Jan 3, 2024
1 parent da2415f commit af0ee8d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions doc/src/file-icatdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,30 @@ indirectly related to one of the included objects. In this case,
only a reference to the related object will be included in the data
file. The related object must have its own entry.

ICAT data XML files
~~~~~~~~~~~~~~~~~~~

In this section we describe the ICAT data file format using the XML
backend.

.. literalinclude:: ../examples/icatdump-simple-1.xml
:language: xml

.. literalinclude:: ../examples/icatdump-simple-2.xml
:language: xml

ICAT data YAML files
~~~~~~~~~~~~~~~~~~~~

In this section we describe the ICAT data file format using the YAML
backend.

.. literalinclude:: ../examples/icatdump-simple-1.yaml
:language: yaml

.. literalinclude:: ../examples/icatdump-simple-2.yaml
:language: yaml


.. [#dc] There is one exception: DataCollections don't have a
uniqueness constraint and can't reliably be searched by
Expand Down

0 comments on commit af0ee8d

Please sign in to comment.