Deutsch
Dieses Wiki beschreibt, wie Informationen im FIPGuide angepasst und hinzugefügt werden können. Bei weiteren Fragen helfen wir unter [email protected] 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 Bearbeitung 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 [email protected] oder nutze unser Kontaktformular
Der aktuellen Bearbeitungsstand der Informationen für Betreiber ist hier zu finden: Content Status
Diese Github-Seite des Projekts und ihr Inhalt wird im folgenden als Repository bezeichnet.
- Um Informationen bearbeiten zu können, musst du mit deinem GitHub Konto angemeldet sein. Wenn du noch kein kostenloses Konto besitzt, erstelle dir eins.
- Zur Qualitätssicherung kann nicht jeder direkt in diesem Repository Informationen bearbeiten. Daher musst du dir vor der ersten Bearbeitung einen Fork erstellen. Um einen Fork des Repositorys zu erstellen, öffne es zunächst: https://github.com/fipguide/fipguide.github.io
- Erstelle einen Fork mit dem Button Fork:
- Wenn du bereits einen Fork in der Vergangenheit des Projekts erstellt hast, wird kein neuer Fork benötigt. Bitte aktualisiere deinen Fork aber über den Button Sync Fork:
- 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:
- Du verfügst jetzt über deine persönliche Kopie des FIPGuides. Um Dateien zu bearbeiten drücke die Taste "." auf der Tastatur während du deinen Fork geöffnet hast oder ändere das ".com" in der URL zu ".dev" (https://github.com/YOURNAME/fipguide.github.io wird zu https://github.dev/YOURNAME/fipguide.github.io). Hier kannst du Dateien bearbeiten. Mehr dazu in unter Informationen bearbeiten. Du kannst auch die Preview Fuktion nutzen, um eine Vorschau deiner Änderungen zu sehen.
- Nach deiner Bearbeitung der Dateien kannst du die Quellcodeverwaltung im Menü auf der linken Seite öffnen. Hier findest du einer Übersicht über alle deine vorgenommen Änderungen. Bitte stelle sicher, dass nur beabsichtigte Änderungen in dieser Übersicht sichtbar sind. Anschließend kannst du eine Nachricht eingeben. Diese dient als Kurzinfo über deiner vorgenommenen Änderungen zur späteren Identifizierung. Um die Anpassung zu Speichern drücke auf den Button Commit und Push, um die Änderungen in deinem Fork zu speichern:
- Wechsel nun zurück in deinen Fork. Drücke dazu das Menü links und wähle Zu Repository wechseln:
- Nun kannst du zum späteren Zeitpunkt erneut Bearbeitungen vornehmen. Wenn die Änderungen auf der FIPGuide Website angezeigt werden sollen, müssen die Änderungen aus dem Fork in das Hauptrepository/projekt der Website überführt werden. Nutze dafür die Funktion Contribute -> Open Pull Request:
- Hier kann jetzt die Überführung der Änderungen angefordert werden (Pull Request). Wir prüfen alle eingehenden Änderungen auf fachliche und technische Korrektheit. Im Idealfall gibst du uns dafür eine passende Überschrift und bei Bedarf Details zu den Änderungen im Beschreibungsfeld. Anschließend kannst du deine Änderungen an uns übermitteln:
- Solange deine Änderungen noch nicht akzeptiert sind kannst du jederzeit noch Änderungen vornehmen, die Teil deines Pull Requests werden. Wir prüfen deine Änderungen und übernehmen sie anschließend in die Hauptwebsite. Vielen Dank für deiner Unterstützung. 🎉
Die Dateien sind nach folgender Ordnerstruktur aufgebaut
FIPGuide
├── ... (nicht relevant für fachliche Inhalte)
├── content
│ ├── country #1
│ │ └── <country X> #2
│ │ ├── images #3
│ │ │ └── <image X>.webp #4
│ │ ├── index.de.md #5
│ │ └── index.en.md #6
│ ├── news #7
│ │ └── <news X> #8
│ │ ├── images #9
│ │ │ └── <image X>.webp #10
│ │ ├── image.webp #11
│ │ ├── index.de.md #12
│ │ └── index.en.md #13
│ ├── operator #14
│ │ └── <operator X> #15
│ │ ├── images #16
│ │ │ └── <image X>.webp #17
│ │ ├── logo.webp #18
│ │ ├── index.de.md #19
│ │ └── index.en.md #20
│ └── ... (weitere Dateien für Datenschutzerklärung, Impressum, Kontakt, Startseite, ...)
├── ... (nicht relevant für fachliche Inhalte)#1: Übergeordneter Ordner für Länder.
#2: Ein Ordner pro Land für Informationen über dieses. Bezeichnung: Englischer Name des Landes
#3: Bilderordner des Landes. Bezeichnung: images
#4: Alle Bilder eines Landes, bevorzugt im .webp Format.
#5: Artikel mit Landesinformationen in deutscher Sprache. Bezeichnung: index.de.md
#6: Artikel mit Landesinformationen in englischer Sprache. Bezeichnung: index.en.md
#7: Übergeordneter Ordner für Newsartikel.
#8: Ein Ordner pro Newsartikel. Bezeichnung: aufsteigende Zahl
#9: Zusätzlicher Bilderordner des Newsartikels. Optional bei Bedarf. Bezeichnung: images
#10: Zusätzliche Bilder eines Newsartikels, bevorzugt im .webp Format.
#11: Vorschaubild eines Newsartikels welches auf der Artikelseite und in der Vorschau auf der Startseite angezeigt wird im .webp Format.
#12: Newsartikel in deutscher Sprache. Bezeichnung: index.de.md
#13: Newsartikel in englischer Sprache. Bezeichnung: index.en.md
#14: Übergeordneter Ordner für Bahnbetreiber.
#15: Ein Ordner pro Bahnbetreiber für Informationen über diesen. Bezeichnung: Abkürzung des Bahnbetreibers
#16: Bilderordner des Bahnbetreibers. Bezeichnung: images
#17: Alle Bilder eines Bahnbetreibers, bevorzugt im .webp Format.
#18: Logo des Bahnbetreiber als .webp mit transparentem Hintergrund. Bezeichnung: logo.webp
#19: Artikel mit Informationen zum Bahnbetreiber in deutscher Sprache. Bezeichnung: index.de.md
#20: Artikel mit Informationen zum Bahnbetreiber in englischer Sprache. Bezeichnung: index.en.md
Für das Schreiben von Textinhalten wird das Markdown Format genutzt. Markdown ist eine einfache Auszeichnungssprache, die es ermöglicht, Text in einem leicht lesbaren und bearbeitbaren Format zu schreiben. Im Internet sind zahlreiche Anleitungen für die Formattierung mit Markdown zu finden, z.B. der Github Markdown Guide.
Inhalte in verschiedenen Sprachen werden durch die Verwendung von Sprachkürzeln in den Dateinamen codiert. Beispielsweise wird eine deutsche Version einer Datei mit dem Suffix .de.md und eine englische Version mit dem Suffix .en.md versehen. Diese Suffixe werden automatisch erkannt und die Inhalte werden in der entsprechend Spracheinstellungen der Website dargestellt.
Es dürfen nur lizenzfreie Bilder verwendet werden, die für nicht-kommerzielle Nutzung freigegeben sind. Im Idealfall sollten diese Bilder keine Urhebernennung erfordern. Falls eine Urhebernennung notwendig ist, muss der Name des Erstellers im Text beim Bild angegeben werden.
Bestehende Informationen im Markdown Format können einfach angepasst werden. Wenn möglich sollten Informationen immer mindestens in Deutsch und Englisch angepasst werden.
Die bestehenden Vorlagen und Strukturen können als Orientierung genutzt werden, Abweichungen vom Standard sind in angemessenen Situationen möglich. Ein einheitliches Gesamtbild sollte jedoch zur einfacheren Orientierung versucht werden zu bewahren.
Eine Textseite beginnt immer mit einem Abschnitt aus mindestens folgenden Metadaten:
---
date: "<Datum im Format YYYY-MM-DD>"
draft: <Veröffentlichungsstatus true/false>
title: "<Landesname oder Abkürzung der Bahngesellschaft in Sprache der Seite>"
---
Bitte update das date auf das aktuelle Datum, wenn du Informationen anpasst.
Soweit möglich sollen Informationen mit einer Quelle belegt werden:
Diese Information soll belegt werden. [^1]
... Am Ende der Seite...
[^1]: [Meine Quellenwebsite](https://www.bahn.de)
Beim Bearbeiten einer Bahngesellschaft sind zusätzlich folgende Metadaten zu beachten:
country:
- "<Name des Landes wo der Betreiber fährt in Englisch 1>"
- "<Name des Landes wo der Betreiber fährt in Englisch 2>"
Die zusätzlichen Metadaten sind wichtig für die Zuordnung zwischen Betreiber <-> Land und zur automatischen Menügenerierung.
Beim Bearbeiten eines Landes sind zusätzlich folgende Metadaten als Gegenstück zur Bahngesellschaft zu beachten:
country: "<Name des Landes in Englisch>"
Die zusätzlichen Metadaten sind wichtig für die Zuordnung zwischen Betreiber <-> Land und zur automatischen Menügenerierung.
Bestimmte Formatierungen können nativ nicht mit Markdown realisiert werden und erfordern benutzerdefinierte HTML Formatierungen. Einige Anwendungsfälle sind bereits als eigene FIP Vorlagen definiert:
Um Informationen nicht direkt anzuzeigen, sondern ausklappbar zu gestalen, kann der expander Shortcode verwendet werden.
{{< expander "<Überschrift>" >}}
<Ausgeklappter Text>
{{< /expander >}}
Beispiel:
Um bestimmte Informationen hervorzuheben oder zu kennzeichnen kann der Shortcode highlight verwendet werden. Dabei sind die Hervorhebungsoptionen tip, inofficial und important verfügbar:
{{< highlight "<Hervorhebungsoption>" >}}
<hervorgehobener Text>
{{< /highlight >}}
Beispiel:
Zusätzlich sind weitere vordefinierte Shortcodes verfügbar. Weitere eigene Spezialformatierungen können mithilfe von HUGO Shortcodes erstellt werden.
Beim Hinzufügen von neuen Inhalt muss zunächst ein neuer Ordner für das Land oder die Bahngesellschaft angelegt werden (Siehe Ordnerstruktur). Anschließend kann für die Erstellung der Informationen die Vorlagen aus dem Ordner /archetypes/ genutzt werden. Dabei sollte auch das Ausfüllen der erforderlichen Metadaten beachtet werden. Bei Bahngesellschaften und Newsartikel sollte auch das passende Logo bzw. Vorschaubild als .webp hinterlegt werden.
Der FIPGuide nutzt HUGO als Website Generator. Für tiefergreifende Anpassungen und Formatierungen empfehlen wir die offizielle Dokumentation oder einen der vielen weiteren Anleitungen im Internet.
Hier werden noch häufige Fragen eingefügt.