01 Wie unterstütze ich mit Symboltabellen?

Natürlich freuen wir uns über Hilfe – insbesondere was die zahlreichen Symboltabellen betrifft. Aber dabei gibt es einiges zu beachten bzgl.

  • Quellen/Lizenzangaben => hier ist eine zusätzliche Datei erforderlich: licence.file
  • Symbol-Dateien
  • logo-Datei
  • Dateinamen
  • Besonderheiten bei den Dateinamen => hier ist eine zusätzliche Datei erforderlich: config.file
  • Meta-Daten => hier ist eine zusätzliche Datei erforderlich: metadata.file

was ich im folgenden näher beschreiben will.

Zum Schluss packt ihr alle Dateien in eine ZIP-Archivdatei und schickt uns diese bspw. an geocache.wizard [at] gmail.com.

Für die Profis gibt es auch die Option, über github direkt die Symboltabelle in die App einzubauen und damit alle Änderungen vorzunehmen. Dies ist hier beschrieben: https://blog.gcwizard.net/manual/uncategorized/04-wie-fuge-ich-symboltabellen-uber-github-direkt-in-die-codebasis-des-gc-wizard-hinzu/

Quellen für die Symboltabellen/Lizenzangaben

Die Quellen für die Symbole sollten frei verfügbar sein oder es muss eine explizite Erlaubnis vorhanden sein, diese Symbole zu benutzen. Die beste Quelle dafür ist die Wikipedia bzw. deren Medien-Speicher, die Wikimedia Commons. Des weiteren haben wir die Erlaubnis, die alten myGEOtools-Tabellen zu benutzen. Es gibt sicherlich noch eine Reihe mehr möglicher Quellen.

KEINE Quelle ist kryptografie.de, wo wir leider eine explizite Ablehnung der Zusammenarbeit bekommen haben!

Die Quellenangaben schreibt ihr bitte in eine Text-Datei licence.file, die ihr mit den Symbolen speichert. Die wichtigsten Angaben sind:

  • Name des Urhebers
  • Link zur Quelle
  • Art der Lizenz – bspw. GPL, CC-BY-SA 3.0, CC BY-NC-SA 4.0, Personal Use, non commercial , SIL OPEN FONT LICENSE Version 1.1, Apache License Version 2.0, etc.

Symbole

  • Die Bilder werden als PNG-Datei gespeichert.
  • Die Bilder sind im Optimalfall 150×150 Pixel groß. Wichtig ist auf jeden Fall, dass die Höhe eingehalten wird. Wenn die Originalquelle diese Auflösung nicht hergibt, kann man natürlich nichts machen. Wichtig ist auch die Farbwahl. Wenn Schwarz/Weiß ausreichend ist, solltet ihr es dabei belassen. Dies spart Speicherplatz.
  • Bitte darauf achten, dass die Symbole einigermaßen gleichmäßig ausgerichtet sind, damit sie nachher im Gesamtbild geordnet wirken – und nicht ein Symbol am rechten Rand klebt und das nächste oben, usw.
  • Habt ihr die Symbole als TrueType-Font, gibt es eine elegante Lösung, diesen Zeichensatz in PNG-Dateien zu exportieren. Dies ist hier beschrieben: https://blog.gcwizard.net/manual/uncategorized/03-wie-konvertiere-ich-truetype-fonts-in-symbole/.
    Aber auch OTF – OpenType Fonts – sind nützlich. Diese sind vorher nach TTF zu konvertieren. Bspw. mit Convert otf to ttf | Everything Fonts.
  • Schön wäre es auch, wenn die Bilder einen transparenten Hintergrund hätten. Das erleichtert später eine mögliche Designumstellung, wo die Symbole vielleicht mit einer anderen Farbe hinterlegt werden sollen. Ist aber momentan nicht angedacht. Deswegen ist es auch nicht schlimm, wenn ihr die Symbolbildchen mit weißem Hintergrund liefert. Grafisch Unerfahrenere tun sich bei diesem Schritt oft schwer und scheuen dann die ganze Arbeit. Also bitte davon nicht abschrecken lassen, das ist ein Nice-To-Have. Allerdings kann man diese Arbeit mit Irfan View vereinfachen. Dies ist hier beschrieben: https://blog.gcwizard.net/manual/uncategorized/02-wie-optimiere-ich-die-dateigrose-und-farbtiefe-von-symbolen-mit-irfanview/

Logo-Datei

Damit die Symboltabelle auch erkannt werden kann, benötigt jede Symboltabelle ein Logo. Sucht bitte eine aussagekräftige Symbol-Datei aus und kopiert diese und nennt sie dann in logo.png um.

Dateiname

Der Dateiname sollte angeben, was das Symbol darstellt.

  • Bei Kleinbuchstaben wird ein “_” davorgestellt.
  • Bei Sonderzeichen wird der entsprechende englische Name genutzt. Bspw. ampersand, degree, percent, …
    Die aktuelle Liste der direkt unterstützten Sonderzeichen ist auf github hinterlegt.

    Also A.png, _x.png, _ch.png, SCH.png, 0.png, 1000.png, percent.png, UE_umlaut, U_circumflex.png, etc.
  • Falls ihr neue Dateinamen oder andere Besonderheiten benötigt, ist eine weitere Datei erforderlich: config.file

Besonderheiten bei den Dateinamen – config.file

Die Datei config.file – eine reine Text-Datei – beschreibt spezielle Aktionen, die für eine korrekte Anzeige der Symboltabelle erforderlich sind. Diese Aktionen sind

special_mappingsDer Name der Symbol-Datei ist mit einem speziellen Zeichen verbunden.
Beispiel:
{
   "special_mappings" : {
      "add_h" : "+H"
   }
}
translateDer Name der Symbol-Datei ist zu übersetzen.
Beispiel
{
"translate" : [
"air",
"iron_oxide",
"kaolin"
]
}
translation_prefixSofern es bereits Übersetzungen gibt, kann hier der passende Präfix angegeben werden.
Beispiel
{
   "case_sensitive" : false,
   "translation_prefix  "common_color_
   "translate" : [
       "white",
       "black",
       "red",
       "yellow",
       "blue",
       "orange",
       "green"
   ]
}
case_sensitiveBei der Darstellung der Symbole ist Groß- und Kleinschreibung zu berücksichtigen.
Beispiel
{
   "case_sensitive" : true
}

Meta-Daten – metadata.file

In dieser Text-Datei sollten weitere Daten zur Symboltabelle bereitgestellt werden. Dazu gehören bspw.

  • Titel/Name
  • Beschreibung
  • Schlagwörter für die Suche