# language-tool

**Repository Path**: mijack/language-tool

## Basic Information

- **Project Name**: language-tool
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2015-10-13
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 语言包工具使用说明

## 简介
语言包工具（下称`TL`）是基于java实现的将csv文件的语言转化成对应平台（Android/iOS）上的字符串资源文件的工具。

## 运行环境说明
Java version 1.6及以上，建议使用java 1.8

## 运行

将语言包源文件（csv格式，编码方式为UTF-8）和LT jar文件以及配置文件（xml）置于同一个目录下，运行以下命令即可，其中配置文件可以不设置，默认为`language.xml`，android、iOS的配置文件分别为`language-android.xml`、`language-ios.xml`，运行对应的`sh`或`bat`程序即可。

```
java -Dfile.encoding=utf-8 -jar LanguageTool-2.0-SNAPSHOT.jar [配置文件名]
```
## 配置文件说明
配置文件为`xml`格式，分别对输入和输出进行了描述，对应于config节点下的input、output

### 输入描述
输入描述主要包括如下几个部分：

|节点|说明|
|--|--|
|csv-file|scv文件的基本信息，包括名称、编码格式等|
|commit|关于评论的描述|
|key|新key的index|
|old-key|旧的key的index|
|languages|语言描述的集合，其子节点对应每一种语言在csv文件中的index、语种、简称、前缀，其中简称和前缀可用于输出文件的命名|

## 输出描述

输出描述（output）其属性主要是输出文件夹`output-dir`，主要由若干个rule组成，一个rule对应一个平台上的输出规则，主要包括如下几个部分：

|节点|说明|
|--|--|
|rule的属性|rule的命名、输出文件夹、输出文件名，可以使用输入的language节点的简称和前缀属性|
|key-transform|输出时对key的处理，有upper、lower、default|
|commit-sample|对于输出的注释的格式约定|
|values-samples|对于输出的值的格式约定，主要有默认、新的key以及更改的key|
|file-head、file-end|输出文件的头部和尾部，用于android的xml节点|
|replaces|输出时对string的文本替换|

## 使用到依赖
```
<dependencies>
    <dependency>
        <groupId>dom4j</groupId>
        <artifactId>dom4j</artifactId>
        <version>1.6.1</version>
    </dependency>
    <dependency>
        <groupId>net.sourceforge.javacsv</groupId>
        <artifactId>javacsv</artifactId>
        <version>2.0</version>
    </dependency>
```

## 代码

**源代码地址**：http://git.oschina.net/mijack/language-tool