typos from proofreading (#434)

* typosfrom proofreading * Lint and update documentation tables * Update examples/functions/trip/TR_ParallelService_OeBB_right_with_remain_in_vehicle.xml Co-authored-by: Stefan de Konink <[email protected]> * Update OJP/OJP_JourneySupport.xsd Co-authored-by: Stefan de Konink <[email protected]> * Update OJP/OJP_JourneySupport.xsd Co-authored-by: Stefan de Konink <[email protected]> * Update OJP/OJP_JourneySupport.xsd Co-authored-by: Stefan de Konink <[email protected]> * Lint and update documentation tables * Update OJP/OJP_ModesSupport.xsd Co-authored-by: Stefan de Konink <[email protected]> * Update OJP/OJP_ModesSupport.xsd Co-authored-by: Stefan de Konink <[email protected]> * Update examples/functions/trip/TR_ParallelService_OeBB_wrong.xml Co-authored-by: Stefan de Konink <[email protected]> * Update OJP/OJP_FareSupport.xsd * Update OJP/OJP_ModesSupport.xsd Co-authored-by: trurlurl <[email protected]> * Update OJP/OJP_ModesSupport.xsd Co-authored-by: trurlurl <[email protected]> * Lint and update documentation tables * removed ... * Lint and update documentation tables * changes 2023-11-10 * Lint and update documentation tables * more typos * Lint and update documentation tables --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Stefan de Konink <[email protected]> Co-authored-by: trurlurl <[email protected]>
VDVde · Nov 15, 2023 · e43697a · e43697a
1 parent 17d0d05
commit e43697a
Show file tree

Hide file tree

Showing 19 changed files with 382 additions and 382 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -79,7 +79,7 @@ The releases can be found at https://github.com/VDVde/OJP/releases
   [#83](https://github.com/VDVde/OJP/pull/83)
 * Added parameter `NoSight` to `BaseTripMobilityFilterGroup` to allow requesting a trip for a blind user.
   [#36](https://github.com/VDVde/OJP/pull/36)
-* Added a `TripStatusGroup` consisting of parameters which describe the current status of a trip, e.g. `Cancelled` / `Delayed` / `Infeasible`. 
+* Added a `TripStatusGroup` consisting of parameters which describe the current status of a trip, e.g., `Cancelled` / `Delayed` / `Infeasible`. 
   [#116](https://github.com/VDVde/OJP/pull/116)
 * Added an optional `ProductCategory` of a `Service`. As defined in NeTEx and SIRI, a product category is a classification for VEHICLE JOURNEYs 
   to express some common properties of journeys for marketing and fare products.

diff --git a/OJP/OJP_Availability.xsd b/OJP/OJP_Availability.xsd
@@ -363,7 +363,7 @@
 			</xs:enumeration>
 			<xs:enumeration value="alightingAssistance">
 				<xs:annotation>
-					<xs:documentation>Assistance for unboarding.</xs:documentation>
+					<xs:documentation>Assistance for alighting.</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="onboardAssistance">
@@ -403,7 +403,7 @@
 			</xs:enumeration>
 			<xs:enumeration value="AVAILABILITY_OUTSIDERULES">
 				<xs:annotation>
-					<xs:documentation>The vehicle is not available due to existing rules like operating hours or not competing against an existing public transport line. In the details of the problem there should be information indicating which rules were violated: e.g. The desired MOBILITY SERVICE can't be provided because there exists a regulare line for this TRIP.</xs:documentation>
+					<xs:documentation>The vehicle is not available due to existing rules like operating hours or not competing against an existing public transport line. In the details of the problem there should be information indicating which rules were violated: e.g., The desired MOBILITY SERVICE can't be provided because there exists a regular line for this TRIP.</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="AVAILABILITY_SERVICEDISRUPTED">

diff --git a/OJP/OJP_Common.xsd b/OJP/OJP_Common.xsd
@@ -73,7 +73,7 @@
 	</xs:complexType>
 	<xs:complexType name="LinearShapeStructure">
 		<xs:annotation>
-			<xs:documentation>An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure.</xs:documentation>
+			<xs:documentation>An oriented correspondence from one LINK or ROUTE of a source layer, onto an entity in a target layer: e.g., LINK SEQUENCE. As OJP is reduced in relation to NeTEx, we use a simple general structure.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="Position" type="siri:LocationStructure" minOccurs="2" maxOccurs="unbounded">
@@ -147,7 +147,7 @@
 	</xs:annotation>
 	<xs:element name="ProductCategoryRef" type="siri:ProductCategoryRefStructure">
 		<xs:annotation>
-			<xs:documentation>Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g. NeTEx, SIRI, OJP).</xs:documentation>
+			<xs:documentation>Reference to a product category. Product categories should be defined once and used uniformly in all channels (e.g., NeTEx, SIRI, OJP).</xs:documentation>
 		</xs:annotation>
 	</xs:element>
 	<xs:annotation>
@@ -160,7 +160,7 @@
 		<xs:sequence>
 			<xs:element name="Line" type="siri:LineDirectionStructure" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created  for the purpose of filtering and organising timetables.</xs:documentation>
+					<xs:documentation>Reference to a GROUP of DIRECTIONs of the ROUTEs belonging to the same LINE created for the purpose of filtering and organising timetables.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="Exclude" type="xs:boolean" default="true" minOccurs="0">
@@ -297,7 +297,7 @@
 			</xs:element>
 			<xs:element name="Restricted" type="xs:boolean" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles).</xs:documentation>
+					<xs:documentation>This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles).</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="RestrictionNote" type="InternationalTextStructure" minOccurs="0">
@@ -368,7 +368,7 @@
 			</xs:element>
 			<xs:element name="Pattern" type="ValidDayBitType">
 				<xs:annotation>
-					<xs:documentation>Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position.</xs:documentation>
+					<xs:documentation>Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event happens on the day that is represented by the bit position.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>
@@ -385,7 +385,7 @@
 			</xs:element>
 			<xs:element name="OperatingDaysDescription" type="InternationalTextStructure" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>Textual description of the operation days, e.g. "monday to friday" or "not on holidays".</xs:documentation>
+					<xs:documentation>Textual description of the operation days, e.g., "Monday to Friday" or "not on holidays".</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>

diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd
@@ -66,7 +66,7 @@
 	</xs:complexType>
 	<xs:complexType name="PlaceFareRequestStructure">
 		<xs:annotation>
-			<xs:documentation>Sub-request: PLACE related fare information. This doesn't make a lot of sense for addresses, topographic place and coordinates. However, STOP PLACE, SCHEDULED STOP POINT and POINT OF INTEREST are different.</xs:documentation>
+			<xs:documentation>Sub-request: PLACE related fare information. This doesn't make a lot of sense for addresses, topographic place, and coordinates. However, STOP PLACE, SCHEDULED STOP POINT and POINT OF INTEREST are different.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="Place" type="PlaceStructure">
@@ -81,7 +81,7 @@
 			</xs:element>
 			<xs:element ref="FareProductRef" minOccurs="0" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>Reference to a FareProduct. If no FareProductRef is specified the responding system should reply with information about all available fare products.</xs:documentation>
+					<xs:documentation>Reference to a FareProduct. If no FareProductRef is specified, the responding system should reply with information about all available fare products.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>
@@ -98,7 +98,7 @@
 			</xs:element>
 			<xs:element ref="FareProductRef" minOccurs="0" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>Reference to a FareProduct. If no FareProductRef is specified the responding system should reply with information about all available fare products.</xs:documentation>
+					<xs:documentation>Reference to a FareProduct. If no FareProductRef is specified, the responding system should reply with information about all available fare products.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>
@@ -229,7 +229,7 @@
 		<xs:sequence>
 			<xs:element name="Place" type="PlaceStructure">
 				<xs:annotation>
-					<xs:documentation>The involved PLACE. Usually a StopPoint, StopPlace or PointOfInterest.</xs:documentation>
+					<xs:documentation>The involved PLACE. Usually,a StopPoint, StopPlace or PointOfInterest.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="FareProduct" type="FareProductStructure" minOccurs="0" maxOccurs="unbounded">

diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd
@@ -156,7 +156,7 @@
 	</xs:simpleType>
 	<xs:simpleType name="PhoneType">
 		<xs:annotation>
-			<xs:documentation>Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc.</xs:documentation>
+			<xs:documentation>Type for an International phone number. + Country + MSISDN e.g., +41 675601 etc.</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="xs:normalizedString"/>
 	</xs:simpleType>
@@ -271,7 +271,7 @@
 			</xs:enumeration>
 			<xs:enumeration value="inAdvanceOnly">
 				<xs:annotation>
-					<xs:documentation>Purchase can only be made in advance of travel (e.g. for season ticket or advance ticket).</xs:documentation>
+					<xs:documentation>Purchase can only be made in advance of travel (e.g., for season ticket or advance ticket).</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="beforeBoarding">
@@ -514,20 +514,20 @@
 		<xs:sequence>
 			<xs:element name="EntitlementProduct" type="EntitlementProductStructure" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".</xs:documentation>
+					<xs:documentation>[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>
 	</xs:complexType>
 	<xs:simpleType name="EntitlementProductCodeType">
 		<xs:annotation>
-			<xs:documentation>Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority.</xs:documentation>
+			<xs:documentation>Identifier of an ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First, military card, concessionary card). It is defined by the fare authority.</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="xs:NMTOKEN"/>
 	</xs:simpleType>
 	<xs:complexType name="EntitlementProductStructure">
 		<xs:annotation>
-			<xs:documentation>[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g. military card, concessionary card, ...). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".</xs:documentation>
+			<xs:documentation>[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element ref="FareAuthorityRef">
@@ -537,7 +537,7 @@
 			</xs:element>
 			<xs:element name="EntitlementProductRef" type="EntitlementProductCodeType">
 				<xs:annotation>
-					<xs:documentation>Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...)</xs:documentation>
+					<xs:documentation>Identifier of the ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First)</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="ValidityPeriod" type="siri:HalfOpenTimestampOutputRangeStructure" minOccurs="0">
@@ -570,7 +570,7 @@
 			<xs:group ref="FareAuthorityGroup"/>
 			<xs:element name="ProtoProduct" type="xs:boolean" default="false" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g. EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/</xs:documentation>
