jntajis 0.2.1

A Rust port of jntajis-python providing character transliteration functionality for Japanese text processing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# jntajis-rs

A Rust port of [jntajis-python](https://github.com/opencollector/jntajis-python), providing character transliteration functionality for Japanese text processing.

## What's jntajis-rs?

jntajis-rs is a transliteration library specifically designed for dealing with three different character sets: JIS X 0208, JIS X 0213, and Unicode. This is a native Rust implementation that provides the same functionality as the original Python library.

```rust
use jntajis::codec::mj_shrink::{MJShrinkSchemes, mj_shrink_candidates};

fn main() {
    // Get shrink candidates for a character variant
    let candidates: Vec<String> = mj_shrink_candidates("髙島屋", MJShrinkSchemes::ALL)
        .take(5)
        .collect();
    println!("{:?}", candidates); // outputs variations including "高島屋"
}
```

## Features

This library provides access to three different character tables:

- **MJ character table** (*MJ文字一覧表*) - A vast set of kanji characters used in Japanese text processing, developed by the Information-technology Promotion Agency
- **MJ shrink conversion map** (*MJ縮退マップ*) - For transliterating complex, less-frequently-used character variants to commonly-used ones
- **NTA shrink conversion map** (*国税庁JIS縮退マップ*) - Developed by Japan National Tax Agency to canonicalize user inputs

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
jntajis = "0.2.0"
```

### Basic Example

```rust
use jntajis::codec::mj_shrink::{MJShrinkScheme, MJShrinkSchemes, mj_shrink_candidates};

// Get all possible shrink candidates
let candidates: Vec<String> = mj_shrink_candidates("髙", MJShrinkSchemes::ALL)
    .take(10)
    .collect();

// Use specific shrink scheme
let jis_only = MJShrinkSchemes::builder()
    .with(MJShrinkScheme::JISIncorporationUCSUnificationRule);
let candidates: Vec<String> = mj_shrink_candidates("髙", jis_only)
    .take(5)
    .collect();

// Handle multiple characters
let candidates: Vec<String> = mj_shrink_candidates("髙橋", MJShrinkSchemes::ALL)
    .take(10)
    .collect();
```

### Advanced Usage

The library supports various MJ shrink schemes:

- `JISIncorporationUCSUnificationRule` - JIS incorporation and UCS unification rules
- `MOJNotice582` - MOJ Notice 582 transliteration rules
- `MOJFamilyRegisterActRelatedNotice` - Family register act related notice rules
- `InferenceByReadingAndGlyph` - Inference by reading and glyph rules

You can combine multiple schemes:

```rust
let combined = MJShrinkSchemes::builder()
    .with(MJShrinkScheme::JISIncorporationUCSUnificationRule)
    .with(MJShrinkScheme::MOJNotice582);
```

See `examples/mj_shrink_example.rs` for more detailed usage examples.

## Examples

Run the included example:

```bash
cargo run --example mj_shrink_example
```

## Building

```bash
# Standard build
cargo build

# Run tests
cargo test
```

## Character Mapping Relationships

The relationship between Unicode, MJ character mappings, JIS X 0213, and JIS X 0208 follows the same structure as the original Python implementation:

- **JNTA transliteration**: Direct conversion using the JNTA character mappings table
- **MJ transliteration**: Two-phase process involving Unicode to MJ character mappings, then MJ shrink mappings

## License

The source code is published under the BSD 3-clause license.

The embedded character mapping data comes from:

* **JIS shrink conversion mappings** (国税庁: JIS縮退マップ)
  - Publisher: National Tax Agency
  - Source: https://www.houjin-bangou.nta.go.jp/download/
  - License: CC BY 4.0

* **MJ character table** (文字情報技術促進協議会: MJ文字一覧表)
  - Publisher: Character Information Technology Promotion Council (CITPC)
  - Author: Information-technology Promotion Agency (IPA)
  - Source: https://moji.or.jp/mojikiban/mjlist/
  - License: CC BY-SA 2.1 JP

* **MJ shrink conversion mappings** (文字情報技術促進協議会: MJ縮退マップ)
  - Publisher: Character Information Technology Promotion Council (CITPC)
  - Author: Information-technology Promotion Agency (IPA)
  - Source: https://moji.or.jp/mojikiban/map/
  - License: CC BY-SA 2.1 JP

## Related Projects

- [jntajis-python](https://github.com/opencollector/jntajis-python) - The original Python implementation