Update documentation extracted from schema

FDSN · Aug 22, 2020 · 721341a · 721341a
1 parent 7784bb5
commit 721341a
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 38 deletions.
diff --git a/docs/level-channel.rst b/docs/level-channel.rst
@@ -447,7 +447,7 @@
 
    .. container:: description
 
-      Telephone phonenumber.
+      Telephone number.
 
    .. container:: example
 
@@ -874,7 +874,7 @@
 
    .. container:: description
 
-      Elevation of the water surface in meters for underwater sites, where 0 is sea level. If you put an OBS on a lake bottom, where the lake surface is at elevation=0, then you should set WaterLevel=0.
+      Elevation of the water surface in meters for underwater sites, where 0 is mean sea level. If you put an OBS on a lake bottom, where the lake surface is at elevation=0, then you should set WaterLevel=0.
 
 .. tabularcolumns::|l|l|l|1|1| 
 
@@ -1368,7 +1368,7 @@
 
    .. container:: description
 
-      Installation date of equipment.
+      Date this equipment was installed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1395,7 +1395,7 @@
 
    .. container:: description
 
-      Removal date of equipment.
+      Date this equipment was removed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1422,7 +1422,7 @@
 
    .. container:: description
 
-      A description of the units of the calibration.
+      Date this equipment was calibrated.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1638,7 +1638,7 @@
 
    .. container:: description
 
-      Installation date of equipment.
+      Date this equipment was installed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1665,7 +1665,7 @@
 
    .. container:: description
 
-      Removal date of equipment.
+      Date this equipment was removed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1692,7 +1692,7 @@
 
    .. container:: description
 
-      A description of the units of the calibration.
+      Date this equipment was calibrated.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1908,7 +1908,7 @@
 
    .. container:: description
 
-      Installation date of equipment.
+      Date this equipment was installed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1935,7 +1935,7 @@
 
    .. container:: description
 
-      Removal date of equipment.
+      Date this equipment was removed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1962,7 +1962,7 @@
 
    .. container:: description
 
-      A description of the units of the calibration.
+      Date this equipment was calibrated.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -2178,7 +2178,7 @@
 
    .. container:: description
 
-      Installation date of equipment.
+      Date this equipment was installed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -2205,7 +2205,7 @@
 
    .. container:: description
 
-      Removal date of equipment.
+      Date this equipment was removed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -2232,5 +2232,5 @@
 
    .. container:: description
 
-      A description of the units of the calibration.
+      Date this equipment was calibrated.
 
diff --git a/docs/level-network.rst b/docs/level-network.rst
@@ -15,7 +15,7 @@
 
    .. container:: description
 
-      The Network container. All station metadata for this network is contained within this element. A Description element may be included with the official network name and other descriptive information. An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation. A Comment element may be included for arbitrary comments.
+      The Network container. All station metadata for this network is contained within this element. A Description element may be included with the official network name and other descriptive information. An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation. A Comment element may be included for additional comments.
 
    .. container:: example
 
@@ -450,7 +450,7 @@
 
    .. container:: description
 
-      Telephone phonenumber.
+      Telephone number.
 
    .. container:: example
 
@@ -803,7 +803,7 @@
 
    .. container:: description
 
-      Telephone phonenumber.
+      Telephone number.
 
    .. container:: example
 

diff --git a/docs/level-preamble.rst b/docs/level-preamble.rst
@@ -25,7 +25,7 @@
       :header: "attribute", "type", "required", "description", "example"
       :widths: auto
 
-      **schemaVersion**, :ref:`decimal<type-glossary>`, :red:`yes`, "The schema version compatible with the document.", "schemaVersion='1.1'" 
+      **schemaVersion**, :ref:`decimal<type-glossary>`, :red:`yes`, "The StationXML schema version of this document.", "schemaVersion='1.1'" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -52,7 +52,7 @@
 
    .. container:: description
 
-      Generator of the information contained in the document.
+      Originator of the information contained in the document.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -79,7 +79,7 @@
 
    .. container:: description
 
-      Name of the institution sending this message.
+      Name of the institution sending this document.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -137,7 +137,7 @@
 
    .. container:: description
 
-      Address of the query that generated the document, or, if applicable, the address of the software that generated this document.
+      Resource identifier of the query that generated the document, or, if applicable, the resource identifier of the software that generated this document.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -164,5 +164,5 @@
 
    .. container:: description
 
-      Creation date of the documentation.
+      Date that this document was generated.
 
