Refs #9583 fix html documentation errors

Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SphericalAbsorption.h

@@ -66,7 +66,7 @@ public:
   /// Algorithm's name
   virtual const std::string name() const { return "SphericalAbsorption"; }
     ///Summary of algorithms purpose
-    virtual const std::string summary() const {return "Calculates bin-by-bin correction factors for attenuation due to absorption and scattering in a 'spherical' sample.";}
+    virtual const std::string summary() const {return "Calculates bin-by-bin or event correction factors for attenuation due to absorption and scattering in a 'spherical' sample.";}
 
   /// Algorithm's version
   virtual int version() const { return (1); }

Code/Mantid/Framework/Algorithms/src/SphericalAbsorption.cpp

@@ -46,11 +46,11 @@ void SphericalAbsorption::init()
   auto mustBePositive = boost::make_shared<BoundedValidator<double> >();
   mustBePositive->setLower(0.0);
   declareProperty("AttenuationXSection", EMPTY_DBL(), mustBePositive,
-    "The '''absorption''' cross-section, at 1.8 Angstroms, for the sample material in barns.");
+    "The '''absorption''' cross-section, at 1.8 Angstroms, for the sample material in barns, if not set with SetSampleMaterial.");
   declareProperty("ScatteringXSection", EMPTY_DBL(), mustBePositive,
-    "The (coherent + incoherent) scattering cross-section for the sample material in barns.");
+    "The (coherent + incoherent) scattering cross-section for the sample material in barns, if not set with SetSampleMaterial.");
   declareProperty("SampleNumberDensity", EMPTY_DBL(), mustBePositive,
-    "TThe number density of the sample in number of atoms per cubic angstrom, if not set with SetSampleMaterial");
+    "The number density of the sample in number of atoms per cubic angstrom, if not set with SetSampleMaterial");
   declareProperty("SphericalSampleRadius", EMPTY_DBL(), mustBePositive,
     "The radius of the spherical sample in centimetres");
 

Code/Mantid/Framework/Algorithms/src/UnwrapSNS.cpp

@@ -68,7 +68,7 @@ void UnwrapSNS::init()
     "Contains numbers counts against time of flight (TOF)." );
   declareProperty(
     new WorkspaceProperty<MatrixWorkspace>("OutputWorkspace","",Direction::Output),
-    "This workspace will be in the [[Units|units]] of time of flight." );
+    "This workspace will be in the units of time of flight. (See http://www.mantidproject.org/Units)" );
 
   auto validator = boost::make_shared<BoundedValidator<double> >();
   validator->setLower(0.01);

Code/Mantid/docs/source/algorithms/AlignDetectors-v1.rst

@@ -14,19 +14,18 @@ during the conversion from time-of-flight to dSpacing as follows:
 
 .. math:: d = \frac{h}{2m_N} \frac{t.o.f.}{L_{tot} sin \theta} (1+ \rm{offset})
 
-The detector offsets can be obtained from either: an
-`OffsetsWorkspace <OffsetsWorkspace>`__ where each pixel has one value,
+The detector offsets can be obtained from either: an OffsetsWorkspace where each pixel has one value,
 the offset; or a .cal file (in the form created by the ARIEL software).
 
 **Note:** the workspace that this algorithms outputs is a `Ragged
-Workspace <Ragged Workspace>`__.
+Workspace <http://www.mantidproject.org/Ragged_Workspace>`__.
 
 Restrictions on the input workspace
 ###################################
 
 The input workspace must contain histogram or event data where the X
 unit is time-of-flight and the Y data is raw counts. The
-`instrument <instrument>`__ associated with the workspace must be fully
+`instrument <http://www.mantidproject.org/instrument>`__ associated with the workspace must be fully
 defined because detector, source & sample position are needed.
 
 .. categories::

Code/Mantid/docs/source/algorithms/ConvertToDiffractionMDWorkspace-v1.rst

@@ -9,9 +9,9 @@
 Description
 -----------
 
