First release after a complete rework

Author: JustFxDev

Changelog.md

@@ -0,0 +1,5 @@
+## v0.1.0
+
+_(most recent changes are listed on top):_
+- First initial release after complete rework
+

README.md

@@ -1,2 +1,124 @@
-# php_Translation_Helper
-Excel workbook to assist creating translations form existing php languages files or create one from scratch if the project supports such files
+![north_west](./assets/north_west.svg) Use the table of contents
+
+[![version](./assets/version.svg)](https://github.com/JustFxDev/ThemeMaestro/releases) [![license](./assets/maintained.svg)](https://github.com/JustFxDev/ThemeMaestro/graphs/contributors)
+
+**:star: If you use it, you should star it on GitHub!** *It's the least you can do for all the work put into it!*
+
+:de: [Deutsche Fassung dieses Textes](./README_de.md)
+
+PHP Translation Helper (for Kanboard and other projects)
+=============================
+
+Welcome to the PHP Translation Helper workbook for the translation of PHP projects that work with translation files. 
+
+Using the Kanboard project as an example, it describes how to create a translation file in no time, e.g. for Kanboard PlugIns.
+
+This Excel workbook supports two approaches.
+
+1. there is a *translations.php* available and one would like to create a new one for another language.
+2. you want to create a *translations.php* from scratch.
+
+This documentation describes both approaches.
+
+# Translation based on an existing file
+
+In addition to the Excel workbook, the file with the source language is required also. This file content must be copied into the table in the left column (1) as pure text. Usually you will already find a `translations.php` in the corresponding folder. e.g.:
+
+![](./assets/locale_dir.png)
+
+The sample file contains only the English language and looks like this:
+
+This sample file is located here: [sample file](./example_translations.php)
+
+After opening the Excel workbook, please select the *Fileconverter* sheet first:
+
+![](./assets/have_file_avail.png)
+
+The output table for the translation looks (still) like this:
+
+![](./assets/columns.png)
+
+**Column 1**
+
+Here are the lines from *translations.php* that we want to translate.
+
+**Column 2**
+
+Contains formulas, do not enter anything there!
+
+**Column 3**
+
+Contains the translations after you copied them here (s. below)
+
+**Column 4** (colored yellow)
+
+Contains (later) the source code for the new *translations.php* file. Do not make any entries there!
+
+#### 1. Copy the text lines from translations.php to column 1.
+
+When copying, make sure that only blank text is copied. Excessive tabs or spaces do not matter.
+
+Important: Column 1 must not contain any blank lines, comments or other lines. Only the text to be translated in single quotation marks. Preferably in plain text format. In principle, however, a simple copy and paste should work.
+
+For example, if we pasted the text from Visual Studio Code, it looks like this:
+
+![](./assets/inserted_text.png)
+
+In column 1 is the copied text, in column 2 automatically the extracted text to be translated. In column 4 (yellow) we can already see the finished code, but still without translated text.
+
+#### 2. Translating the text with the help of deepl.com
+
+Now the whole(!) text is copied from **column 2**
+
+![](./assets/copy_text_to_translate.png)
+
+and will be pasted on [deepl.com](https://deepl.com) into the left box
+
+![](./assets/deepl_left_side.png)
+
+If the language is not recognized correctly, then this can be selected manually above the left box.
+
+Directly after pasting on the **left side** the translation appears on the right side. This result is now selected and copied:
+
+![](./assets/deepl_translation_right.png)
+
+into our table in **column 3**.
+
+![](./assets/deepl_in_excel.png)
+
+#### 3 . Revise the result of deepl.com and create the file
+
+The result in **column 3** should now be checked again carefully for content. Are the translations linguistically ok? Changes can be made directly in the cells of column 3 without any problems.
+
+The result script in **column 4** will be adjusted dynamically.
+
+If you are satisfied with the translation, open your favorite text editor (or Notepad) and copy the **column 4** from `?php` inclusive to `);`also inclusive.
+
+![](./assets/copy_script.png)
+
+The result is then saved in the corresponding folder of the project. Example Kanboard for the German translation:
+
+`.\locale\de_DE\translations.php`
+
+![](./assets/script_result.png)
+
+![](./assets/new_translations_file.png)
+
+That's it.
+# Create translation without source file
+
+To do this, please select the table *"From Scratch "*. **There the column 1 is omitted. **
+![](./assets/from_scratch.png)
+
+Instead of copying source data from a possibly existing *translations.php*, one enters all texts on the left side (2) oneself and lets these translate then again on https://deepl.com and copies the result into (3), revises this and copies then from (4) the text into an editor of its choice and stores this text then at the correct place.
+
+So in principle it works exactly the same as if you have a file (s. above).
+
+### Contributors
+
+- Fx - Author
+
+- Contributors to this project a very welcome!
+
+
+

README_de.md

@@ -0,0 +1,124 @@
+![north_west](./assets/north_west.svg) Use the table of contents
+
+[![version](./assets/version.svg)](https://github.com/JustFxDev/ThemeMaestro/releases) [![license](./assets/maintained.svg)](https://github.com/JustFxDev/ThemeMaestro/graphs/contributors)
+
+**:star: If you use it, you should star it on GitHub!** *It's the least you can do for all the work put into it!*
+
+
+PHP Translation Helper (für Kanboard und andere Projekte)
+=============================
+
+Willkommen zur PHP Translation Helper Mappe für die Übersetzung von PHP Projekten die mit Übersetzungsfiles arbeiten. 
+
+Am Beispiel des Kanboard Projekts wird beschrieben, wie man im Handumdrehen eine Übersetzungsdatei z. B. für Kanboard PlugIns erstellt.
+
+Die Excel Mappe unterstützt zwei Herangehensweisen.
+
+1. Es liegt breites eine *translations.php* vor und man möchte eine für eine andere Sprache erstellen
+2. Es soll eine *translations.php* von Grund auf neu erstellt werden
+
+Diese Dokumentation beschreibt beide Vorgehensweisen.
+
+# Übersetzung auf Basis einer vorhandenen Datei
+
+Neben der Excel Mappe wird zunächst die Datei mit der Ausgangssprache benötigt. Diese muss in die Tabelle in der linken Spalte (1) als purer Text einkopiert werden. In der Regel findet man bereits eine `translations.php` im entsprechenden Ordner. z. B.:
+
+![](./assets/locale_dir.png)
+
+Die Beispieldatei enthält nur die englische Sprache und sieht wie folgt aus:
+
+![](./assets/main_translation_file.png)
+
+Diese Beispieldatei befindet sich hier: [Beispieldatei](./example_translations.php)
+
+Nach dem Öffnen der Excel Mappe bitte zunächst die Tabelle *Fileconverter* auswählen:
+
+![](./assets/have_file_avail.png)
+
+Die Ausgangstabelle für die Übersetzung sieht (noch) so aus:
+
+![](./assets/columns.png)**Spalte 1**
+
+Hier kommen die Zeilen aus der *translations.php* hinein, die wir übersetzen wollen
+
+**Spalte 2**
+
+Enthält Formeln, dort keine Eingaben vornehmen!
+
+**Spalte 3**
+
+Nimmer später die Übersetzungen auf
+
+**Spalte 4** (gelb eingefärbt)
+
+Enthält (später) den Quellcode für die neue *translations.php* Datei. Dort keine Eingaben vornehmen!
+
+#### 1. Kopieren der Textzeilen aus der translations.php in Spalte 1
+
+Beim Kopieren darauf achten, dass nur blanker Text kopiert wird. Überzählige Tabs oder Leerzeichen spielen keine Rolle.
+
+Wichtig: Spalte 1 darf keine Leerzeilen, Kommentare oder sonstigen Zeilen enthalten. Nur den zu übersetzenden Text in einfachen Hochkommata. Am besten blanken Text. Grundsätzlich sollte aber auch ein einfaches kopieren und einfügen gehen.
+
+Wenn wir z. B. aus Visual Studio Code den Text eingefügt haben sieht das wie folgt aus:
+
+![](./assets/inserted_text.png)
+
+In Spalte 1 ist der einkopierte Text, in Spalte 2 automatisch der Extrahierte Text, der übersetzt werden soll. In Spalte 4 (gelb) sehen wir bereits den fertigen Code, allerdings noch ohne übersetzten Text.
+
+#### 2. Übersetzen des Textes mit Hilfe von deepl.com
+
+Nun wird der gesamte(!) Text aus Spalte 2 kopiert
+
+![](./assets/copy_text_to_translate.png)
+
+und bei [deepl.com](https://deepl.com) in der linken Box eingefügt
+
+![](./assets/deepl_left_side.png)
+
+Wenn die Sprache nicht richtig erkannt wird, dann kann dies über der linken Box oben manuell ausgewählt werden.
+
+Direkt nach dem Einfügen auf der **linken Seite** erscheint die Übersetzung auf der rechten Seite. Dieses Ergebnis wird nun ausgewählt und kopiert:
+
+![](./assets/deepl_translation_right.png)
+
+und dann in unsere Tabelle in **Spalte 3** einkopiert.
+
+![](./assets/deepl_in_excel.png)
+
+#### 3 . Das Ergebnis von deepl.com überarbeiten und die Datei erstellen
+
+Das Ergebnis in **Spalte 3** sollte jetzt noch mal inhaltlich genau geprüft werden. Sind die Übersetzungen sprachlich in Ordnung? Änderungen können in den Zellen der Spalte 3 ohne Probleme direkt vorgenommen werden.
+
+Das Ergebnis-Script in **Spalte 4** wird dynamisch angepasst.
+
+Ist man mit der Übersetzung zufrieden, dann öffnet man seinen Lieblings Texteditor (oder halt Notepad) und kopiert die **Spalte 4** von `?php`(inklusive) bis zum `);`ebenfalls inklusive.
+
+![](./assets/copy_script.png)
+
+Das Ergebnis speichert man dann im entsprechenden Ordner des Projekts. Beispiel Kanboard für die deutsche Übersetzung:
+
+`.\locale\de_DE\translations.php`
+
+![](./assets/script_result.png)
+
+![](./assets/new_translations_file.png)
+
+Das wars.
+# Übersetzung erstellen ohne Quelldatei
+
+Dazu bitte die Tabelle *"From Scratch"* auswählen. **Dort entfällt die Spalte 1**. 
+
+![](./assets/from_scratch.png)
+
+Statt des Einkopierens von Quelldaten aus einer evtl. vorhandenen *translations.php*, gibt man alle Texte auf der linken Seite (2) selber ein und lässt diese dann wieder auf https://deepl.com übersetzen und kopiert sich dann den Ergebnis Code wieder in (3) hinein, überarbeitet diesen und kopiert dann aus (4) den Text in einen Editor seiner Wahl und speichert diesen Text dann an der richtigen Stelle ab.
+
+Es funktioniert also im Prinzip ganz genau so wie wenn man eine Datei hat.
+
+### Mitwirkende
+
+- Fx - Author
+
+- Unterstützung in diesem Projekt ist willkommen!
+
+
+