refs nexusformat#270: consistency police, tested on Windows OK

PeterC-DLS · Apr 26, 2016 · e1ad143 · e1ad143
1 parent d528106
commit e1ad143
Show file tree

Hide file tree

Showing 31 changed files with 163 additions and 162 deletions.
diff --git a/base_classes/NXattenuator.nxdl.xml b/base_classes/NXattenuator.nxdl.xml
@@ -33,7 +33,7 @@
     >
 
     <doc>
-        Description of a device that reduces the intensity of a beam by attenuation.
+        Template of a device that reduces the intensity of a beam by attenuation.
 
         If uncertain whether to use :ref:`NXfilter` (band-pass filter)
         or :ref:`NXattenuator` (reduces beam intensity), then choose 

diff --git a/base_classes/NXbeam_stop.nxdl.xml b/base_classes/NXbeam_stop.nxdl.xml
@@ -29,10 +29,10 @@
     type="group" extends="NXobject">
 
     <doc>
-    Description of a device that blocks the beam completely, usually to protect a detector. 
+        Template of a device that blocks the beam completely, usually to protect a detector. 
 
-    Beamstops and their positions are important for SANS
-    and SAXS experiments.
+        Beamstops and their positions are important for SANS
+        and SAXS experiments.
     </doc>
     <group type="NXgeometry">
         <doc>engineering shape, orientation and position of the beam stop.</doc>

diff --git a/base_classes/NXbending_magnet.nxdl.xml b/base_classes/NXbending_magnet.nxdl.xml
@@ -28,8 +28,8 @@
     version="1.0"
 	type="group" extends="NXobject">
 
-	<doc>description for a bending magnet</doc>
-	<field name="critical_energy" type="NX_FLOAT" units="NX_ENERGY"/>
+  <doc>Template for a bending magnet</doc>
+  <field name="critical_energy" type="NX_FLOAT" units="NX_ENERGY"/>
   <field name="bending_radius" type="NX_FLOAT" units="NX_LENGTH"/>
   <field name="magnetic_field" type="NX_FLOAT" units="NX_CURRENT">
     <doc>strength of magnetic field of dipole magnets</doc>

diff --git a/base_classes/NXcapillary.nxdl.xml b/base_classes/NXcapillary.nxdl.xml
@@ -29,10 +29,10 @@
     type="group" extends="NXobject">
 
     <doc>
-      Description of a capillary lens to focus the X-ray beam.
+      Template of a capillary lens to focus the X-ray beam.
 
       Based on information provided by Gerd Wellenreuther (DESY).
-      </doc>
+    </doc>
     <field name="type" type="NX_CHAR">
         <doc>Type of the capillary</doc>
         <enumeration>

diff --git a/base_classes/NXcite.nxdl.xml b/base_classes/NXcite.nxdl.xml
@@ -27,7 +27,7 @@
 	xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
 	version="1.0">
 	<doc>
-		description of a literature citation
+		Template of a literature citation
 
 		Definition to include references for example for detectors,
 		manuals, instruments, acquisition or analysis software used.

diff --git a/base_classes/NXdetector_group.nxdl.xml b/base_classes/NXdetector_group.nxdl.xml
@@ -28,7 +28,7 @@
     version="1.0"
 	type="group" extends="NXobject">
 	<doc>
-		Description of a logical grouping of detector elements.
+		Template of a logical grouping of detector elements.
 
 		This class is used to allow a logical
 		grouping of detector elements (e.g. which tube, bank or group of banks) to be

diff --git a/base_classes/NXdetector_module.nxdl.xml b/base_classes/NXdetector_module.nxdl.xml
@@ -30,7 +30,7 @@
 	version="1.0" 
 	type="group" extends="NXobject">
 	<doc>
-		This is the description of a detector module. 
+		Template of a detector module. 
 
 		Many detectors consist of multiple
 		smaller modules. Sometimes it is important to know the exact position of such

diff --git a/base_classes/NXdisk_chopper.nxdl.xml b/base_classes/NXdisk_chopper.nxdl.xml
@@ -29,7 +29,7 @@
 	type="group" extends="NXobject">
 
 	<doc>
-		Description of a device that blocks the beam beam in a continuous, periodic pattern.
+		Template of a device that blocks the beam beam in a continuous, periodic pattern.
 
 		TODO: need documentation
 	</doc>

