Update Help with latest changes

ASCOMInitiative · Jun 18, 2018 · 4d3a977 · 4d3a977
1 parent 918533f
commit 4d3a977
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 79 deletions.
diff --git a/ASCOM.DeviceInterface/Enumerations.vb b/ASCOM.DeviceInterface/Enumerations.vb
@@ -109,6 +109,7 @@ Public Enum EquatorialCoordinateType ' 135265BA-25AC-4f43-95E5-80D0171E48FA
     ''' Topocentric coordinates. Coordinates of the object at the current date having allowed for annual aberration, precession and nutation. This is the most common coordinate type for amateur telescopes.
     ''' </summary>
     equTopocentric = 1
+
     ''' <summary>
     ''' J2000 equator/equinox. Coordinates of the object at mid-day on 1st January 2000, ICRS reference frame.
     ''' </summary>

diff --git a/Help/ASCOMDeveloper.content b/Help/ASCOMDeveloper.content
@@ -35,13 +35,14 @@
   </Topic>
   <Topic id="d1a0b173-b4be-49b5-a979-cfafcd963ddb" visible="True" noFile="true" isExpanded="true" title="Tools and Features">
     <Topic id="0a23ff52-a935-4cd7-a693-9e3b90f7df29" visible="True" />
-    <Topic id="98976954-6a00-4864-a223-7b3b25ffaaf1" visible="True" isSelected="true" />
+    <Topic id="98976954-6a00-4864-a223-7b3b25ffaaf1" visible="True" />
     <Topic id="62da8408-c4ed-45d8-9398-9990dcbe8cbd" visible="True" />
     <Topic id="f52483b9-e922-4079-afa9-5e6f1a3ab5a5" visible="True" />
     <Topic id="5a679e99-87d5-4b72-a86e-88cbf10c52be" visible="True" />
     <Topic id="f2211b59-6f8c-46fb-b47e-2afb569f3133" visible="True" />
   </Topic>
   <Topic id="98b612bf-f22c-428f-af22-7a77e9907b7f" visible="True" noFile="true" isExpanded="true" title="Developer Information">
+    <Topic id="72A95B28-BBE2-4C7D-BC03-2D6AB324B6F7" visible="True" isSelected="true" />
     <Topic id="caf6b21d-755a-4f1c-891f-ce971a9a2f79" visible="True" title="Drivers and Multi-Threading" />
     <Topic id="d5ab3afe-60aa-49aa-8dfb-caae4f86a8fc" visible="True" title="Coordinate Conversion" />
     <Topic id="732148ca-fc8a-4f0d-bc1d-8f5fe2907744" visible="True" />

diff --git a/Help/ASCOMDeveloper.shfbproj b/Help/ASCOMDeveloper.shfbproj
@@ -201,6 +201,10 @@
       <CopyToMedia>False</CopyToMedia>
       <ImageId>ManufLogos</ImageId>
     </Image>
+    <Image Include="Developer Information\Astronomical Coordinates.png">
+      <ImageId>Astronomical Coordinates</ImageId>
+      <AlternateText>Astronomical Coordinates</AlternateText>
+    </Image>
     <Image Include="Tools and Features\COMPortSettings.png">
       <ImageId>COMPortSettings</ImageId>
       <AlternateText>COMPort Settings</AlternateText>
@@ -240,14 +244,14 @@
       <CopyToMedia>True</CopyToMedia>
     </Image>
     <Content Include="styles\branding-Help1.css" />
+    <None Include="Developer Information\Astronomical Coordinates.aml" />
     <None Include="Tools and Features\Earth Rotation Parameters.aml" />
     <None Include="Version History\Version 6.4.aml" />
     <None Include="Version History\Version 6.3.aml" />
     <None Include="Version History\Version 6.2.aml" />
     <None Include="Introduction\Acknowledgements.aml" />
     <None Include="Developer Information\Time Relationships.aml" />
     <None Include="Developer Information\Time Relationships.aml" />
-    <None Include="Developer Information\Time Relationships - Copy.aml" />
     <None Include="Developer Information\Camera States.aml" />
     <None Include="Developer Information\Camera States.aml" />
     <None Include="Developer Information\Camera States.aml" />

diff --git a/Help/Developer Information/Coordinate Conversion.aml b/Help/Developer Information/Coordinate Conversion.aml
@@ -8,12 +8,12 @@
 	      		<list class="bullet">
 	      			<listItem>Transform</listItem>
 		      		<listItem>SOFA</listItem>
+					<listItem>NOVAS31</listItem>
 					<listItem>Kepler</listItem>
 					<listItem>NOVASCOM</listItem>
 		      		<listItem>NOVAS2</listItem>
 					<listItem>NOVAS2COM</listItem>
 					<listItem>NOVAS3</listItem>
-					<listItem>NOVAS31</listItem>
 		      	</list>
 
 		      	<para>The ASCOM.Astrometry namespace of the Platform has become overcrowded with components that have similar capabilities but that differ in small ways from each
@@ -34,7 +34,7 @@
 					<listItem>NOVAS3</listItem>
 				</list>
 
-		      	<para>Surely, still an embarrassment of riches? In fact these components provide different capabilities and are 
+		      	<para>Surely, three components is still an embarrassment of riches? In fact these components provide different capabilities and are 
 		      	targeted at different requirements and uses as described below.</para>
 	      	</para>
       	</content>
@@ -44,7 +44,7 @@
 		<title>Transform</title>
    		<content>
       		<para>This simple component is designed for the telescope or dome driver author who simply needs to convert
-      		between J2000 RA/DEC co-ordinates and local topocentric RA/DEC and AZ/EL co-ordinates and vice-versa. 
+      		between J2000 RA/DEC co-ordinates and topocentric RA/DEC and AZ/EL co-ordinates and vice-versa. 
       		The Topocentric RA/DEC and AZ/EL coordinates can also be corrected for refraction effects.
 	      	The component is built on the established NOVAS3.1 supervisory library routines.</para>
 	      	<para>This component can be used directly by .NET based applications and is also exposed as a COM object to enable use 
@@ -87,6 +87,7 @@
   <section address="NOVASCOM">
 		<title>NOVASCOM</title>
    		<content>
+   			<para><legacyBold><literal>DEPRECATED - SCHEDULED FOR REMOVAL FROM THE PLATFORM - USE TRANSFORM, SOFA OR NOVAS31</literal></legacyBold></para>
       		<para>This component is a refactoring of the NOVASCOM component authored by Bob Denny in 2001, which was 
       		provided as an optional download component in ASCOM Platforms 4 and 5. It is now integrated in the platform 
       		release and is appropriate for applications requiring accurate ephemerides of the major planets and 
@@ -102,6 +103,7 @@
   <section address="NOVAS2">
 		<title>NOVAS2</title>
    		<content>
+   			<para><legacyBold><literal>DEPRECATED - SCHEDULED FOR REMOVAL FROM THE PLATFORM - USE TRANSFORM, SOFA OR NOVAS31</literal></legacyBold></para>
       		<para>This component is for demanding applications that require access to the fundamental routines
       		in the NOVAS2 library. It contains a range of supervisory routines that provide access to high
       		level functions and an extensive range of intermediate and basic level routines dedicated to lower level
@@ -120,6 +122,7 @@
   <section address="NOVAS3">
 		<title>NOVAS3</title>
    		<content>
+   			<para><legacyBold><literal>DEPRECATED - SCHEDULED FOR REMOVAL FROM THE PLATFORM - USE TRANSFORM, SOFA OR NOVAS31</literal></legacyBold></para>
       		<para>This component is a shell for the NOVAS 3 library released in December 2009 for demanding applications that require access to the fundamental routines
       		in the NOVAS3 library, the latest JPL DE421 planetary and lunar ephemerises or to calculations 
       		based on the IAU 2000 reference systems resolution. It contains a range of supervisory routines that provide access to high

diff --git a/Help/Developer Information/Which NOVAS.aml b/Help/Developer Information/Which NOVAS.aml
diff --git a/Help/Version History/Version 6.4.aml b/Help/Version History/Version 6.4.aml
@@ -80,7 +80,7 @@
 			      			<listItem>The ASCOM open source license text has been added to the Platform SubVersion repository to reflect Open Source norms.</listItem>
 							<listItem>All components are compiled with Visual Studio 2017 and built with the latest tool set.</listItem>
 							<listItem>The help compiler has been updated to the current version.</listItem>
-							<listItem>Installaware has been updated to a much more recent version (InstallAware X6), removing some bugs and allowing additional features to be employed.</listItem>
+							<listItem>InstallAware has been updated to a much more recent version (InstallAware X6), removing some bugs and allowing additional features to be employed.</listItem>
 							<listItem>The installer now has a splash screen.</listItem>
 							<listItem>Except when an error occurs, the Platform and Developer installers no longer produce balloon messages. Messages now appear on the setup dialogue instead. </listItem>
 							<listItem>The progress bars have been re-implemented so that they move consistently from 0 to 100%</listItem>
@@ -125,6 +125,12 @@
 	      			throttling mechanic that can slow aggressive application polling to acceptable rates for the driver and hardware. Further information is provided in the remarks section of the Cache class 
 	      			and the property / method documentation.</listItem>
 	      			<listItem>Driver Templates - Not implemented exceptions have been removed from all Dispose methods and replaced with TODO: items.</listItem>
+	      			<listItem>All Platform documentation references to "local topocentric" have been shortened to "topocentric". The rationale for this is documented in <link xlink:href="72A95B28-BBE2-4C7D-BC03-2D6AB324B6F7" />.
+	      			In addition, the <codeEntityReference linkText="EquatorialCoordinateType.equLocalTopocentric">F:ASCOM.DeviceInterface.EquatorialCoordinateType.equLocalTopocentric</codeEntityReference>
+	      			enum member has been deprecated in favour of 
+	      			<codeEntityReference linkText="EquatorialCoordinateType.equTopocentric">F:ASCOM.DeviceInterface.EquatorialCoordinateType.equTopocentric</codeEntityReference>
+	      			This is a non-breaking change, but continued use of the <codeEntityReference>F:ASCOM.DeviceInterface.EquatorialCoordinateType.equLocalTopocentric</codeEntityReference>
+	      			member will give rise to a compiler warning and suggestion to use equTopocentric instead.</listItem>
 				</list>
       		</content>
    		</section>