diff --git a/Code/Mantid/docs/source/algorithms/AddPeak-v1.rst b/Code/Mantid/docs/source/algorithms/AddPeak-v1.rst index eddd7ddb415126d728446b85a2ca6877c2a4795b..f1774a3d93ffa3306ff1a4e808b4a3076dc6ffba 100644 --- a/Code/Mantid/docs/source/algorithms/AddPeak-v1.rst +++ b/Code/Mantid/docs/source/algorithms/AddPeak-v1.rst @@ -9,7 +9,7 @@ Description ----------- -Adds a peak to a :ref:`PeaksWorkspace <PeaksWorkspace>`__. +Adds a peak to a :ref:`PeaksWorkspace <PeaksWorkspace>`. Usage ----- diff --git a/Code/Mantid/docs/source/algorithms/AddPeakHKL-v1.rst b/Code/Mantid/docs/source/algorithms/AddPeakHKL-v1.rst index 3428f32e330a3075bfdac710825247c4c55d25bd..ab768f8c24c9793bc57186c7a4f12c7adb521a09 100644 --- a/Code/Mantid/docs/source/algorithms/AddPeakHKL-v1.rst +++ b/Code/Mantid/docs/source/algorithms/AddPeakHKL-v1.rst @@ -10,7 +10,7 @@ Description ----------- -Add a peak in the HKL frame to an existing :ref:`PeaksWorkspace <PeaksWorkspace>`__. The OrientedLattice must be provided and the Goniometer should be set correctly before running the algorithm. +Add a peak in the HKL frame to an existing :ref:`PeaksWorkspace <PeaksWorkspace>`. The OrientedLattice must be provided and the Goniometer should be set correctly before running the algorithm. The peak is added to the existing PeaksWorkspace. Run information and goniometer setting and the UB matrix are taken from the provided PeaksWorkspace. diff --git a/Code/Mantid/docs/source/concepts/Analysis_Data_Service.rst b/Code/Mantid/docs/source/concepts/AnalysisDataService.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Analysis_Data_Service.rst rename to Code/Mantid/docs/source/concepts/AnalysisDataService.rst diff --git a/Code/Mantid/docs/source/concepts/Create_an_IDF.rst b/Code/Mantid/docs/source/concepts/CreateanIDF.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Create_an_IDF.rst rename to Code/Mantid/docs/source/concepts/CreateanIDF.rst diff --git a/Code/Mantid/docs/source/concepts/Data_Service.rst b/Code/Mantid/docs/source/concepts/DataService.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Data_Service.rst rename to Code/Mantid/docs/source/concepts/DataService.rst diff --git a/Code/Mantid/docs/source/concepts/Dynamic_Factory.rst b/Code/Mantid/docs/source/concepts/DynamicFactory.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Dynamic_Factory.rst rename to Code/Mantid/docs/source/concepts/DynamicFactory.rst diff --git a/Code/Mantid/docs/source/concepts/Error_Propagation.rst b/Code/Mantid/docs/source/concepts/ErrorPropagation.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Error_Propagation.rst rename to Code/Mantid/docs/source/concepts/ErrorPropagation.rst diff --git a/Code/Mantid/docs/source/concepts/EventWorkspace.rst b/Code/Mantid/docs/source/concepts/EventWorkspace.rst index 7e8712b18582552f9147ff9e1d0d9f5c3c19a403..09b7e0428229fe7f16ed0f89627d2a2e02a235d9 100644 --- a/Code/Mantid/docs/source/concepts/EventWorkspace.rst +++ b/Code/Mantid/docs/source/concepts/EventWorkspace.rst @@ -1,7 +1,7 @@ .. _EventWorkspace: -EventWorkspace -============== +Event Workspace +=============== Quick Summary For Users ----------------------- diff --git a/Code/Mantid/docs/source/concepts/Facilities_File.rst b/Code/Mantid/docs/source/concepts/FacilitiesFile.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Facilities_File.rst rename to Code/Mantid/docs/source/concepts/FacilitiesFile.rst diff --git a/Code/Mantid/docs/source/concepts/Framework_Manager.rst b/Code/Mantid/docs/source/concepts/FrameworkManager.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Framework_Manager.rst rename to Code/Mantid/docs/source/concepts/FrameworkManager.rst diff --git a/Code/Mantid/docs/source/concepts/Geometry_of_Position.rst b/Code/Mantid/docs/source/concepts/GeometryofPosition.rst similarity index 99% rename from Code/Mantid/docs/source/concepts/Geometry_of_Position.rst rename to Code/Mantid/docs/source/concepts/GeometryofPosition.rst index b6cbf2f310b3c80a4092d82c12ebdee9d2c1e86f..4451b15f80217ab2b8ca7b19aa725fe5967d9a61 100644 --- a/Code/Mantid/docs/source/concepts/Geometry_of_Position.rst +++ b/Code/Mantid/docs/source/concepts/GeometryofPosition.rst @@ -1,6 +1,6 @@ .. _Geometry of Position: -Geometry_of_Position +Geometry of Position ==================== What is it? diff --git a/Code/Mantid/docs/source/concepts/Geometry_of_Shape.rst b/Code/Mantid/docs/source/concepts/GeometryofShape.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Geometry_of_Shape.rst rename to Code/Mantid/docs/source/concepts/GeometryofShape.rst diff --git a/Code/Mantid/docs/source/concepts/Instrument_Data_Service.rst b/Code/Mantid/docs/source/concepts/InstrumentDataService.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Instrument_Data_Service.rst rename to Code/Mantid/docs/source/concepts/InstrumentDataService.rst diff --git a/Code/Mantid/docs/source/concepts/LET_Sample_IDF.rst b/Code/Mantid/docs/source/concepts/LETSampleIDF.rst similarity index 99% rename from Code/Mantid/docs/source/concepts/LET_Sample_IDF.rst rename to Code/Mantid/docs/source/concepts/LETSampleIDF.rst index 84f33546f669182a8992da0853dc0f8f8e92ee0a..cd8fc2847fce37ab09664f9e6f6047a4ba4b9607 100644 --- a/Code/Mantid/docs/source/concepts/LET_Sample_IDF.rst +++ b/Code/Mantid/docs/source/concepts/LETSampleIDF.rst @@ -3,7 +3,7 @@ .. role:: xml(literal) :class: highlight -IDF-ISIS-SANS2D-annotated +IDF ISIS LET annotated ========================= This page annotates the direct inelastic instrument LET, with the purpose of (hopefully) quickly learn the basis of creating a similar IDF. diff --git a/Code/Mantid/docs/source/concepts/MDHistoWorkspace.rst b/Code/Mantid/docs/source/concepts/MDHistoWorkspace.rst index 96b00dbbdf396a62650d1d7bc944cc4c63ffc5e6..af2e92bd3ca3d6608ab213b244718959713c7c75 100644 --- a/Code/Mantid/docs/source/concepts/MDHistoWorkspace.rst +++ b/Code/Mantid/docs/source/concepts/MDHistoWorkspace.rst @@ -1,9 +1,9 @@ .. _MDHistoWorkspace: -MDHistoWorkspace -================ +MD Histogram Workspace +====================== -The MDHistoWorkspace is a simple multi-dimensional workspace. In +The MD Histogram Workspace[MDHistoWorkspace] is a simple multi-dimensional workspace. In contrast to the :ref:`MDWorkspace <MDWorkspace>`, which contains points in space, the MDHistoWorkspace consists of a signal and error spread around space on a regular grid. diff --git a/Code/Mantid/docs/source/concepts/MDWorkspace.rst b/Code/Mantid/docs/source/concepts/MDWorkspace.rst index 0a0510e528fbb40e71d582d7e5a6a80699341cf8..1319e4009e67062c24557cfbbb8af78eb345a444 100644 --- a/Code/Mantid/docs/source/concepts/MDWorkspace.rst +++ b/Code/Mantid/docs/source/concepts/MDWorkspace.rst @@ -1,9 +1,9 @@ .. _MDWorkspace: -MDWorkspace -=========== +MD Workspace +============ -The MDWorkspace (short for "Multi-Dimensional" Workspace) is a generic +The MD Workspace [MDWorkspace] (short for "Multi-Dimensional" Workspace) is a generic data structure holdings points (MDEvents) that are defined by their position in several dimensions. See also :ref:`MDHistoWorkspace <MDHistoWorkspace>`. diff --git a/Code/Mantid/docs/source/concepts/MatrixWorkspace.rst b/Code/Mantid/docs/source/concepts/MatrixWorkspace.rst index ff20b14741e329dc0b0cfedad1f1887584aaeb3e..244e23d5a98a093c09d39ad795340c9a7ec3d75d 100644 --- a/Code/Mantid/docs/source/concepts/MatrixWorkspace.rst +++ b/Code/Mantid/docs/source/concepts/MatrixWorkspace.rst @@ -1,7 +1,7 @@ .. _MatrixWorkspace: -MatrixWorkspace -=============== +Matrix Workspace +================ What information is in a MatrixWorkspace ---------------------------------------- diff --git a/Code/Mantid/docs/source/concepts/Nexus_file.rst b/Code/Mantid/docs/source/concepts/NexusFile.rst similarity index 97% rename from Code/Mantid/docs/source/concepts/Nexus_file.rst rename to Code/Mantid/docs/source/concepts/NexusFile.rst index 8c22396d56d76ffa003b01df862a56f9744b461e..9cf8a3c5a6ffab7383074736e5cb5f6e6e38b73d 100644 --- a/Code/Mantid/docs/source/concepts/Nexus_file.rst +++ b/Code/Mantid/docs/source/concepts/NexusFile.rst @@ -1,6 +1,6 @@ .. _Nexus file: -Nexus_file +Nexus File ========== A **Nexus file** is a type of data file used by ISIS traget station 2 diff --git a/Code/Mantid/docs/source/concepts/PeaksWorkspace.rst b/Code/Mantid/docs/source/concepts/PeaksWorkspace.rst index e6a32575ab9aa7c40a5cf015f4f33603802fdf1e..d6c43dbd29df77dd17d972089f366459c41f7c73 100644 --- a/Code/Mantid/docs/source/concepts/PeaksWorkspace.rst +++ b/Code/Mantid/docs/source/concepts/PeaksWorkspace.rst @@ -1,4 +1,6 @@ -PeaksWorkspace +.. _PeaksWorkspace: + +Peaks Workspace =============== The PeaksWorkspace is a special Workspace that holds a list of single crystal Peak objects. diff --git a/Code/Mantid/docs/source/concepts/Point_groups.rst b/Code/Mantid/docs/source/concepts/PointGroups.rst similarity index 99% rename from Code/Mantid/docs/source/concepts/Point_groups.rst rename to Code/Mantid/docs/source/concepts/PointGroups.rst index e43e722665c1fc392a059bc285b7f3adff20c89d..4974ba3e280b785ff2c04a0e97d149a185beedf8 100644 --- a/Code/Mantid/docs/source/concepts/Point_groups.rst +++ b/Code/Mantid/docs/source/concepts/PointGroups.rst @@ -1,6 +1,6 @@ .. _Point groups: -Point groups +Point Groups ============ This document explains how crystallographic point groups are used in Mantid. @@ -42,7 +42,7 @@ As mentioned before, point groups can describe the symmetry of a lattice, includ To describe the rotational and translational components of the symmetry operation, a matrix :math:`\mathbf{W}_i` and a vector :math:`\mathbf{w}_i` are used. In three dimensions :math:`\mathbf{h}` has three elements, so :math:`\mathbf{W}_i` is a :math:`3\times3`-matrix and the symmetry operation is applied like this: .. math:: - \mathbf{h}' = \mathbf{W}_i^{-1}^T \cdot \mathbf{h} + \mathbf{h}' = \mathbf{W}_i^{-1T} \cdot \mathbf{h} Note that the translational component is not used for transforming HKLs and :math:`\mathbf{W}_i` is inverted and transposed. Coordinates :math:`\mathbf{x}` are transformed differently, they are affected by the translational component: diff --git a/Code/Mantid/docs/source/concepts/Properties_File.rst b/Code/Mantid/docs/source/concepts/PropertiesFile.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Properties_File.rst rename to Code/Mantid/docs/source/concepts/PropertiesFile.rst diff --git a/Code/Mantid/docs/source/concepts/RAW_File.rst b/Code/Mantid/docs/source/concepts/RAWFile.rst similarity index 99% rename from Code/Mantid/docs/source/concepts/RAW_File.rst rename to Code/Mantid/docs/source/concepts/RAWFile.rst index 1b917b56ab569d1b2059e9157abd3e1df3babe6c..b28f1a47b384ac9191111acae7a2428ade19465b 100644 --- a/Code/Mantid/docs/source/concepts/RAW_File.rst +++ b/Code/Mantid/docs/source/concepts/RAWFile.rst @@ -1,6 +1,6 @@ .. _RAW File: -RAW_File +RAW File ======== The RAW file format has been for many years the primary data format of diff --git a/Code/Mantid/docs/source/concepts/RectangularDetector.rst b/Code/Mantid/docs/source/concepts/RectangularDetector.rst index 99453e3a800eeb976686299007a4bee46ec8f0c3..c27036adf4a7f45e809a2910a71c063b3957cf08 100644 --- a/Code/Mantid/docs/source/concepts/RectangularDetector.rst +++ b/Code/Mantid/docs/source/concepts/RectangularDetector.rst @@ -1,7 +1,7 @@ .. _RectangularDetector: -RectangularDetector -=================== +Rectangular Detector +==================== The rectangular detector is a detector bank that is marked as being a regular rectangular bank. It is a particular class in Mantid (RectangularDetector). diff --git a/Code/Mantid/docs/source/concepts/SANS2D_Sample_IDF.rst b/Code/Mantid/docs/source/concepts/SANS2DSampleIDF.rst similarity index 99% rename from Code/Mantid/docs/source/concepts/SANS2D_Sample_IDF.rst rename to Code/Mantid/docs/source/concepts/SANS2DSampleIDF.rst index ae95060335dd6b920f72e74a4f730c33044ce866..0982fccd04039c82e6dba0f0583da98e6e0d2e9d 100644 --- a/Code/Mantid/docs/source/concepts/SANS2D_Sample_IDF.rst +++ b/Code/Mantid/docs/source/concepts/SANS2DSampleIDF.rst @@ -4,7 +4,7 @@ .. role:: xml(literal) :class: highlight -IDF-ISIS-SANS2D-annotated +IDF ISIS SANS2D annotated ========================= This page annotates the small angle scattering SANS2D IDF, with the purpose of (hopefully) quickly learn the basis of creating a similar IDF. diff --git a/Code/Mantid/docs/source/concepts/Shared_Pointer.rst b/Code/Mantid/docs/source/concepts/SharedPointer.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Shared_Pointer.rst rename to Code/Mantid/docs/source/concepts/SharedPointer.rst diff --git a/Code/Mantid/docs/source/concepts/Table_Workspaces.rst b/Code/Mantid/docs/source/concepts/TableWorkspaces.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Table_Workspaces.rst rename to Code/Mantid/docs/source/concepts/TableWorkspaces.rst diff --git a/Code/Mantid/docs/source/concepts/Unit_Factory.rst b/Code/Mantid/docs/source/concepts/UnitFactory.rst similarity index 99% rename from Code/Mantid/docs/source/concepts/Unit_Factory.rst rename to Code/Mantid/docs/source/concepts/UnitFactory.rst index 0dae6818787fe3b98874849562a59218a5a43c4d..9ab93a73903065006f7ac82c524852e4d65948ed 100644 --- a/Code/Mantid/docs/source/concepts/Unit_Factory.rst +++ b/Code/Mantid/docs/source/concepts/UnitFactory.rst @@ -1,6 +1,6 @@ .. _Unit Factory: -Unit_Factory +Unit Factory ============ What is it? diff --git a/Code/Mantid/docs/source/concepts/Using_XML_Schema.rst b/Code/Mantid/docs/source/concepts/UsingXMLSchema.rst similarity index 100% rename from Code/Mantid/docs/source/concepts/Using_XML_Schema.rst rename to Code/Mantid/docs/source/concepts/UsingXMLSchema.rst diff --git a/Code/Mantid/docs/source/concepts/Workflow_Algorithm.rst b/Code/Mantid/docs/source/concepts/WorkflowAlgorithm.rst similarity index 98% rename from Code/Mantid/docs/source/concepts/Workflow_Algorithm.rst rename to Code/Mantid/docs/source/concepts/WorkflowAlgorithm.rst index 0fdc680fa1f7eafeb29cb3987293806524b8260f..c7241d46bbdfd4bca610281e99c33d3e282f94c2 100644 --- a/Code/Mantid/docs/source/concepts/Workflow_Algorithm.rst +++ b/Code/Mantid/docs/source/concepts/WorkflowAlgorithm.rst @@ -1,6 +1,6 @@ .. _Workflow Algorithm: -Workflow_Algorithm +Workflow Algorithm ================== A workflow algorithm is a special subset of algorithms that perform diff --git a/Code/Mantid/docs/source/concepts/WorkspaceGroup.rst b/Code/Mantid/docs/source/concepts/WorkspaceGroup.rst index 7c095bcf14566161f0b99060cc49efdb233e96a3..467a65ceb38f59aa63850d477e11c0a8355b7aff 100644 --- a/Code/Mantid/docs/source/concepts/WorkspaceGroup.rst +++ b/Code/Mantid/docs/source/concepts/WorkspaceGroup.rst @@ -1,7 +1,7 @@ .. _WorkspaceGroup: -WorkspaceGroup -============== +Workspace Group +=============== A WorkspaceGroup is a group of workspaces.