updates in the definition of LEG and MODE (#419)

* updates in the definition of LEG and MODE * Lint and update documentation tables * more definition changes. * Lint and update documentation tables * Update OJP/OJP_Trips.xsd * Lint and update documentation tables * Update OJP/OJP_ModesSupport.xsd Co-authored-by: trurlurl <82838870+trurlurl@users.noreply.github.com> * Update OJP/OJP_Trips.xsd Co-authored-by: trurlurl <82838870+trurlurl@users.noreply.github.com> * Update OJP/OJP_Trips.xsd Co-authored-by: trurlurl <82838870+trurlurl@users.noreply.github.com> --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: trurlurl <82838870+trurlurl@users.noreply.github.com>
VDVde · Oct 20, 2023 · 1c377c9 · 1c377c9
1 parent d54d658
commit 1c377c9
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 23 deletions.
diff --git a/OJP/OJP_ModesSupport.xsd b/OJP/OJP_ModesSupport.xsd
@@ -351,7 +351,7 @@
 	</xs:annotation>
 	<xs:simpleType name="PersonalModesEnumeration">
 		<xs:annotation>
-			<xs:documentation>TYPE OF MODE than can be used in an individual context.</xs:documentation>
+			<xs:documentation>TYPE OF MODE that can be used in an individual context. PERSONAL MODE in TM 6.2.</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="xs:string">
 			<xs:enumeration value="foot"/>
@@ -401,7 +401,7 @@
 		<xs:sequence>
 			<xs:element name="PtMode" type="siri:VehicleModesOfTransportEnumeration">
 				<xs:annotation>
-					<xs:documentation>Categorisation of a (conventional) TRANSPORT MODE. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used, if no other value applies. </xs:documentation>
+					<xs:documentation>Categorisation of a (conventional) PUBLIC TRANSPORT MODE. We use the SIRI 2.1 element which allows for many values in the enumeration. In OJP we don't use the following enumeration values: "pti1_xxx", "xxxServices" when a value without the "Service" exists for the same MODE, "allServicesExcept", "selfDrive", "taxi". Also in cases where only a "xxxService" exists in the enumeration, it should be avoided. "other" or "unknown" should only be used, if no other value applies. </xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:group ref="siri:PtModeChoiceGroup" minOccurs="0"/>
@@ -412,12 +412,12 @@
 	</xs:annotation>
 	<xs:complexType name="ModeFilterStructure">
 		<xs:annotation>
-			<xs:documentation>List of public transport modes ([from SIRI] mode of public transport service, corresponds to PUBLIC TRANSPORT MODE) to exclude or include. Also the necessary filter elements for PERSONAL MODE and MODE OF OPERATION.</xs:documentation>
+			<xs:documentation>List of MODE to exclude or include.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="Exclude" type="xs:boolean" default="true" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>Whether VEHICLE MODEs in list are to be excluded or included from search. Default is to exclude.</xs:documentation>
+					<xs:documentation>Whether MODEs in list are to be excluded or included from search. Default is to exclude.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="PtMode" type="siri:VehicleModesOfTransportEnumeration" minOccurs="0" maxOccurs="unbounded">

diff --git a/OJP/OJP_StopEvents.xsd b/OJP/OJP_StopEvents.xsd
@@ -43,7 +43,7 @@
 		<xs:sequence>
 			<xs:element name="ModeFilter" type="ModeFilterStructure" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>Modes (VEHICLE MODE) to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service.</xs:documentation>
+					<xs:documentation>MODEs to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="LineFilter" type="LineDirectionFilterStructure" minOccurs="0">

diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd
@@ -575,7 +575,7 @@
 	</xs:simpleType>
 	<xs:complexType name="LegStructure">
 		<xs:annotation>
-			<xs:documentation>a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange)</xs:documentation>
+			<xs:documentation>A single stage of a TRIP that is made without change of MODE or service (ie: between each interchange). Implements LEG from TM 6.2.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="Id" type="LegObjectIdType">
@@ -590,23 +590,23 @@
 			</xs:element>
 			<xs:element name="Duration" type="xs:duration" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>The duration of the leg (e.g. from Transmodel PT RIDE LEG.Duration)</xs:documentation>
+					<xs:documentation>The duration of the LEG (e.g. from Transmodel PT RIDE LEG.Duration).</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:choice>
 				<xs:element name="TimedLeg" type="TimedLegStructure">
 					<xs:annotation>
-						<xs:documentation>Timetabled Leg.</xs:documentation>
+						<xs:documentation>Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule.</xs:documentation>
 					</xs:annotation>
 				</xs:element>
 				<xs:element name="TransferLeg" type="TransferLegStructure">
 					<xs:annotation>
-						<xs:documentation>Leg to connect between different services or modes of transport (interchanges).</xs:documentation>
+						<xs:documentation>TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required.</xs:documentation>
 					</xs:annotation>
 				</xs:element>
 				<xs:element name="ContinuousLeg" type="ContinuousLegStructure">
 					<xs:annotation>
-						<xs:documentation>Leg by a continuously available service or mode of transport.</xs:documentation>
+						<xs:documentation>A specialised type of RIDE LEG in with Timed=false, a PERSONAL LEG or an ACCESS LEG TM 6 and NeTEx. LEG of a TRIP that is not bound to a timetable.</xs:documentation>
 					</xs:annotation>
 				</xs:element>
 			</xs:choice>
@@ -620,7 +620,7 @@
 	</xs:complexType>
 	<xs:complexType name="TimedLegStructure">
 		<xs:annotation>
-			<xs:documentation>passenger LEG with timetabled schedule.  Corresponds to a RIDE.</xs:documentation>
+			<xs:documentation>Corresponds to a RIDE or PT RIDE LEG in TM 6.2 with the attribute Timed (with related information). Passenger LEG with timetabled schedule.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="LegBoard" type="LegBoardStructure">
@@ -665,7 +665,7 @@
 	</xs:complexType>
 	<xs:complexType name="TransferLegStructure">
 		<xs:annotation>
-			<xs:documentation>[a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required</xs:documentation>
+			<xs:documentation>TRANSFER LEG or CONNECTION LEG according to TM 6.2. Description of a LEG which links other LEGs where a TRANSFER or CONNECTION between different LOCATIONs is required.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="TransferType" type="TransferTypeEnumeration" minOccurs="1" maxOccurs="unbounded">
@@ -721,7 +721,7 @@
 	</xs:complexType>
 	<xs:complexType name="ContinuousLegStructure">
 		<xs:annotation>
-			<xs:documentation>[relates to a specific type of RIDE in TM and NeTEx] leg of a journey that is not bound to a timetable </xs:documentation>
+			<xs:documentation>[relates to a specific type of RIDE LEG with Timed=false or an ACCESS LEG in TM and NeTEx] leg of a journey that is not bound to a timetable.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="LegStart" type="PlaceRefStructure">