04 Wie füge ich Symboltabellen über github direkt in die Codebasis des GC Wizard hinzu?

Mit den Symbolen in der ZIP-Datei ist es noch nicht getan. Damit GC Wizard die Symbole anzeigen kann, sind weitere Schritte notwendig:

  1. die Symboltabelle ist im Dateisystem abzuspeichern
  2. die Symboltabelle ist in der englischen Sprachdatei einzupflegen
  3. die Suchstrings sind einzupflegen
  4. die Symboltabelle ist als neues Feature zu registrieren
  5. die Lizenzangaben sind einzupflegen

1. Speichern der Symboltabelle im Dateisystem

Alle Symboltabellen befinden sich unterhalb lib/tools/symbol_tables/_common/assets.

D.h. es muss ein neues Verzeichnis angelegt werden, in das die ZIP-Datei mit den einzelnen Symbolen, die Datei logo.png und ggf. die Datei config.file gespeichert werden.

Dann ist im Hauptverzeichnis die Datei pubspec.yaml im Abschnitt “assets” um den entsprechenden Eintrag “lib/tools/symbol_tables/_common/assets/<Symboltabelle>/” zu ergänzen.

2. Einpflegen der Symboltabelle in der englischen Sprachdatei

Die Sprachdateien befinden sich im Verzeichnis lib/application/i18n/assets. Hier ist nur die englische Sprachdatei en.json anzupassen. Die Übersetzung in Deutsch etc. erfolgt zu einem späteren Zeitpunkt über crowdin.

Hierzu sind zwei Einträge anzulegen:

  • symboltables_<Symboltabelle>_title mit dem Titel der Symboltabelle
  • symboltables_<Symboltabelle>_description mit einer kurzen Beschreibung der Symboltabelle

Diese Informationen werden für die Registrierung benötigt. Sofern in der Datei config.file spezielle Übersetzungen erforderlich sind, sind diese ebenfalls in der Datei en.json einzugeben.

3. Einpflegen der Suchstrings

Die Schlagwörter für die Suchstrings stehen im Verzeichnis lib/application/searchstrings/assets in den Dateien common.json und en.json.

common.json enthält alle Schlagwörter, die sprachübergreifend gelten. en.json enthält nur englische Schlagwörter. Die Übersetzung in Deutsch erfolgt zu einem späteren Zeitpunkt über crowdin.

Für die Suche sind jeweils Einträge anzulegen im Format symbol_<Symboltabelle>.

Diese Informationen werden für die Registrierung benötigt.

4. Registrieren der Sprachdatei

Damit die Symboltabelle in der App gefunden werden kann, muss sie registriert werden. Dies erfolgt in der Datei registry.dart im Verzeichnis lib/application.

Hierzu ist ein Eintrag anzulegen:

GCWSymbolTableTool(
symbolKey: '<Symboltabelle>',
symbolSearchStrings: const ['symbol_<Symboltabelle>',
]),

5. Einpflegen der Lizenzangaben

Die Lizenzangaben sind in der Datei LICENCE – liegt im Hauptverzeichnis – im Abschnitt “- Symbol Tables” zu ergänzen.