Strings is an utility to transform and manage the diffrent localisation files from and to an iOS project and an Android project.
The obejctive-C project has 2 targets. They are meant for managing strings through an GUI interface as well as a command line one.
The core library at the moment is
- Transforming both iOS and Android translation files into Dictionaries
- Grouping together the same transaltions file from different language folders
- Grouping together iOS and Android files with the same keys in it (match >= 5).
- On conversion between the platforms will also take care of format specific convertions (%@ -> $1@ ...)
###Documentations
There are 5 classes part of the core library, which are the one doing most of the heavy lifting to aggregate and translate the files.
Those are:
- ZFTRanslationFile - Rapresentation of a language package, contaninng all the languages translations for both iOS and Android
- ZFLangFile - REpresenation of lang file. Contains as single set of translations for one lnaguage identifier and one OS
- ZFStringScanner - goes through all the forlders form a given root one and generates the ZFLangFiles
- ZFStringsConverter - Feed with a URL of a string file will generate the dicotionary of transaltions. Also will reconvert a dictionary to iOS or Android file given a URL. It is used by ZFLanfFile to generate the translations
- ZFUtils - Singletons with commons tasks. Pretty empty at the moment
Doxygen documentation is present for those 4 classes. The rest of the documentation will come later.
###Tests Tests are a bit behind
My background comes from iOS developemnt. In that sense I feel pretty confident with the import/export and translation of the files. However this project could really use some help from some more experienced Mac OS X developers to address the user interface, as well as some Android developers ot check the format conversion and the parsing of xml files.
At this stage the basic for file conversion is at a good stage. Most important features to be implemented are the keeping the order of the keys during parsing comapred with original files, and consequently tracking and parsing of the comments inside the files (at the moment both ignored).
Open Source Initiative OSI - The MIT License (MIT):Licensing [OSI Approved License] The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.