+					<xs:documentation>Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g., EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:group ref="FareProductPriceGroup"/>
@@ -601,7 +601,7 @@
 			</xs:element>
 			<xs:element name="Currency" type="xs:NMTOKEN" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling </xs:documentation>
+					<xs:documentation>iso 4217 currency code, e.g., EUR for Euro or GBP for Pound Sterling </xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="VatRate" type="Percentage" minOccurs="0">
@@ -623,7 +623,7 @@
 			</xs:element>
 			<xs:element name="RequiredCard" type="EntitlementProductStructure" minOccurs="0" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g. the "BahnCard50" of "Deutsche Bahn".</xs:documentation>
+					<xs:documentation>One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="ValidFor" type="PassengerCategoryEnumeration" minOccurs="0" maxOccurs="unbounded">
@@ -697,7 +697,7 @@
 	</xs:group>
 	<xs:complexType name="TripFareResultStructure">
 		<xs:annotation>
-			<xs:documentation>Structure of a single TripFareResult. This may cover the whole trip or only the part the service can answer. If only partial answers can be delivered, then this must be indicated with FARE_ADDITIONALTICKETS (as a warning). For a given trip multiple FareResults may need to be combined to get the whole tariff. A typical example may be classic public transport and a sharing leg. Some legs, e.g. TransferLegs and walking ContinuousLeg will never have a price. The service may include them in one of the tickets. If the whole trip is for free, then a TripFareResult with a price of 0 is expected. It is possible to have combined FareResults (e.g. for a bundle) and in addition price each leg individually.</xs:documentation>
+			<xs:documentation>Structure of a single TripFareResult. This may cover the whole trip or only the part the service can answer. If only partial answers can be delivered, then this must be indicated with FARE_ADDITIONALTICKETS (as a warning). For a given trip multiple FareResults may need to be combined to get the whole tariff. A typical example may be classic public transport and a sharing leg. Some legs, e.g., TransferLegs and walking ContinuousLeg will never have a price. The service may include them in one of the tickets. If the whole trip is for free, then a TripFareResult with a price of 0 is expected. It is possible to have combined FareResults (e.g., for a bundle) and in addition price each leg individually.</xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
 			<xs:element name="ErrorCondition" type="OJPErrorStructure" minOccurs="0" maxOccurs="unbounded">
@@ -709,7 +709,7 @@
 			<xs:element name="BookingId" type="BookingObjectIdType" minOccurs="0"/>
 			<xs:group ref="LegRangeGroup" minOccurs="0" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>A ticket may be valid for multiple non-consequtive legs. TransferLegs and ContinuousLegs without a tariff may be either included or ignored. If the tariff depends on not having a ContinuousLeg e.g. with sharing in the middle, then the server must decide, if it wants to provide more than one TripFareResult.</xs:documentation>
+					<xs:documentation>A ticket may be valid for multiple non-consequtive legs. TransferLegs and ContinuousLegs without a tariff may be either included or ignored. If the tariff depends on not having a ContinuousLeg e.g., with sharing in the middle, then the server must decide, if it wants to provide more than one TripFareResult.</xs:documentation>
 				</xs:annotation>
 			</xs:group>
 			<xs:element name="PassedZones" type="TariffZoneListInAreaStructure" minOccurs="0">
@@ -719,7 +719,7 @@
 			</xs:element>
 			<xs:element name="FareProduct" type="FareProductStructure" minOccurs="0" maxOccurs="unbounded">
 				<xs:annotation>
-					<xs:documentation>One ore more FareProducts that are valid for this part of the trip.</xs:documentation>
+					<xs:documentation>One or more FareProducts that are valid for this part of the trip.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 			<xs:element name="StaticInfoUrl" type="WebLinkStructure" minOccurs="0" maxOccurs="unbounded">
@@ -785,7 +785,7 @@
 			</xs:element>
 			<xs:element name="FareClass" type="siri:FareClassEnumeration" minOccurs="0">
 				<xs:annotation>
-					<xs:documentation>Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). Transmodel: CLASS OF USE.</xs:documentation>
+					<xs:documentation>Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g., first class). Transmodel: CLASS OF USE.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
 		</xs:sequence>
@@ -839,7 +839,7 @@
 			</xs:enumeration>
 			<xs:enumeration value="FARE_ROUTENOTFEASIBLE">
 				<xs:annotation>
-					<xs:documentation>Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g. because of round trips, LEGs that go forth and return or exceed the maximal total trip duration.</xs:documentation>
+					<xs:documentation>Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g., because of round trips, LEGs that go forth and return or exceed the maximal total trip duration.</xs:documentation>
 				</xs:annotation>
 			</xs:enumeration>
 			<xs:enumeration value="FARE_ALREADYCOVERED">