mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-06 21:00:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

README update

Browse Source
This commit is contained in:
Greg DiCristofaro 2021-01-22 15:20:35 -05:00
parent c2d6f0520d
commit 55b5a58d6f
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
release_scripts/localization_scripts/README.md
View File

@ -7,11 +7,15 @@ This folder provides tools to handle updates of bundle files for language locali
All of these scripts provide more details on usage by calling the script with `-h`.
## Dependencies
These scripts require the python libraries: gitpython, jproperties, pyexcel-xlsx, xlsxwriter and pyexcel along with python >= 3.9.1. The virtual environment to set up dependencies can be activated with venv/Scripts/activate. As a consequence of gitpython, this project also requires git >= 1.7.0.
## Basic Localization Update Workflow
1. Call `python3 diffscript.py <output path> -l <language>` to generate a file containing differences in properties file values from the language's previous commit to the `HEAD` commit. The language identifier should be the abbreviated identifier used for the bundle (i.e. 'ja' for Japanese). The output path should be specified as a relative path with the dot slash notation (i.e. `./outputpath.xlsx`) or an absolute path.
2. Update csv file with translations
3. Call `python3 updatepropsscript.py <input path> -l <language>` to update properties files based on the newly generated file. The file should be formatted such that the columns are bundle relative path, property files key, original value (or empty column), translated value and commit id for the latest commit id for which these changes represent. The commit id only needs to be in the header row. The output path should be specified as a relative path with the dot slash notation (i.e. `./outputpath.xlsx`) or an absolute path.
1. Call `python3 diffscript.py <output path> -l <language> -td <last language update commit id>` to generate a file containing differences in properties file values from the language's previous commit to the `HEAD` commit. The language identifier should be the abbreviated identifier used for the bundle (i.e. 'ja' for Japanese). The last language update commit id is the SHA-1 commit id for the last time this language (i.e. ja/Japanese) was last updated. The program will try to cross-reference English values with the corresponding language values from the last known point of consistency to automatically determine some translations. For this reason, it is important that the language file values (i.e. Bundle_ja.properties) are consistent with the English values at the commit id recorded in lastupdated.properties. The output path should be specified as a relative path with the dot slash notation (i.e. `./outputpath.xlsx`) or an absolute path.
2. Update the generated file(s) with translations where needed.
3. Call `python3 updatepropsscript.py <input path> -l <language>` to update properties files based on the newly generated file. The file should be formatted such that the columns are the bundle's relative path to the repo, the property files key, the original value (or empty column), the translated value and commit id for the earliest and latest commit id for which these changes represent. The commit id only needs to be in the header row. The output path should be specified as a relative path with the dot slash notation (i.e. `./outputpath.xlsx`) or an absolute path.
## Localization Generation for the First Time
First-time updates should follow a similar procedure except that instead of calling `diffscript.py`, call `python3 allbundlesscript <output path>` to generate a file with relative paths of bundle files, property file keys, property file values. The output path should be specified as a relative path with the dot slash notation (i.e. `./inputpath.xlsx`) or an absolute path.