[ldd-rings] Fix various copy-editing errors in the Rings dictionary

[mseritan]

Issue Type
Enhancement

Describe the issue identified (if applicable)
Various copy-edit errors have been found in the Rings dictionary. They, along with the proposed changes, are listed individually below. These suggested changes were initially collected during the DMSP in 2022.

Describe the solution you'd like

• In the definition of the attribute axis_name, there is an extra space that should be removed.
• In the definition of the attributes ring_event_start_time_utc and ring_event_stop_time_utc, the phrase “XX is required label attribute for all ring occultation data” is duplicated and should only occur once.
• The definition of the attribute data_quality_index says “Possible values are: ” but then does not list the possible values.
• For the attributes occultation_type, light_source_incidence_angle, observed_ring_azimuth, and normal_mode_wavenumber, there should be a line of whitespace between it and the previous element's definition.
• For the attributes ring_radius, minimum_ring_radius, maximum_ring_radius, projected_sun_diameter, minimum_projected_sun_diameter, maximum_projected_sun_diameter, and sigma_projected_sun_diameter, the definition says “units are km”. We propose removing “km” from the definitions because the schema allows any Units_of_Length.
• For the attribute maximum_ring_longitude_observed_minus_subsolar, the definition should say largest instead of smallest.
• For the attribute incidence_angle, the word “between” is missing in the definition in the phrase “Incidence angle is the angle the surface normal vector at the intercept…”.
• In the definition of the attribute light_source_incidence_angle, there should be consistency in formatting between “north-side” and “southside”.
• In the definition for the attributes time_constant and sigma_time_constant, there is a typo: “them” vs. “then”.
• In the definition for the attribute projected_sun_diameter, there are extra spaces that should be removed.
• In the definition for the attribute fit_rms_semimajor, the acronym “RMS” should be spelled out as “root mean square”.
• In the definition for the attribute corotating_flag, “a table field”<value_meaning> for N should be reworded to say “A coronating frame was not used.”
• In the definitions for the attributes corotating_ring_longitude, minimum_corotating_ring_longitude, and maximum_corotating_ring_longitude, the typo “the with” should be corrected.
• In the class Ring_Reprojection/Display_Direction/
• Ring_Spectrum/Display_Direction/, the phrase “Multiple entries are permitted the settings in the” in the definition should be reworded.
• In the class Ring_Model/Ring_Orbital_Element/Normal_Mode_Parameters/, the typo “is one is present” in the class definition should be corrected.
• In the class Ring_Reprojection/Reprojection_Geometry/, the typo “(.g., radius…” in the class definition should be corrected.
• The definition of the attribute along_track_timing_offset could use more clarity; perhaps point to a journal article discussing how this quantity is used.
• For the attribute occultation direction, the phrase “the distance” in all three value definitions should be converted to “the projected distance”
• For the attribute ring_profile_direction, the definition of the seldom-used value “Multiple” takes up more space than the overall definition of the attribute. Should that be there? The same content is repeated in the actual value definition.
• For the attribute ring_profile_direction, the definition should mention why the value “Both” is not available.
• In the definitions for the attributes highest_detectable_opacity and lowest_detectable opacity, the technical definition of opacity, as well as its relationship to optical depth, should be included. And the definition should perhaps not include a reference to “nearly opaque rings,” because this excludes moderate or tenuous rings.
• For the definitions of the attributes minimum_ring_longitude_observed_minus_subsolar and maximum_ring_longitude_observed_minus_subsolar, the phrase “Required in label files for ring occultation data" is in the first but not the second. It should be neither or both. The attribute is currently optional, and no schematron rule actually requires its use.
• In the definitions for the attributes corotating_ring_longitude, minimum_corotating_ring_longitude, and maximum_corotating_ring_longitude, the phrase “rotating frame. The with zero longitude defined at the epoch specified by epoch_reprojection_basis_utc, zero” should be converted to “co-rotating frame. The zero longitude is defined as the prime meridian at the epoch specified by epoch_reprojection_basis_utc. Therefore, zero”.
• In the change log, Display_Direction was used from the display namespace, not the geometry namespace.
• Broadly, definitions are inconsistent in their phrasing and in how they refer to one another.
• Broadly, the useful phrase “the body identified in the enclosing class”, which appears in some attribute definitions (e.g., j2), should appear in others as well.

Describe alternatives you've considered
No alternates are necessary when requesting copy-edit changes.

LDD Dictionary Version
The LDD version number is not needed for an enhancement request.

PDS4 IM Version
1M00

Need-by Date
No specific need-by date applies to these requested changes.

Additional context
No additional context is needed for these changes.

[mseritan]

This Issue corresponds to RMS-DSMP Issue A.

[matthewtiscareno]

In the definition of the attribute axis_name, there is an extra space that should be removed.

Removed

In the definition of the attributes ring_event_start_time_utc and ring_event_stop_time_utc, the phrase “XX is required label attribute for all ring occultation data” is duplicated and should only occur once.

Removed one instance in each case

The definition of the attribute data_quality_index says “Possible values are: ” but then does not list the possible values.

We simply removed the text "Possible values are:", rather than set up duplicate information that would need to be maintained manually.

For the attributes occultation_type, light_source_incidence_angle, observed_ring_azimuth, and normal_mode_wavenumber, there should be a line of whitespace between it and the previous element's definition.

Done

[matthewtiscareno]

For the attributes ring_radius, minimum_ring_radius, maximum_ring_radius, projected_sun_diameter, minimum_projected_sun_diameter, maximum_projected_sun_diameter, and sigma_projected_sun_diameter, the definition says “units are km”. We propose removing “km” from the definitions because the schema allows any Units_of_Length.

Done for ring_radius, minimum_ring_radius, maximum_ring_radius, and projected_sun_diameter.

Note that minimum_projected_sun_diameter, maximum_projected_sun_diameter, and sigma_projected_sun_diameter did not actually contain this error, though minimum_projected_sun_diameter and maximum_projected_sun_diameter did contain a spelling error "obsevation" ==> "observation"

For the attribute maximum_ring_longitude_observed_minus_subsolar, the definition should say largest instead of smallest.

Done

For the attribute incidence_angle, the word “between” is missing in the definition in the phrase “Incidence angle is the angle the surface normal vector at the intercept…”.

Done

In the definition of the attribute light_source_incidence_angle, there should be consistency in formatting between “north-side” and “southside”.

Done