From b05480db44cf6a4c0d48f5457b660b7fe2712f74 Mon Sep 17 00:00:00 2001
From: Victor Turpin <vturpin@ocean-ops.org>
Date: Thu, 6 Jun 2024 16:34:55 +0200
Subject: [PATCH] add exemplar for telecom, hardware and field comparison.adoc
 (#234)

* add exemplar for telecom, hardware and field comparison.adoc

No exemplar yet for field comp'
exemplar for telecom and hardware refers to Vocab guildeline. But as the controlled vocab are pending (not served by a vocabulary server yet, I do not know how i should fill the `*_vocabulary` attribute.

* Update OG_Format.adoc

resolve conversation 'V' toward 'v'

* Update OG_Format.adoc

typo
---
 OG_Format.adoc | 46 +++++++++++++++++++++++++++-------------------
 1 file changed, 27 insertions(+), 19 deletions(-)

diff --git a/OG_Format.adoc b/OG_Format.adoc
index 6e86e9a..aee345e 100644
--- a/OG_Format.adoc
+++ b/OG_Format.adoc
@@ -506,9 +506,9 @@ long_name = “longitude of deployment”;
 ////
 === Field comparison information
 
-[cols=",,",options="header",]
+[cols=",,,",options="header",]
 |=========================================================================================================================================
-|*VARIABLE NAME* |*variable attributes* |*requirement status*
+|*VARIABLE NAME* |*variable attributes* |*requirement status* | *Format, fixed value or example*
 |FIELD_COMPARISON_REFERENCE a|
 String FIELD_COMPARISON_REFERENCE:
 
@@ -516,7 +516,7 @@ FIELD_COMPARISON_REFERENCE:long_name = “links (uri or url) to supplementary da
 
 FIELD_COMPARISON_REFERENCE:comment = “multiple links are separated by a comma”
 
- |highly desirable
+ |highly desirable | 
 |=========================================================================================================================================
 
 Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and delayed versions.
@@ -525,37 +525,40 @@ Note: FIELD_COMPARISON_REFERENCE is applicable to deployment, recovery, and dela
 * [[hardware-information]]
 == Hardware information
 ////
-=== Hardware information
+== Hardware information
 
-[cols=",,",options="header",]
+[cols=",,,",options="header",]
 |=============================================================================
-|*VARIABLE NAME* |*variable attributes* |*requirement status*
+|*VARIABLE NAME* |*variable attributes* |*requirement status* | *Format, fixed value or example*
 |GLIDER_FIRMWARE_VERSION a|
 string GLIDER_FIRMWARE_VERSION
 
 GLIDER_FIRMWARE_VERSION:long_name = “version of the internal glider firmware”;
 
- |highly desirable
+ |highly desirable | *ex.:* v1.3.22 
 |LANDSTATION_VERSION a|
 string LANDSTATION_VERSION
 
 LANDSTATION_VERSION:long_name = “version of the server onshore”;
 
- |highly desirable
+ |highly desirable | *ex.:* "dockserver v3.42"
 |BATTERY_TYPE a|
 string BATTERY_TYPE
 
 BATTERY_TYPE:long_name = “type of the battery”;
 
-BATTERY_TYPE:battery_type_vocabulary = “”;
+BATTERY_TYPE:battery_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/battery_type.md”;
+
+ |suggested | *ex.:*  "lithium rechargeable"
+
+BATTERY_TYPE:battery_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/battery_type.md”
 
- |suggested
 |BATTERY_PACK a|
 string BATTERY_PACK
 
 BATTERY_PACK:long_name = “battery packaging”;
 
- |suggested
+ |suggested | *ex.:* "2X24 12V battery"
 |=============================================================================
 
 ////
@@ -564,25 +567,30 @@ BATTERY_PACK:long_name = “battery packaging”;
 ////
 === Telecom information
 
-[cols=",,",options="header",]
+[cols=",,,",options="header",]
 |===============================================================================
-|*VARIABLE NAME* |*variable attributes* |*requirement status*
+|*VARIABLE NAME* |*variable attributes* |*requirement status* | *Format, fixed value or example*
 |TELECOM_TYPE a|
 string TELECOM_TYPE
 
-TELECOM_TYPE:long_name = “type of telecommunication systems used by the glider”;
+TELECOM_TYPE:long_name = “types of telecommunication systems used by the glider, multiple telecom type are separated by a comma”;
 
-TELECOM_TYPE:telecom_type_vocabulary = “”;
+TELECOM_TYPE:telecom_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/telecom_type.md”;
+
+ |highly desirable | *ex.:* iridium
+
+TELECOM_TYPE:telecom_type_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/telecom_type.md”
 
- |highly desirable
 |TRACKING_SYSTEM a|
 string TRACKING_SYSTEM
 
-TRACKING_SYSTEM:long_name = “type of tracking systems used by the glider”;
+TRACKING_SYSTEM:long_name = “type of tracking systems used by the glider, multiple tracking system are separated by a comma”;
 
-TRACKING_SYSTEM:tracking_system_vocabulary = “”;
+TRACKING_SYSTEM:tracking_system_vocabulary = “https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md”;
 
- |highly desirable
+ |highly desirable | *ex.:* "gps, accoustic"
+
+TRACKING_SYSTEM:tracking_system_vocabulary = "https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md, https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md"
 |===============================================================================
 
 ////