Skip to content

Deutsch

Jump to bottom
lennartrommeiss edited this page Feb 11, 2025 · 19 revisions

Einstieg

Dieses Wiki beschreibt, wie Informationen im FIPGuide angepasst und hinzugefügt werden können. Bei weiteren Fragen helfen wir unter nextstop@fipguide.org gerne.

Dieser Guide richtet sich an Nutzerinnen und Nutzer ohne Vorerfahrung in der Nutzung von GitHub. Wenn du bereits Erfahrung mitbringst, kannst du deine eigene Entwicklungsumgebung nutzen und direkt zur Ordnerstruktur springen, um zu sehen, welche Dateien du anpassen kannst.

Wenn du Informationen beitragen möchtest, ohne sie selbst zu bearbeiten, schicke sie uns gerne einfach an nextstop@fipguide.org oder nutze unser Kontaktformular

Vorbereitung

Diese Github-Seite des Projekts und ihr Inhalt wird im folgenden als Repository bezeichnet.

  1. Um Informationen bearbeiten zu können, musst du mit deinem GitHub Konto angemeldet sein. Wenn du noch kein kostenloses Konto besitzt, erstelle dir eins.
  2. Zur Qualitätssicherung kann nicht jeder direkt in diesem Repository Informationen bearbeiten. Daher musst du dir zuerst einen Fork erstellen. Um einen Fork des Repositorys zu erstellen, öffne es zunächst: https://github.com/fipguide/fipguide.github.io
  3. Erstelle einen Fork mit dem Button Fork: Fork erstellen
  4. Erstelle den Fork im Bereich deines persönlichen Nutzers als Owner. Die anderen Felder sind optional und können die Standardwerte behalten. Der Fork kann mit Create Fork jetzt erstellt werden: Fork erstellen Details
  5. Du verfügst jetzt über deine persönliche Kopie des FIPGuides,

Informationen bearbeiten

Ordnerstruktur

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]

[^1]: Ordner für Informationen über Bahngesellschaften [^2]: Eine bestimmte Bahngesellschaft z.B. DB, SNCF oder PKP [^3]: Das Logo der Bahngesellschaft als PNG Datei [^4]: Der Informationstext über die Bahngesellschaft pro Sprache. Infos zur Datei unter Dateiformate [^5]: Metadaten für die Bahngesellschaft pro Sprache. Infos zur Datei unter Dateiformate [^6]: Ordner für Bilder die auf der Seite der Bahngesellschaft angezeigt werden soll [^7]: Ordner für Informationen über Länder. [^8]: Metadaten über die Länder pro Sprache. Notwendig zur Generierung des Menüs im FIPGuide. Infos zur Datei unter Dateiformate [^9]: Ein bestimmtes Land z.B. Deutschland, Frankreich oder Polen. [^10]: Die Flagge des Landes in 72x72 Pixel PNG Datei. Zur Zeit wird twemoji genutzt. [^11]: Metadaten für das Land. Notwendig zum Anzeigen der dazugehörigen Bahngesellschaften. Infos zur Datei unter Dateiformate [^12]: Der Informationstext über das Land pro Sprache. Infos zur Datei unter Dateiformate [^13]: Ordner für Bilder die auf der Seite des Landes angezeigt werden sollen [^14]: Ordner für allgemeine Informationen auf der Seite des FIPGuides [^15]: Allgemeine Informationen über das Reisen mit FIP [^16]: Allgemeine Informationen zum Zugfahren in Europa

Dateiformate

Genaue technische Schemas der JSON Dateien sind im Frontend Repository zu finden.

Bahngesellschaft Informationen

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:

  • generellInformation
  • reservations
  • validityOfFipTickets
  • summaryOfParticularities
  • trainCategories
  • ticketPurchase
  • arrivals
  • borders
  • reducedTickets
  • specialTariffRules

Angegebene Informationen sollten soweit möglich mit Quellen hinterlegt werden. Dazu kann eine Fußnote erstellt werden.

Information.[^1]

[^1]: Quelle

Bahngesellschaft Metadaten

Die Datei information/companies/<company>/<company>_<lang>.json enthält Metadaten die zum Anzeigen der Bahngesellschaft des Landes angegeben werden.

  • name: string der geläufigste Name der Bahngesellschaft in der jeweiligen Sprache
  • abbreviation: string die Abkürzung der Bahngesellschaft
  • authors: string[] eine Liste der Autoren der Informationen der Bahngesellschaft
  • created: "YYYY-MM-DD" Datum der Erstellung
  • edited: "YYYY-MM-DD" Datum der letzten Aktualisierung

Länder Index

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: string der Name des Landes in der jeweiligen Sprache
  • path: string der Pfad zu Informationen des Landes

Land Metadaten

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: boolean gibt an, ob das Land Mitglied der europäischen Union ist
  • fipCompanys: 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.

Land Informationen

TOBECREATED

Need help? For questions and issues, we're happy to assist: https://fipguide.org/en/contact
Du brauchst Hilfe? Bei Fragen und Problemen helfen wir gerne: https://fipguide.org/de/contact

Clone this wiki locally