diff --git a/docs/level-response.rst b/docs/level-response.rst
@@ -15,7 +15,7 @@
 
    .. container:: description
 
-      The complete instrument response for this channel that expresses the effect of the geophysical instrumentation used to record the input ground motion. The information can be used to convert raw data to Earth at a specified frequency or within a range of frequencies. It is strongly suggested that either InstrumentSensitivity or InstrumentPolynomial should be present.
+      The complete instrument response for this channel that expresses the effect of the geophysical instrumentation used to record the input ground motion. The information can be used to convert raw data to Earth unit measurement at a specified frequency or within a range of frequencies. It is strongly suggested that either InstrumentSensitivity or InstrumentPolynomial should be present.
 
 .. tabularcolumns::|l|l|l|1|1| 
 
@@ -354,7 +354,7 @@
       :widths: auto
 
       **name**, :ref:`string<type-glossary>`, no, "A name given to this filter.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to unique identify this filter or response. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -764,7 +764,7 @@
 
    .. container:: description
 
-      Type for channel response entry or stage. A full response is represented as a sequence of these stages.
+      Type for channel response entry or stage. A full response is represented as an ordered sequence of these stages.
 
 .. tabularcolumns::|l|l|l|1|1| 
 
@@ -775,7 +775,7 @@
       :widths: auto
 
       **number**, :ref:`CounterType<type-glossary>`, :red:`yes`, "Stage sequence number. This is used in all the response blockettes. Start from name='1' and iterate sequentially.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to uniquely identify this response stage. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -803,7 +803,7 @@
       :widths: auto
 
       **name**, :ref:`string<type-glossary>`, no, "A name given to this filter.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to unique identify this filter or response. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1308,7 +1308,7 @@
       :widths: auto
 
       **name**, :ref:`string<type-glossary>`, no, "A name given to this filter.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to unique identify this filter or response. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1612,7 +1612,7 @@
       :widths: auto
 
       **name**, :ref:`string<type-glossary>`, no, "A name given to this filter.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to unique identify this filter or response. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1934,7 +1934,7 @@
       :widths: auto
 
       **name**, :ref:`string<type-glossary>`, no, "A name given to this filter.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to unique identify this filter or response. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -2445,7 +2445,7 @@
       :widths: auto
 
       **name**, :ref:`string<type-glossary>`, no, "A name given to this filter.", "" 
-      **resourceId**, :ref:`string<type-glossary>`, no, "An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
+      **resourceId**, :ref:`string<type-glossary>`, no, "A resource identifier that serves to unique identify this filter or response. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information/be derived from the same base instruments.", "" 
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`

diff --git a/docs/level-station.rst b/docs/level-station.rst
@@ -15,7 +15,7 @@
 
    .. container:: description
 
-      The Station container. All channel metadata for this station is contained within this element. A Description element may be included with the official station name and other descriptive information. An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation or reference. A Comment element may be included for arbitrary comments.
+      The Station container. All channel metadata for this station is contained within this element. A Description element may be included with the official station name and other descriptive information. An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation or reference. A Comment element may be included for additional comments.
 
 .. tabularcolumns::|l|l|l|1|1| 
 
@@ -446,7 +446,7 @@
 
    .. container:: description
 
-      Telephone phonenumber.
+      Telephone number.
 
    .. container:: example
 
@@ -889,7 +889,7 @@
 
    .. container:: description
 
-      Elevation of the water surface (in meters) for underwater sites, where 0 is sea level. If you put an ocean-bottom seismometer (OBS) on a lake bottom, where the lake surface is at elevation=0, then you should set WaterLevel=0.
+      Elevation of the water surface (in meters) for underwater sites, where 0 is mean sea level. If you put an ocean-bottom seismometer (OBS) on a lake bottom, where the lake surface is at elevation=0, then you should set WaterLevel=0.
 
    .. container:: example
 
@@ -1176,7 +1176,7 @@
 
    .. container:: description
 
-      Installation date of equipment.
+      Date this equipment was installed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1203,7 +1203,7 @@
 
    .. container:: description
 
-      Removal date of equipment.
+      Date this equipment was removed.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1230,7 +1230,7 @@
 
    .. container:: description
 
-      A description of the units of the calibration.
+      Date this equipment was calibrated.
 
 
 :raw-latex:`\noindent\rule{\textwidth}{1pt}`
@@ -1504,7 +1504,7 @@
 
    .. container:: description
 
-      Telephone phonenumber.
+      Telephone number.
 
    .. container:: example