WebSync – Readme’s & Changelog’s

— English version —

WebSync 5.0 introduced together with SimSync PRO 4.5 a new feature called Readme’s & Changelog’s.

This feature needs at least SimSync PRO 4.5 to work!

While Changelog’s are now for quite a long time part of the WebSync, they have until SimSync PRO 4.5 only been used to display the changes on a webpage.
This changes now and Changelog have now the chance to be more relevant for distributing information.

In addition, Readme files can now be used to give the users/drivers a general overview of the mod and who is/was involved in creating it.

Changelog – HowTo

  • To create a changelog entry, simply click on the “Index” to index the series. A series must be index first once before the log can be edited.
  • To update the changelog, click on the “Log” button of the series.
  • To define if and how changelogs should be displayed to the drivers, you can define this in the series.
  • Click on “Edit” of the series and scroll down to “Changelog mode”:
    • Manual – A changelog can be displayed manually (see the context menu of the series) if available.
    • Before – This will automatically display the changelog BEFORE the sync starts. Once it get’s displayed it will only displayed again, after the series has been re-indexed!
    • After – Similar to “before”, but the changelog will be displayed after the sync finished.

Readme – HowTo

  • To create or update a Readme, create a local “readme.txt” file, enter the content you like and upload it in the series root folder of your series.
  • If you would like have localized readme files, simply name the readme files in the following way: “readme_[2 char language code].txt”
  • e.g. readme_de.txt, readme_en.txt
    The sync will always try to display a localized readme before using the default readme.txt.
    You should always provide a normal “readme.txt”, even if localizing the readme. This normal readme.txt will be used in case there is no localization for the users language available.
    To define if and how changelogs should be displayed to the drivers, you can define this in the series.
    Click on “Edit” of the series and scroll down to “Readme mode”:
    Manual – A Readme can be displayed manually (see the context menu of the series) if available.
    Before – This will automatically display the Readme BEFORE the sync starts. Once it get’s displayed it will only displayed again, after the series has been re-indexed!
    After – Similar to “before”, but the Readme will be displayed after the sync finished.
— Deutsche Version —

WebSync 5.0 hat zusammen mit SimSync PRO 4.5 ein neues Feature namens Readme’s & Changelog’s eingeführt.

Diese Funktion benötigt mindestens SimSync PRO 4.5, um zu funktionieren!

Während Changelogs nun schon seit geraumer Zeit Teil des WebSync sind, wurden sie bis SimSync PRO 4.5 nur zur Anzeige der Änderungen auf einer Webseite verwendet.
Dies ändert sich jetzt und der Changelog hat nun die Chance, für die Informationsverteilung relevanter zu werden.

Darüber hinaus können nun Readme-Dateien verwendet werden, um den Benutzern/Fahrern einen allgemeinen Überblick über den Mod zu geben und wer an der Erstellung beteiligt war/ist.

Changelog – HowTo

  • Um einen Changelog-Eintrag zu erstellen, klicken Sie einfach auf den “Index”, um die Serie zu indizieren. Eine Serie muss zuerst indiziert werden, bevor das Protokoll bearbeitet werden kann.
  • Um das Changelog zu aktualisieren, klicken Sie auf den Button “Log” der Serie.
  • Um festzulegen, ob und wie Änderungsprotokolle den Fahrern angezeigt werden sollen, können Sie dies in der Serie definieren.
  • Klicken Sie auf “Bearbeiten” der Serie und scrollen Sie nach unten zu “Changelog-Modus”:
    • Manuell – Ein Changelog kann manuell angezeigt werden (siehe Kontextmenü der Serie), falls verfügbar
    • .Vorher – Dadurch wird das Changelog automatisch angezeigt, BEVOR die Synchronisierung beginnt. Sobald es angezeigt wurde, wird es erst wieder angezeigt, nachdem die Serie neu indiziert wurde!
    • Nachher – Ähnlich wie “vorher”, aber das Changelog wird angezeigt, nachdem die Synchronisation abgeschlossen ist.

 

ReadmeHowTo

  • Um ein Readme zu erstellen oder zu aktualisieren, erstellen Sie eine lokale “readme.txt”-Datei, geben Sie den gewünschten Inhalt ein und laden Sie ihn in den Serienstammordner Ihrer Serie hoch.
  • Wenn Sie lokalisierte Readme-Dateien möchten, benennen Sie die Readme-Dateien einfach wie folgt: ” readme_[2 Zeichen Sprachcode].txt” z.B. readme_de.txt, readme_en.txt
    Die Synchronisation wird immer versuchen, eine lokalisierte Readme Datei anzuzeigen, bevor sie die Standard readme.txt verwendet.
  • Sie sollten immer eine normale “readme.txt” angeben, auch wenn Sie das Readme lokalisieren. Diese normale readme.txt wird verwendet, wenn es keine Lokalisierung für die verfügbare Benutzersprache gibt.
  • Um festzulegen, ob und wie Änderungsprotokolle den Fahrern angezeigt werden sollen, können Sie dies in der Serie definieren.
  • Klicken Sie auf “Bearbeiten” der Serie und scrollen Sie nach unten zum “Readme-Modus”:
    • Manuell – Ein Readme kann manuell angezeigt werden (siehe Kontextmenü der Serie), falls vorhanden.
    • Vorher – Dies zeigt automatisch die Readme Datei an, BEVOR die Synchronisierung beginnt. Sobald es angezeigt wird, wird Sie erst wieder angezeigt, nachdem die Serie neu indiziert wurde!
    • Nachher – Ähnlich wie “vorher”, aber die Readme wird angezeigt, nachdem die Synchronisation abgeschlossen ist.