(Logo hier einfügen)
This repository provides the data foundation for the [FIPGuide](INSERT LINK HERE). Everyone is welcome to help make the information clearer, update it, or add new information. An overview of the repository’s data structure and how information can be contributed can be found in the [Wiki](INSERT LINK HERE).
Dieses Repository bildet die Datengrundlage für den [FIPGuide](LINK HIER EINFÜGEN). Jeder ist willkommen Informationen besser verständlich zu machen, zu aktualisieren oder neue hinzuzufügen. Ein Überblick über die Datenstruktur des Repositorys und wie Informationen beigetragen werden können ist im [Wiki](LINK HIER EINFÜGEN) zu finden.
####################################### Abschitt für spätere Wikiseiten #######################################
Deutsch
Die Dateien sind nach folgender Ordnerstruktur aufgebaut
information
├── companies [^1]
│ └── <company X> [^2]
│ ├── <company X>.png [^3]
│ ├── <company X>_<lang>.md [^4]
│ ├── <company X>_<lang>.json [^5]
│ └── images [^6]
│ ├── <image 1>
│ └── <image 2>
├── countries [^7]
│ ├── index_<lang>.json [^8]
│ └── <country A> [^9]
│ ├── <country A>.png [^10]
│ ├── <country A>.json [^11]
│ ├── information_<lang>.md [^12]
│ └── images [^13]
│ ├── <image 3>
│ └── <image 4>
└── general [^14]
├── generalFipGuides_<lang>.md [^15]
└── generalTravelGuides_<lang>.md [^16]Genaue technische Schemas der JSON Dateien sind im Frontend Repository zu finden.
Die Datei information/companies/<company>/<company>_<lang>.md enthält Informationen zur jeweiligen Bahngesellschaft.
Folgende Überschriften erkannt und mit dem passenden Text pro Sprache dargestellt:
generellInformationreservationsvalidityOfFipTicketssummaryOfParticularitiestrainCategoriesticketPurchasearrivalsbordersreducedTicketsspecialTariffRules
Angegebene Informationen sollten soweit möglich mit Quellen hinterlegt werden. Dazu kann eine Fußnote erstellt werden.
Information.[^1]
[^1]: QuelleDie Datei information/companies/<company>/<company>_<lang>.json enthält Metadaten die zum Anzeigen der Bahngesellschaft des Landes angegeben werden.
name: stringder geläufigste Name der Bahngesellschaft in der jeweiligen Spracheabbreviation: stringdie Abkürzung der Bahngesellschaftauthors: string[]eine Liste der Autoren der Informationen der Bahngesellschaftcreated: "YYYY-MM-DD"Datum der Erstellungedited: "YYYY-MM-DD"Datum der letzten Aktualisierung
Die Datei information/countries/index_<lang>.json enthält Metadaten die zum Anzeigen der Länder im Menü in der jeweiligen Sprache notwendig sind.
Eine Liste aus Objekten die jeweils besteht aus:
name: stringder Name des Landes in der jeweiligen Sprachepath: stringder Pfad zu Informationen des Landes
Die Datei information/countries/<country>/<country>_<lang>.json enthält Metadaten die zum Anzeigen der passenden Bahngesellschaften des Landes angegeben werden.
Sie besteht aus:
insideEu: booleangibt an, ob das Land Mitglied der europäischen Union istfipCompanys: string[]eine Liste der Bahngesellschaften des Landes die FIP akzeptieren. In der Liste muss der Pfad der Bahngesellschaft angegeben werden.nonFipCompanies: string[]eine Liste der Unternehmen, die kein FIP akzeptieren.
TOBECREATED
#########################################
Englisch
Die Dateien sind nach folgender Ordnerstruktur aufgebaut
information
├── companies [^1]
│ └── <company X> [^2]
│ ├── <company X>.png [^3]
│ ├── <company X>_<lang>.md [^4]
│ ├── <company X>_<lang>.json [^5]
│ └── images [^6]
│ ├── <image 1>
│ └── <image 2>
├── countries [^7]
│ ├── index_<lang>.json [^8]
│ └── <country A> [^9]
│ ├── <country A>.png [^10]
│ ├── <country A>.json [^11]
│ ├── information_<lang>.md [^12]
│ └── images [^13]
│ ├── <image 3>
│ └── <image 4>
└── general [^14]
├── generalFipGuides_<lang>.md [^15]
└── generalTravelGuides_<lang>.md [^16]The detailed technical schemas of the JSON files can be found in the frontend repository.
The file information/companies/<company>/<company>_<lang>.md contains information about the respective railway company.
The following headings are recognized and displayed with the appropriate text in each language:
generalInformationreservationsvalidityOfFipTicketssummaryOfParticularitiestrainCategoriesticketPurchasearrivalsbordersreducedTicketsspecialTariffRules
Information provided should be accompanied by sources where possible. A footnote can be created for this purpose.
Information.[^1]
[^1]: SourceThe file information/companies/<company>/<company>_<lang>.json contains metadata used to display the railway company for the country.
name: stringthe most common name of the railway company in the respective languageabbreviation: stringthe abbreviation of the railway companyauthors: string[]a list of the authors of the railway company informationcreated: "YYYY-MM-DD"date of creationedited: "YYYY-MM-DD"date of last update
The file information/countries/index_<lang>.json contains metadata necessary for displaying countries in the menu in the respective language. It consists of a list of objects, each containing:
name: stringthe name of the country in the respective languagepath: stringthe path to information about the country
The file information/countries/<country>/<country>_<lang>.json contains metadata used to display the relevant railway companies for the country. It consists of:
insideEu: booleanindicates whether the country is a member of the European UnionfipCompanies: string[]a list of the country's railway companies that accept FIP. The list must include the path to the railway company.nonFipCompanies: string[]a list of companies that do not accept FIP.
TOBECREATED