[FIX] Consistently refer to Neuromag/Elekta/MEGIN (#1310)

* DRAFT: consistently refer to Neuromag/Elekta/MEGIN

* add deprecation notices

* add links to deprecation

src/appendices/coordinate-systems.md

@@ -108,11 +108,12 @@ Restricted keywords for the `<CoordSysType>CoordinateSystem` field in the
 `coordinatesystem.json` file for MEG datasets:
 
 -   `CTF`: ALS orientation and the origin between the ears
--   `ElektaNeuromag`: RAS orientation and the origin between the ears
+-   `NeuromagElektaMEGIN`: RAS orientation and the origin between the ears
 -   `4DBti`: ALS orientation and the origin between the ears
 -   `KitYokogawa`: ALS orientation and the origin between the ears
 -   `ChietiItab`: RAS orientation and the origin between the ears
 -   Any keyword from the list of [Standard template identifiers](#standard-template-identifiers): RAS orientation and the origin at the center of the gradient coil for template NifTI images
+-   The use of `ElektaNeuromag` is [DEPRECATED][deprecated]. Dataset curators SHOULD use `NeuromagElektaMEGIN` instead.
 
 In the case that MEG was recorded simultaneously with EEG,
 the restricted keywords for
@@ -146,7 +147,7 @@ the restricted keywords for
 can also be applied to EEG:
 
 -   `CTF`
--   `ElektaNeuromag`
+-   `NeuromagElektaMEGIN`
 -   `4DBti`
 -   `KitYokogawa`
 -   `ChietiItab`

src/schema/objects/enums.yaml

@@ -20,7 +20,8 @@ _MEGCoordSys:
   type: string
   enum:
     - $ref: objects.enums.CTF.value
-    - $ref: objects.enums.ElektaNeuromag.value
+    - $ref: objects.enums.ElektaNeuromag.value # deprecated
+    - $ref: objects.enums.NeuromagElektaMEGIN.value
     - $ref: objects.enums.4DBti.value
     - $ref: objects.enums.KitYokogawa.value
     - $ref: objects.enums.ChietiItab.value
@@ -305,6 +306,13 @@ CTF:
 ElektaNeuromag:
   value: ElektaNeuromag
   display_name: Elekta Neuromag
+  description: |
+    RAS orientation and the origin between the ears.
+    [DEPRECATED](SPEC_ROOT/common-principles.md#definitions).
+    Dataset curators SHOULD use `NeuromagElektaMEGIN` instead.
+NeuromagElektaMEGIN:
+  value: NeuromagElektaMEGIN
+  display_name: Neuromag Elekta MEGIN
   description: |
     RAS orientation and the origin between the ears.
 4DBti:

src/schema/rules/sidecars/meg.yaml

@@ -20,8 +20,11 @@ MEGHardware:
       level: recommended
       description_addendum: |
         For MEG scanners, this must be one of:
-        `"CTF"`, `"Elekta/Neuromag"`, `"BTi/4D"`, `"KIT/Yokogawa"`,
+        `"CTF"`, `"Neuromag/Elekta/MEGIN"`, `"BTi/4D"`, `"KIT/Yokogawa"`,
         `"ITAB"`, `"KRISS"`, `"Other"`.
+        The use of `"Elekta/Neuromag"` is
+        [DEPRECATED](SPEC_ROOT/common-principles.md#definitions).
+        Dataset curators SHOULD use `"Neuromag/Elekta/MEGIN"` instead.
         See the [MEG Systems Appendix](SPEC_ROOT/appendices/meg-systems.md) for
         preferred names.
     ManufacturersModelName: