Skip to content

Commit

Permalink
Improve README (#456)
Browse files Browse the repository at this point in the history
* Improve README

* Remove manual line wraps

* Remove more manual line wraps
  • Loading branch information
sgrossberndt authored Sep 5, 2024
1 parent c8afc28 commit ef733bc
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
# OJP - *O*pen API for distributed *J*ourney *P*lanning

## Content
This repository contains the XSD, examples and documentation tables for the
"**O**pen API for distributed **J**ourney **P**lanning" published as
*"CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning"*.
This repository contains the XML Schema, examples and documentation tables for the "**O**pen API for distributed **J**ourney **P**lanning" published as *"CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning"*.

OJP consists of a set of services that can be addressed using HTTP requests.

Expand All @@ -20,41 +18,42 @@ The main services to request information are:
* Information about lines

OJP systems interacting with each other additionally use:
* Getting information about Exchange Points (places when a Trip switches from one OJP system to another)
* Using a multi point trip service (n origins and m destinations)

* Getting information about Exchange Points (places when a trip switches from one OJP system to another)
* Using a multipoint trip service (n origins and m destinations)

## Standard document
OJP is a CEN standard. Obtain a copy of the standard document
["CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning"](https://standards.cen.eu/dyn/www/f?p=204:110:0::::FSP_PROJECT:62236&cs=1985DBD613F25D179FB65A73B0FDA4DB7)
at [CEN](https://www.cen.eu).
OJP is a CEN standard. Obtain a copy of the standard document ["CEN/TS 17118:2017: "Intelligent transport systems - Public transport - Open API for distributed journey planning"](https://standards.cen.eu/dyn/www/f?p=204:110:0::::FSP_PROJECT:62236&cs=1985DBD613F25D179FB65A73B0FDA4DB7) at [CEN](https://www.cen.eu).

OJP is part of the [Transmodel](https://www.transmodel-cen.eu/)) family of standards together with [NeTEx](https://netex-cen.eu/), [SIRI](https://www.transmodel-cen.eu/siri-standard/) and OPRA. It also contains elements from [DATEX II](https://datex2.eu/).
OJP is part of the [Transmodel](https://www.transmodel-cen.eu/) family of standards together with [NeTEx](https://netex-cen.eu/), [SIRI](https://www.transmodel-cen.eu/siri-standard/) and [OpRa](https://www.opra-cen.eu/). It also contains elements from [DATEX II](https://datex2.eu/).

## Releases
* [OJP 1.0](https://github.com/VDVde/OJP/releases/tag/v1.0): The version described in CEN/TS 17118:2017
* [OJP 1.0.1](https://github.com/VDVde/OJP/releases/tag/v1.0.1): Bug fix release
* OJP 2.0 in preparation. See the following [branch](https://github.com/VDVde/OJP/tree/changes_for_v1.1) .

## Github Repository
* [OJP 1.0.1](https://github.com/VDVde/OJP/releases/tag/v1.0.1): Bugfix release
* OJP 2.0 is being prepared in [the develop-branch](https://github.com/VDVde/OJP/tree/develop)

## GitHub Repository
Download the XSD schema files and examples in the git repository found at https://github.com/VDVde/OJP and take a look at the [documentation tables](https://vdvde.github.io/OJP/index.html).

You can contribute by:
* Pointing out [issues](https://github.com/VDVde/OJP/issues)
* Creating pull requests: Use the [development documentation](https://github.com/VDVde/OJP/wiki/WG:-:-Working-with-this-repository)

### Branches
* The master branch is currently set to OJP 1.0.1
* Development occurs currently in the changes_for_v1.1 branch.
* The main branch currently contains OJP 1.0.1
* Development is done in [the develop branch](https://github.com/VDVde/OJP/tree/develop).

### Wiki
OJP uses the [wiki](https://github.com/VDVde/OJP/wiki) on github for some resources and examples.
OJP uses the [wiki](https://github.com/VDVde/OJP/wiki) on GitHub for some resources and examples.

### White papers
The [white papers](https://github.com/VDVde/OJP/wiki/Whitepapers-on-OJP) are published in the wiki as well.
The [white papers](https://github.com/VDVde/OJP/wiki/Whitepapers-on-OJP) are published in the wiki as well.

### Other sources
The wiki also contains links to other sources and [implementations](https://github.com/VDVde/OJP/wiki/Implementations-and-Tests).

## Regulatory environment of OJP
The ITS Directive Delegated Regulation for provision of EU-wide multimodal travel information services is the legal framework for travel data access and distributed journey planning in Europe. This initiative will provide the necessary requirements to make EU-wide multimodal travel information services accurate and available across borders. One of the key requirements concerns linking travel information services for distributed journey planning. Upon request, travel information service providers shall provide to another information service provider "routing results" based on static, and where possible, dynamic information. The "routing results" shall be based on:
The "[ITS Directive Delegated Regulation for provision of EU-wide multimodal travel information services](https://transport.ec.europa.eu/transport-themes/smart-mobility/road/its-directive-and-action-plan/multimodal-travel-information_en)" is the legal framework for travel data access and distributed journey planning in Europe. This initiative will provide the necessary requirements to make EU-wide multimodal travel information services accurate and available across borders. One of the key requirements concerns linking travel information services for distributed journey planning. Upon request, travel information service providers shall provide to another information service provider "routing results" based on static, and where possible, dynamic information.
The "routing results" shall be based on:
* the enquirers start and end points of a journey along with the specific time and date of departure or arrival, or both;
* possible travel options along with the specific time and date of departure or arrival, or both, including any possible connections;
* the handover point between travel information services;
Expand Down

0 comments on commit ef733bc

Please sign in to comment.