-This algorithm converts from a `MatrixWorkspace <MatrixWorkspace>`__ (in
+This algorithm converts from a `MatrixWorkspace <http://mantidproject.org/MatrixWorkspace>`__ (in
 detector/time-of-flight space) to a
-`MDEventWorkspace <MDEventWorkspace>`__ containing events in reciprocal
+`MDEventWorkspace <http://mantidproject.org/MDEventWorkspace>`__ containing events in reciprocal
 space.
 
 The calculations apply only to elastic diffraction experiments. The
@@ -20,7 +20,7 @@ to HKL of the crystal.
 
 If the OutputWorkspace does NOT already exist, a default one is created.
 In order to define more precisely the parameters of the
-`MDEventWorkspace <MDEventWorkspace>`__, use the
+`MDEventWorkspace <http://mantidproject.org/MDEventWorkspace>`__, use the
 :ref:`algm-CreateMDWorkspace` algorithm first.
 
 Types of Conversion
@@ -61,7 +61,7 @@ of the workspace, **including zeros**.
 
 This can be useful in cases where the experimental coverage needs to be
 tracked. With one MDEvent for each bin, you can count which regions in
-Q-space have been measured. The `SliceViewer <SliceViewer>`__ has an
+Q-space have been measured. The `SliceViewer <http://mantidproject.org/SliceViewer>`__ has an
 option to view normalized by number of events. This means that, for
 example, areas with overlap from two runs will appear scaled down.
 
@@ -75,9 +75,9 @@ Also, the :ref:`algm-FindPeaksMD` algorithm may not work optimally
 because it depends partly on higher density of events causing more
 finely split boxes.
 
-If your input is a `Workspace2D <Workspace2D>`__ and you do NOT check
+If your input is a `Workspace2D <http://mantidproject.org/Workspace2D>`__ and you do NOT check
 *OneEventPerBin*, then the workspace is converted to an
-`EventWorkspace <EventWorkspace>`__ but with no events for empty bins.
+`EventWorkspace <http://mantidproject.org/EventWorkspace>`__ but with no events for empty bins.
 
 Performance Notes
 #################

Code/Mantid/docs/source/algorithms/ConvertToDiffractionMDWorkspace-v2.rst

@@ -9,9 +9,9 @@
 Description
 -----------
 
-This algorithm converts from a `MatrixWorkspace <MatrixWorkspace>`__ (in
+This algorithm converts from a `MatrixWorkspace <http://mantidproject.org/MatrixWorkspace>`__ (in
 detector/time-of-flight space) to a
-`MDEventWorkspace <MDEventWorkspace>`__ containing events in reciprocal
+`MDEventWorkspace <http://mantidproject.org/MDEventWorkspace>`__ containing events in reciprocal
 space.
 
 The calculations apply only to elastic diffraction experiments. The
@@ -20,7 +20,7 @@ to HKL of the crystal.
 
 If the OutputWorkspace does NOT already exist, a default one is created.
 In order to define more precisely the parameters of the
-`MDEventWorkspace <MDEventWorkspace>`__, use the
+`MDEventWorkspace <http://mantidproject.org/MDEventWorkspace>`__, use the
 :ref:`algm-CreateMDWorkspace` algorithm first.
 
 Types of Conversion
@@ -61,7 +61,7 @@ of the workspace, **including zeros**.
 
 This can be useful in cases where the experimental coverage needs to be
 tracked. With one MDEvent for each bin, you can count which regions in
-Q-space have been measured. The `SliceViewer <SliceViewer>`__ has an
+Q-space have been measured. The `SliceViewer <http://mantidproject.org/SliceViewer>`__ has an
 option to view normalized by number of events. This means that, for
 example, areas with overlap from two runs will appear scaled down.
 
@@ -75,9 +75,9 @@ Also, the :ref:`algm-FindPeaksMD` algorithm may not work optimally
 because it depends partly on higher density of events causing more
 finely split boxes.
 
-If your input is a `Workspace2D <Workspace2D>`__ and you do NOT check
+If your input is a `Workspace2D <http://mantidproject.org/Workspace2D>`__ and you do NOT check
 *OneEventPerBin*, then the workspace is converted to an
-`EventWorkspace <EventWorkspace>`__ but with no events for empty bins.
+`EventWorkspace <http://mantidproject.org/EventWorkspace>`__ but with no events for empty bins.
 
 Performance Notes
 #################

Code/Mantid/docs/source/algorithms/ConvertUnits-v1.rst

@@ -9,18 +9,18 @@
 Description
 -----------
 
-Changes the units in which the X values of a `workspace <workspace>`__
+Changes the units in which the X values of a `workspace <http://www.mantidproject.org/Workspace>`__
 are represented. The available units are those registered with the `Unit
-Factory <Unit Factory>`__. If the Y data is 'dimensioned' (i.e. has been
+Factory <http://www.mantidproject.org/Units>`__. If the Y data is 'dimensioned' (i.e. has been
 divided by the bin width), then this will be correctly handled, but at
 present nothing else is done to the Y data. If the sample-detector
 distance cannot be calculated then the affected spectrum will be zeroed,
-and a warning message will be output on the `logging <logging>`__
+and a warning message will be output on the `logging <http://www.mantidproject.org/logging>`__
 service.
 
 If AlignBins is false or left at the default the output workspace may be
-a `Ragged Workspace <Ragged Workspace>`__. If it is set to true then the
-data is automatically `rebinned <Rebin>`__ to a regular grid so that the
+a `Ragged Workspace <http://www.mantidproject.org/Ragged_Workspace>`__. If it is set to true then the
+data is automatically `rebinned <http://www.mantidproject.org/Rebin>`__ to a regular grid so that the
 maximum and minimum X values will be maintained. It uses the same number
 of bins as the input data, and divides them linearly equally between the
 minimum and maximum values.
@@ -35,17 +35,17 @@ Restrictions on the input workspace
 ###################################
 
 -  Naturally, the X values must have a unit set, and that unit must be
-   known to the `Unit Factory <Unit Factory>`__.
+   known to the `Unit Factory <http://www.mantidproject.org/Units>`__.
 -  Only histograms, not point data, can be handled at present.
 -  The algorithm will also fail if the source-sample distance cannot be
-   calculated (i.e. the `instrument <instrument>`__ has not been
+   calculated (i.e. the `instrument <http://www.mantidproject.org/instrument>`__ has not been
    properly defined).
 
 Available units
 ---------------
 
 The units currently available to this algorithm are listed
-`here <Unit Factory>`__, along with equations specifying exactly how the
+`here <http://www.mantidproject.org/Units>`__, along with equations specifying exactly how the
 conversions are done.
 
 .. categories::

Code/Mantid/docs/source/algorithms/CropWorkspace-v1.rst

@@ -13,7 +13,7 @@ Extracts a 'block' from a workspace and places it in a new workspace
 (or, to look at it another way, lops bins or spectra off a workspace).
 
 CropWorkspace works on workspaces with common X arrays/bin boundaries or
-on so-called `ragged workspaces <Ragged Workspace>`__. If the input
+on so-called `ragged workspaces <http://www.mantidproject.org/Ragged_Workspace>`__. If the input
 workspace has common bin boundaries/X values then cropping in X will
 lead to an output workspace with fewer bins than the input one. If the
 boundaries are not common then the output workspace will have the same

Code/Mantid/docs/source/algorithms/MultipleScatteringCylinderAbsorption-v1.rst

@@ -12,7 +12,7 @@ Description
 This algorithm is a port to C++ of a multiple scattering absorption
 correction, used to correct the vanadium spectrum for the GPPD
 instrument at the IPNS. The correction calculation was originally worked
-out by Jack Carpenter and Asfia Huq and implmented in Java by Alok
+out by Jack Carpenter and Asfia Huq and implemented in Java by Alok
 Chatterjee. The java code was translated to C++ in Mantid by Dennis
 Mikkelson.
 

Code/Mantid/docs/source/algorithms/SaveZODS-v1.rst

@@ -11,7 +11,7 @@ Description
 
 Saves a HDF5 file to the ZODS (Zurich Oak Ridge Disorder Simulation
 program) format. This format consists of a slice of a
-`MDHistoWorkspace <MDHistoWorkspace>`__ and some information about its
+`MDHistoWorkspace <http://www.mantidproject.org/MDHistoWorkspace>`__ and some information about its
 location.
 
 **You must be in HKL space for the output of this algorithm to make
@@ -39,7 +39,7 @@ and grid base vectors (a1,a2,a3) so a point at node (i,j,k) of grid has
 coordinates r = origin+i\*a1+j\*a2+k\*a3.
 
 Please contact Michal Chodkiewicz (michal.chodkiewicz@gmail.com); Vickie
-Lynch (vel@ornl.gov) for more details.
+Lynch (lynchve@ornl.gov) for more details.
 
 Description of data fields
 ##########################

Code/Mantid/docs/source/algorithms/SphericalAbsorption-v1.rst

@@ -9,8 +9,8 @@
 Description
 -----------
 
-Calculates bin-by-bin correction factors for attenuation due to
-absorption and scattering in a **spherical** sample. Sample data must be
+Calculates bin-by-bin or event correction factors for attenuation due to
+absorption and scattering in a **spherical** sample. Sample data should be
 divided by these corrections. Algorithm calls
 :ref:`algm-AnvredCorrection`.
 

Code/Mantid/docs/source/algorithms/UnwrapSNS-v1.rst

@@ -9,13 +9,14 @@
 Description
 -----------
 
-| Slow moving (low energy and long wavelength neutrons) maybe detected
+Slow moving (low energy and long wavelength neutrons) may be detected
 after the end of the frame in which they entered the experimental
 apparatus. A schematic example of this is shown below where the neutrons
 are marked as circles.
-| |Schematic diagram of neutrons entering an instrument and being
-detected\|centre\||
-| The two neutons on the right of the diagram were actually produced in
+
+.. figure:: /images/UnwrapSNS_inst.png
+
+The two neutons on the right of the diagram were actually produced in
 frame 1 but will be recorded in frame 2 at low time of flight (TOF) and
 a straight :ref:`algm-ConvertUnits` will bin them at high energy
 and short wavelength! :ref:`algm-UnwrapSNS` moves those particles to
@@ -42,6 +43,6 @@ the difference between Tmax and Tmin. DataFrameWidth overrides this and
 the width is the difference between the longest and shortest TOFs in the
 data.
 
-.. |Schematic diagram of neutrons entering an instrument and being detected\|centre\|| image:: /images/UnwrapSNS_inst.png
+
 
 .. categories::