diff --git a/base_classes/NXenvironment.nxdl.xml b/base_classes/NXenvironment.nxdl.xml
@@ -27,7 +27,7 @@
     name="NXenvironment" 
     version="1.0"
 	type="group" extends="NXobject">
-	<doc>This class describes an external condition applied to the sample</doc>
+    <doc>Template of an external condition applied to the sample</doc>
     <field name="name">
         <doc>Apparatus identification code/model number; e.g. OC100 011</doc>
     </field>

diff --git a/base_classes/NXfermi_chopper.nxdl.xml b/base_classes/NXfermi_chopper.nxdl.xml
@@ -27,7 +27,7 @@
 	name="NXfermi_chopper" 
 	version="1.0"
 	type="group" extends="NXobject">
-	<doc>Description of a Fermi chopper, possibly with curved slits.</doc>
+	<doc>Template of a Fermi chopper, possibly with curved slits.</doc>
 	<field name="type">
 		<doc>Fermi chopper type</doc>
 	</field>

diff --git a/base_classes/NXfresnel_zone_plate.nxdl.xml b/base_classes/NXfresnel_zone_plate.nxdl.xml
@@ -29,7 +29,7 @@
    xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
 >
 
-	<doc>description for a fresnel zone plate</doc>
+	<doc>Template of a fresnel zone plate</doc>
   <field name="focus_parameters" type="NX_FLOAT">
    <doc>
 	list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,

diff --git a/base_classes/NXgrating.nxdl.xml b/base_classes/NXgrating.nxdl.xml
@@ -1,78 +1,78 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl" ?>
-<!--
-# NeXus - Neutron and X-ray Common Data Format
-# 
-# Copyright (C) 2014-2016 NeXus International Advisory Committee (NIAC)
-# 
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
-# For further information, see http://www.nexusformat.org
--->
-<definition name="NXgrating" type="group" extends="NXobject"
-  category="base"
-  version="1.0"
-  xmlns="http://definition.nexusformat.org/nxdl/3.1"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
-  >
-
-	<doc>Description for a diffraction grating, as could be used in a soft X-ray monochromator</doc>
-	<field name="angles" type="NX_FLOAT" units="NX_ANGLE">
-		<doc>Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.</doc>
-		<dimensions rank="1">
-			<dim index="1" value="2" />
-		</dimensions>
-	</field>
-	<field name="period" type="NX_FLOAT" units="NX_LENGTH">
-		<doc>List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).</doc>
-		<dimensions rank="1"/>
-	</field>
-	<field name="duty_cycle" type="NX_FLOAT" units="NX_UNITLESS"/>
-	<field name="depth" type="NX_FLOAT" units="NX_LENGTH"/>
-	<field name="diffraction_order" type="NX_INT" units="NX_UNITLESS"/>
-	<field name="deflection_angle" type="NX_FLOAT" units="NX_ANGLE">
-		<doc>Angle between the incident beam and the utilised outgoing beam.</doc>
-	</field>
-	<field name="interior_atmosphere">
-		<enumeration>
-			<item value="vacuum"/>
-			<item value="helium"/>
-			<item value="argon"/>
-		</enumeration>
-	</field>
-	<field name="substrate_material">
-		<doc></doc>
-	</field>
-	<field name="substrate_density" type="NX_FLOAT" units="NX_MASS_DENSITY">
-		<doc></doc>
-	</field>
-	<field name="substrate_thickness" type="NX_FLOAT" units="NX_LENGTH">
-		<doc></doc>
-	</field>
-	<field name="coating_material"/>
-	<field name="substrate_roughness" type="NX_FLOAT" units="NX_LENGTH"/>
- <field name="coating_roughness" type="NX_FLOAT" units="NX_LENGTH"/>
- <field name="layer_thickness" type="NX_FLOAT" units="NX_LENGTH">
-	  <doc> An array describing the thickness of each layer</doc>
-	</field>
-	<group type="NXshape" name="shape">
-		<doc>A NXshape group describing the shape of the mirror</doc>
-	</group>
-	<group name="figure_data" type="NXdata">
-		<doc>Numerical description of the surface figure of the mirror.</doc>
-	</group>
-	<group type="NXtransformations"><doc>"Engineering" position of the grating</doc></group>
-</definition>
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl" ?>
+<!--
+# NeXus - Neutron and X-ray Common Data Format
+# 
+# Copyright (C) 2014-2016 NeXus International Advisory Committee (NIAC)
+# 
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# For further information, see http://www.nexusformat.org
+-->
+<definition name="NXgrating" type="group" extends="NXobject"
+  category="base"
+  version="1.0"
+  xmlns="http://definition.nexusformat.org/nxdl/3.1"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
+  >
+
+	<doc>Template of a diffraction grating, as could be used in a soft X-ray monochromator</doc>
+	<field name="angles" type="NX_FLOAT" units="NX_ANGLE">
+		<doc>Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.</doc>
+		<dimensions rank="1">
+			<dim index="1" value="2" />
+		</dimensions>
+	</field>
+	<field name="period" type="NX_FLOAT" units="NX_LENGTH">
+		<doc>List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).</doc>
+		<dimensions rank="1"/>
+	</field>
+	<field name="duty_cycle" type="NX_FLOAT" units="NX_UNITLESS"/>
+	<field name="depth" type="NX_FLOAT" units="NX_LENGTH"/>
+	<field name="diffraction_order" type="NX_INT" units="NX_UNITLESS"/>
+	<field name="deflection_angle" type="NX_FLOAT" units="NX_ANGLE">
+		<doc>Angle between the incident beam and the utilised outgoing beam.</doc>
+	</field>
+	<field name="interior_atmosphere">
+		<enumeration>
+			<item value="vacuum"/>
+			<item value="helium"/>
+			<item value="argon"/>
+		</enumeration>
+	</field>
+	<field name="substrate_material">
+		<doc></doc>
+	</field>
+	<field name="substrate_density" type="NX_FLOAT" units="NX_MASS_DENSITY">
+		<doc></doc>
+	</field>
+	<field name="substrate_thickness" type="NX_FLOAT" units="NX_LENGTH">
+		<doc></doc>
+	</field>
+	<field name="coating_material"/>
+	<field name="substrate_roughness" type="NX_FLOAT" units="NX_LENGTH"/>
+ <field name="coating_roughness" type="NX_FLOAT" units="NX_LENGTH"/>
+ <field name="layer_thickness" type="NX_FLOAT" units="NX_LENGTH">
+	  <doc> An array describing the thickness of each layer</doc>
+	</field>
+	<group type="NXshape" name="shape">
+		<doc>A NXshape group describing the shape of the mirror</doc>
+	</group>
+	<group name="figure_data" type="NXdata">
+		<doc>Numerical description of the surface figure of the mirror.</doc>
+	</group>
+	<group type="NXtransformations"><doc>"Engineering" position of the grating</doc></group>
+</definition>
diff --git a/base_classes/NXguide.nxdl.xml b/base_classes/NXguide.nxdl.xml
@@ -37,32 +37,32 @@
     </symbols>
 
     <doc>
-            Description of a (neutron) optical element to direct the path of the beam.
-            
-            :ref:`NXguide` is used by neutron instruments to describe
-            a guide consists of several mirrors building a shape through which 
-            neutrons can be guided or directed. The simplest such form is box shaped
-            although elliptical guides are gaining in popularity. 
-            The individual parts of a guide usually have common characteristics 
-            but there are cases where they are different.
-            For example,  a neutron guide might consist of 2 or 4 coated walls or
-            a supermirror bender with multiple, coated vanes.
+        Template of a (neutron) optical element to direct the path of the beam.
+
+        :ref:`NXguide` is used by neutron instruments to describe
+        a guide consists of several mirrors building a shape through which 
+        neutrons can be guided or directed. The simplest such form is box shaped
+        although elliptical guides are gaining in popularity. 
+        The individual parts of a guide usually have common characteristics 
+        but there are cases where they are different.
+        For example,  a neutron guide might consist of 2 or 4 coated walls or
+        a supermirror bender with multiple, coated vanes.
 
-            To describe polarizing supermirrors such as used in neutron reflection,
-            it may be necessary to revise this definition of :ref:`NXguide`
-            to include :ref:`NXpolarizer` and/or :ref:`NXmirror`.
+        To describe polarizing supermirrors such as used in neutron reflection,
+        it may be necessary to revise this definition of :ref:`NXguide`
+        to include :ref:`NXpolarizer` and/or :ref:`NXmirror`.
 
-            When even greater complexity exists in the definition of what
-            constitutes a *guide*,  it has been suggested that :ref:`NXguide` 
-            be redefined as a :ref:`NXcollection` of :ref:`NXmirror` each 
-            having their own :ref:`NXgeometry` describing their location(s).
+        When even greater complexity exists in the definition of what
+        constitutes a *guide*,  it has been suggested that :ref:`NXguide` 
+        be redefined as a :ref:`NXcollection` of :ref:`NXmirror` each 
+        having their own :ref:`NXgeometry` describing their location(s).
 
-            For the more general case when describing mirrors, consider using 
-            :ref:`NXmirror`.
+        For the more general case when describing mirrors, consider using 
+        :ref:`NXmirror`.
 
-            NOTE: The NeXus International Advisory Committee welcomes 
-            comments for revision and improvement of 
-            this definition of :ref:`NXguide`.
+        NOTE: The NeXus International Advisory Committee welcomes 
+        comments for revision and improvement of 
+        this definition of :ref:`NXguide`.
 
     </doc>
 

diff --git a/base_classes/NXinsertion_device.nxdl.xml b/base_classes/NXinsertion_device.nxdl.xml
@@ -27,7 +27,7 @@
     name="NXinsertion_device" 
     version="1.0"
 	type="group" extends="NXobject">
-    <doc>Description of an insertion device, as in a synchrotron.</doc>
+    <doc>Template of an insertion device, as in a synchrotron.</doc>
     <field name="type">
         <enumeration>
             <item value="undulator"/>

diff --git a/base_classes/NXinstrument.nxdl.xml b/base_classes/NXinstrument.nxdl.xml
@@ -28,7 +28,7 @@
 	version="1.0"
     type="group" extends="NXobject">
 	<doc>
-		Description of the components of the instrument used for the measurement.
+		Template of the components of the instrument used for the measurement.
 
 		Template of instrument descriptions comprising various beamline components. 
 		Each component will also be a NeXus group defined by its distance from the 

diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml
@@ -32,20 +32,20 @@
 	xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
     >
     <doc>
-        Description of information recorded as a function of time.
-        
-        Description of information that is recorded against time, 
-        such as information monitored during the run. 
-        It contains
-        the logged values and the times at which they were measured as elapsed time since a starting
-        time recorded in ISO8601 format. This method of storing logged data helps to distinguish
-        instances in which a variable is a dimension scale of the data, in which case it is stored
-        in an :ref:`NXdata` group, and instances in which it is logged during the 
-        run, when it should be stored in an :ref:`NXlog` group.
-        Note: When using multiple :ref:`NXlog` groups, it is suggested to place 
-        them inside a :ref:`NXcollection` group.  In such cases, when
-        :ref:`NXlog` is used in another class,
-        :ref:`NXcollection`/:ref:`NXlog`  is then constructed.
+		Template of information recorded as a function of time.
+		
+		Description of information that is recorded against time, 
+		such as information monitored during the run. 
+		It contains
+		the logged values and the times at which they were measured as elapsed time since a starting
+		time recorded in ISO8601 format. This method of storing logged data helps to distinguish
+		instances in which a variable is a dimension scale of the data, in which case it is stored
+		in an :ref:`NXdata` group, and instances in which it is logged during the 
+		run, when it should be stored in an :ref:`NXlog` group.
+		Note: When using multiple :ref:`NXlog` groups, it is suggested to place 
+		them inside a :ref:`NXcollection` group.  In such cases, when
+		:ref:`NXlog` is used in another class,
+		:ref:`NXcollection`/:ref:`NXlog` is then constructed.
     </doc>
 	<field name="time" type="NX_FLOAT" units="NX_TIME">
 		<doc>

diff --git a/base_classes/NXmoderator.nxdl.xml b/base_classes/NXmoderator.nxdl.xml
@@ -27,7 +27,7 @@
     name="NXmoderator" 
     version="1.0"
 	type="group" extends="NXobject">
-    <doc>This is the description for a general moderator</doc>
+    <doc>Template for a general moderator</doc>
     <group type="NXgeometry">
         <doc>"Engineering" position of moderator</doc>
     </group>

diff --git a/base_classes/NXmonitor.nxdl.xml b/base_classes/NXmonitor.nxdl.xml
@@ -28,7 +28,7 @@
     version="1.0"
     type="group" extends="NXobject">
     <doc>
-        Description of monitor (incident beam) data. 
+        Template of monitor (incident beam) data. 
 
         It is similar to the :ref:`NXdata` groups containing
         monitor data and its associated dimension scale, e.g. time_of_flight or